Previous: sddsconvert
Up: Manual Pages
Next: sddsquery
Previous Page: sddsconvert
Next Page: sddsquery

sddsprocess

• name:
  sddsprocess
• description:
  sddsprocess operates on the data columns and parameters of an existing SDDS data set and creates a new data set. The program supports flexible filtering and matching operations on both tabular data and parameter data, definition of new parameters and columns in terms of existing ones, units conversions, scanning of string data to produce numeric data, composition of string data from other data types, and other operations.

  The options recognized by sddsprocess are in large part the same as those recognized by sdds2mpl. The later program allows creation of mpl data files from a SDDS data set.

• synopsis:
  sddsprocess <SDDSinputfile> [<SDDSoutputfile>] options
• options:
  • Data selection: [-filter={column | parameter}, range-spec[, range-spec[, logic-operation...]]] [-match={column | parameter}, match-test[, match-test[, logic-operation...]]] [-test={column | parameter}, test[,autostop]]
    • filter - A range-spec is of the form name= lower-value, upper-value[,!] , where ! signifies logical negation. A table passes a given filter by having the named parameter inside (or outside, if negation is given) the specified range, where the endpoints are considered inside. A tabular data row passes a given filter in the analogous fashion, except that the value from the named column is used. One or more range specifications may be combined to give a accept/reject status by employing the logic-operations, & (logical and) and amp;|amp; (logical or).
    • match - A match-test is of the form name= matching-string[,!], where the matching string may include the wildcards * (matches zero of more characters) and ? (matches any one character). In other respects, match is just like filter.
    • test - This option allows creation of a customized test for acceptance/rejection of tables or rows based on a rpn expression. The expression, test, may use the names of any parameters or columns. If autostop is specified, the processing of the data set (or data table) terminates when the parameter-based (or column-based) expression is false.
  • rpn calculator initialization: [-rpn_definitions_files= filename...] [-rpn_expression= expression]
    • rpn_definitions - Specifies a list of filenames to be read in as rpn definitions files.
    • rpn_expression - Specifies a rpn expression to be executed before processing begins. This option may be given any number of times.
  • Scanning from and printing to string columns and parameters: [-scan={column | parameter}, new-name, source-name, sscanf-string[, definition-entries] [-print={column | parameter}, new-name, sprintf-string, source-name[, source-name...][, definition-entries]
    • scan - Requests creation of a new numeric column (parameter) by scanning an existing string column (parameter) using a sscanf format string. The default type of the new data is double; this may be changed by including a definition-entry of the form type= type-name. With the exception of the name field, any valid namelist command field and value may be given as part of the definition-entries.
    • print - Requests creation of a new string column (parameter) by printing the values in existing columns (parameters) using a sprintf format string. With the exception of the name field, any valid namelist command field and value may be given as part of the definition-entries. In order to remove any ambiguity, no source-name should have an equals sign in it, as this would appear to be a definition-entry.
  • Creation and modification of numeric columns and parameters: [-convert_units={column | parameter}, name, old-units, new-units, factor] [-definition={column | parameter}, name, equation[, definition-entries]] [-process={preselection | postselection}, column-name, processing-mode[, new-parameter-name]]
    • convert_units - Requests units conversion for the column or parameter name. The factor entry the factor by which the values must be multiplied to convert them to the desired units. It is an error if old-units does not match the original units of the column or parameter. Eventually, the factor entry will be made optional by inclusion of conversion tables in the program. This option may be given any number of times.
    • definition - Requests creation of a new column or parameter using a rpn expression to obtain the values. By default, the type of the new data is double. This and other properties of the new column or parameter may be alter by giving definition-entries, which have the form field-name= value; field-name is the name of any namelist command field (except the name field) for a column or parameter, as appropriate. This option may be given any number of times.
    • process - Requests creation of a new parameter by processing a named column. The column must contain numeric data. The preselection and postselection keywords specify, respectively, that processing should occur before or after execution of filter, match, and test operations. Recognized processing modes are: average, rms, sum, standard_deviation, mean_absolute_deviation, minimum, maximum, smallest, largest, first, last, count, and spread. This option may be given any number of times.
• order of operations:
  1. Read next data table.
  2. Apply units conversions.
  3. Do preselection processing, with precomputation of required defined columns.
  4. Do parameter-based filtering, matching, and rpn expression testing.
  5. Compute defined parameters and columns.
  6. Do column and parameter scan and print operations.
  7. Do column-based filtering, matching, and rpn expression testing of rows.
  8. Do post-selection processing.
  9. Write data table.
  10. If data remains in input file, return to 1.
• see also:
  • sdds2mpl