Previous: murge
Up: References
Next: peakfind
Previous Page: murge
Next Page: peakfind

params

htmlonly

• name:
  params
• synopsis:

  params inputfile outputfile [-swap_xy] [-window= xmin,xmax,ymin,ymax] [-names=" x-name"," y-name"] [-units=" x-unit"," y-unit"] [-average[={arithmetic | rms}]] [-maximum[={location | value}]] [-minimum[={location | value}]] [-span[={x | y}]] [-peaks= number,width,interval[,location][,value][,fwhm][,{sharpest | highest}]] [-median[=weighted]] [-verbose]

• description:
  Computes many parameters of a series of data sets, including positions, heights and sharpnesses of peaks, positions and values of minima and maxima, averages, and medians.
• files:
  inputfile is not an mpl file. Rather, it contains a series of lines, each of which has an ``ID number'' followed by the name of a file containing a mpl data set. The ID number need not be an integer; typically it is a parameter that differentiates among the data sets.

  outputfile is a multi-column file in ``standard format'' (see the program column). It contains the requested parameters as a function of the ID number.

• options:

  swap_xy

  
  Requests that the columns of the files listed in inputfile be swapped prior to any other processing. By default, params operates on the ordinate values of the files.

  window

  
  Requests discarding of data outside the specified region, where the x values refer to the abscissae and the y values to the ordinates of the data sets. If the two values for x (or y) are both equal to 0, the data is not windowed by the coordinate in question.

  names, units

  
  Requests params to use the given names and units for composing text labels for outputfile. By default, the names and units are extracted from the first data set.

  average

  
  Requests computation of the arithmetic or rms average. More than one instance may be given.

  maximum, minimum

  
  Requests computation of the location and/or value at which the data set has a minimum or maximum.

  span

  
  Requests computation of the span of the data, defined as the difference between the minimum and maximum values.

  peaks

  
  Requests peakfinding, with optional output of the location, value, and/or fwhm of each peak. number is the number of peaks to find, starting with the highest or sharpest, as specified. width is the minimum width of a peak; any apparent peak within half this distance of a previously-found peak is ignored. interval is the interval in points for taking numerical derivatives of the data, which is needed for determining the sharpness of a peak.

  median

  
  Requests computation of the median, which is by default unweighted. If weighted is specified, the ordinates are weighted in proportion to the abscissae.

  verbose

  
  Requests output of additional information during processing.

• see also:

  
  stats, peakfind, column.