4.40 sddshist2d

• description:

  sddshist2d makes two-dimensional histograms of data, producing output that is suitable for plotting with sddscontour. The two-dimensional histogram may include data from two columns, or may show the histograms of a single column versus page number.

• examples: Make a two-dimensional histogram of two PAR bpm readouts, then plot the result:

  sddshist2d par.bpm par.bpm.h2d -column=P1P1x,P1P2x -xparam=50 -yparam=50 sddscontour -shade=32 par.bpm.h2d -quantity=frequency

• synopsis:

  sddshist2d [-pipe[=input][,output]] [inputfile] [outputfile] -columns={xName,yName | yName} [-weights=columnName[,average]] [-xParameters=bins[,lower,upper]] [-yParameters=bins[,lower,upper]] [-outputName=string] [-sameScale] [-combine] [-normalize[=sum]] [-smooth[=passes]] [-verbose]

• switches:
  • -pipe[=input][,output] — The standard SDDS Toolkit pipe option.
  • -columns={xName,yName | yName} — Specifies the data from the input to histogram. If both xName and yName are given, then sddshist2d does a two-dimensional histogram of the values in the named columns. If only yName is given, then sddshist2d does a series of one-dimensional histograms of the named column, one for each data pages; these histograms are then assembled as a two-dimensional histogram with one axis being the page number.
  • -weights=columnName[,average] — Specifies the name of a column of data with which to proportionally weight the count value of points in the histogram. If the average qualifier is given, then each bin value is normalized to contain the average value of the weight for all points in the bin.
  • -xParameters=bins[,lower,upper] — Specifies the number of bins and optionally the histogrammed region for the x values. Ignored if only yName is given. By default, 21 bins are used encompassing all of the data points.
  • -yParameters=bins[,lower,upper] — Specifies the number of bins and optionally the histogrammed region for the y values. By default, 21 bins are used encompassing all of the data points.
  • -outputName=string — Specifies the name of the histogram data. The default is frequency.
  • -sameScale — Specifies that for multipage input files, the histogram region should be the same for all pages. The region is set to encompass all data points from all pages.
  • -combine — Specifies that for multipage input files, the data from all pages should be placed in a single histogram.
  • -normalize[=sum] — Specifies normalization of the histogram. If the sum qualifier is not given, the histogram is normalized to unit amplitude; otherwise, it is normalized so that the sum of all frequencies is unity.
  • -smooth[=passes] — Specifies smoothing by nearest-neighbor-averaging. If passes is omitted, only one pass is performed.
  • -verbose — Requests informational output during processing.
• see also:
  • sddshist
  • sddscontour
  • sddscongen
• author: M. Borland, ANL/APS.