IXFregroup xy dataset 2d

From LIBISIS
Jump to navigation Jump to search

This function will regroup an IXTdataset_2d object along the x and y dimension according to the supplied Xparams(xlo,dx,xhi) and Yparams(ylo,dy,yhi) argument to give an IXTdataset_2d object result. It regroups data with new bin boundaries to ensure that bins have minimum width determined by the parameter dx and dy with limits xlo,xhi and ylo,yhi respectively, but ensuring the bin boundaries are coincident with original bin boundaries along both dimensions.


x dimension

  • dx > 0 constant bin width = dx
  • dx < 0 logarithmic binning x(m+1) = x(m) *(1+|dx|)
  • dx = 0 retain original bin boundaries


y dimension

  • dy > 0 constant bin width = dy
  • dy < 0 logarithmic binning y(m+1) = y(m) *(1+|dy|)
  • dy = 0 retain original bin boundaries


The difference between IXFrebin_xy_dataset_2d and IXFregroup_xy_dataset_2d is that in the former the data in the original bins may be divided by the new bin boundaries. In the latter case, new bins are created only by combining whole bins.

Regrouping is ONLY permitted on histogram data, therefore if one dimension has point data then then the operation will fail.


F90 syntax

use IXMdataset_2d

type(IXTdataset_2d):: dataset_2d,result_d2d
type(IXTstatus)::status
real(dp)::Xparams(3),Yparams(3)

call IXFregroup_xy_dataset_2d(result_d2d,dataset_2d,Xparams,Yparams,status)