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

sddscontour

• name:
  sddscontour
• description:
  sddscontour makes contour and color-map plots from a SDDS data set column, or from a rpn expression in terms of the values in the columns of a data set. It supports FFT interpolation and filtering. If the data set contains more than one data table, data from successive tables is plotted on separate pages.

  The file must contain tabular data with at least one numeric column, which will be organized into a 2d array with R rows and C columns. By default, the values are assumed to come in row-major order (i.e., the file should contain a series of R sequences each containing the C values of a single row). The parameters of the 2d grid over which the plot is to be made are communicated to the program in one of two ways:

  1. The fixed-value string parameters Variable1Name and Variable2Name contain the names of the x and y axis variables, which I'll represent as x and y respectively. The program expects to find six more parameters, with names xMinimum, xInterval, and xDimension, and similarly for y. These parameters must be numeric, and contain the minimum value, the interval between grid points, and the number of points, respectively, for the dimension in question.
  2. The numeric parameters NumberOfRows and NumberOfColumns contain the values of R and C, respectively.
• synopsis:
  sddscontour SDDSfilename options
• options:
  • Choice of what to plot: [-quantity= column-name | -equation= rpn-expression]
    • quantity - Specifies the name of the column to make a contour or color map of.
    • equation - Specifies a rpn expression to make a contour or color map of. The expression may refer to the values in the columns by the appropriate column name, and may also refer to the variable names.
  • rpn control: [-rpn_definitions_files= filename[, filename...]] [-rpn_expressions= setup-expression[, setup-expression...]]
    • rpn_definitions_files - Specifies the names of files containing rpn expressions to be executed before any other processing takes place.
    • rpn_expressions - Specifies rpn expressions to be executed before any other processing takes place, immediately after any definitions files.
  • Shade and contour control: [-shade= number[, min, max] | -contours= number[, min, max]] [-label_contours= interval[, offset]]
    • shade - Specifies that a color (or grey-scale) map should be produced, with the indicated number of shades mapped onto the range from min to max. If min and max are not given, they are taken to be equal to the minimum and maximum data values.
    • contours - Specifies that contour lines should be drawn, with the indicated number of lines for the range from min to max. If min and max are not given, they are taken to be equal to the minimum and maximum data values.
    • label_contours - Specifies that every interval contour line, starting with the offset line, should be labeled with the contour value.
  • Image processing: [-interpolate= nx, ny[,floor | ceiling | antiripple] [-filter= xcutoff, ycutoff]
    • interpolate - Specifies that the 2d map should be interpolated to have nx times more rows (or x grid points) and ny times more columns (or y grid points). Since FFTs are used to do the interpolation, the original number of grid points must be a power of 2, as must the factor. Giving a factor of 1 disables interpolation for the dimension in question. floor, ceiling, and antiripple specify image processing of the interpolated map. floor and ceiling respectively force values below (above) the minimum (maximum) value of the data to be set equal to that value. antiripple causes the map to be altered so that non-zero values in the new map between zero values on the original map are set to zero; this suppresses ripples that sometimes occur in regions where the data was originally all zero.
    • filter ---
  • Plot labeling: [-xlabel= string] [-ylabel= string] [-title= string] [-topline= string] [-toptitle] [-no_labels] [-no_scales] [-date_stamp]
    • ---
    • ---
    • ---
    • ---
    • ---
  • Miscellaneous plot control: [-scales=xl,xh,yl,yh] [-device= name[, device-arguments]] [-shapes=filename] [-swap_xy] [-equal_aspect[=-1,1]] [-no_border]
    • ---
    • ---
    • ---
    • ---
    • ---
  • Miscellaneous: [-output= filename] [-verbosity[=level]]
    • ---
    • ---