4.54 sddsmultihist

• description: sddsmultihist does one-dimensional histograms of multiple columns of data from an SDDS file. All columns are histogrammed on the same interval and with the same number of bins. It is similar to sddshist, except that the latter program only histograms a single column at a time. Unlike sddshist, sddsmultihist does not presently do statistical analyses or filtering.
• examples: Make 20-bin histogram of a group of PAR x beam-position-monitor readouts:

  sddshist par.bpm par.bpmhis -column=P?P?x -bins=20 -abscissa=xReadout

• synopsis:

  sddsmultihist [-pipe=[input][,output]] [inputFile] [outputFile] -columns=columnName[,columnName...] -abscissa=newName [-separate] [-exclude=columnName[,columnName...]] [-bins=integer | -sizeOfBins=value | -autobins=target=number[,minimum=integer][,maximum=integer]] [-lowerLimit=value] [-upperLimit=value] [-sides]

• files: inputFile is the name of an SDDS file containing data to be histogrammed. If inputFile contains multiple data pages, each is treated separately. The histograms are placed in outputFile, which has one column of histogram frequencies for each histogrammed input column, plus a column giving the abscissa values for the frequency distributions. The former columns have names of the form columnNameFrequency, containing the number of points in each bin. The latter column has a name given by the user.
• switches:
  • -pipe[=input][,output] — The standard SDDS Toolkit pipe option.
  • -columns=columnName[,columnName...] — Specifies the names of the data columns to be histogrammed. The columnName items may contain wildcards.
  • -separate — Specifies that a separate abscissa shall be created for each histogrammed column. If -abscissa is not given, then the abscissa names are the names of the columns being histogrammed.
  • -abscissa=newName[,newName...] — Specifies the name or names of the abscissa columns for the histogram output. If -separate is not given, then only one name is permitted. The units taken from the units of the columns being histogrammed.
  • -exclude=columnName[,columnName...] — Specifies the names of data columns to exclude from histogramming. The columnName items may contain wildcards.
  • -bins=number — Specifies the number of bins to use. The default is 20.
  • -sizeOfBins=value — Specifies the size of bins to use. The number of bins is computed from the range of the data.
  • -autoBins=target=number[,minimum=integer][,maximum=integer] — Specifies that the number of bins should be chosen to attempt to give a target number of samples per bin on average. If minimum is given, then no fewer than the specified number of bins will be used (default: 5). If maximum is given, then no more than the specified number of bins will be used (default: number of samples).
  • -lowerLimit=value — Specifies the lower limit of the histogram. By default, the lower limit is the minimum value in the data.
  • -upperLimit=value — Specifies the upper limit of the histogram. By default, the upper limit is the maximum value in the data.
  • -sides — Specifies that zero-height bins should be attached to the lower and upper ends of the histogram. Many prefer the way this looks on a graph.
• see also:
  • Data for Examples
  • sddshist
  • sddshist2d
• author: M. Borland, ANL/APS.