4.46 sddseventhist

• description: sddseventhist analyzes labeled events in a dataset to provide histograms of the occurrences of each type of event. It can also histogram the overlap of all types of events with a single type of event.
• examples:
  sddseventhist events.sdds hist.sdds -dataColumn=Time -eventIdentifier=Event -bins=50  
  sddseventhist events.sdds hist.sdds -dataColumn=Time -eventIdentifier=Event -overlapEvent=Alarm  
      

• synopsis:
  sddseventhist [-pipe=[input][,output]] [inputFile] [outputFile]  
    -dataColumn=columnName -eventIdentifier=columnName [-overlapEvent=eventValue]  
    [-bins=number | -sizeOfBins=value]  
    [-lowerLimit=value] [-upperLimit=value]  
    [-sides] [-normalize={sum | area | peak}]  
      

• files: inputFile is a file containing at least two columns of data. One column must contain string entries that serve as “event identifiers”; for example, these might be the names of channels that issued an alarm. The other column must contain numerical data that will be histogrammed; for example, these might be the times at which alarms occurred. The outputFile contains one histogram of this numerical data for each unique value of the event identifier; the histogram contains only the data that matches that identifier.
• switches:
  • -pipe[=input][,output] — The standard SDDS Toolkit pipe option.
  • -dataColumn=columnName — Specifies the name of the data column to be histogrammed.
  • -eventIdentifier=columnName — Specifies the name of the string column that identifies events.
  • -overlapEvent=eventValue — Requests computation of the overlap of the histograms of each event with the histogram of event eventValue. Useful in determining which events always occur at the same time as event eventValue.
  • -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.
  • -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 event histogram. Many prefer the way this looks on a graph.
  • -normalize={sum | area | peak} — Specifies that the histogram should be normalized, and how. The default is sum. sum normalization means that the sum of the heights will be 1. area normalization means that the area under the histogram will be 1. peak normalization means that the maximum height will be 1.
• see also:
  • sddscorrelate()
  • sddshist()
  • sddshist2d()
• author: M. Borland, ANL/APS.