4.83 sddsprintout

• description: sddsprintout provides formatted text output of data from columns and parameters. It is similar to sdds2stream(), but provides better control of the appearance of the text. Note that using sddsprintout to create tables of ASCII data for other programs is not recommended. Better alternatives are sdds2stream(), sdds2spreadsheet(), and sdds2plaindata().
• examples:
  sddsprintout APS0.twi -column=ElementName -column=’beta?’ -parameters=’nu?’  
      

• synopsis:
  sddsprintout [-pipe[=input]] [SDDSinput] [outputFile]  
    -columns=nameList[,format=string][,label=string][,editLabel=command][,useDefaultFormat][,endsLine][,blankLines=number]  
    -parameters=nameList[,format=string][,label=string][,editLabel=command][,useDefaultFormat][,endsLine][,blankLines=number]  
    -spreadsheet[=delimiter=string][,quoteMark=string][,noLabels][,schFile=filename]  
    -fromPage=number -toPage=number  
    -formatDefaults=SDDStype=formatString[,SDDStype=formatString...]  
    -width=integer -pageAdvance -paginate[=lines=number][,noTitle][,noLabels]  
    -postPageLines=number -title=string -noTitle -noWarnings  
      

• files: SDDSinput is the SDDS file from which data is printed. outputFile is a file to which the printout will go; by default, the printout goes to the standard output.
• switches:
  • -pipe[=input] — The standard SDDS Toolkit pipe option.
  • -columns=nameList[,format=string][,label=string][,editLabel=command][,useDefaultFormat][,endsLine][,blankLines=number] — Specifies the names of columns to appear in the printout. nameList may contain one or more comma-separated strings, each of which may contain wildcards. If more than one string is given, the list must be enclosed in parentheses, e.g., -columns=’(betax,betay)’. The format qualifier may be used to specify a printf-style format string for the named columns; in this case, all of the columns must have the same data type. The format string should contain a width field, to ensure proper alignment of text, e.g., %30s rather than %s. The useDefaultFormat qualifier directs that sddsprintout use its own default format for the data type in question, as opposed to any format that might be specified in the SDDS header. The label qualifier can be used to specify the column label in the printout (by default, the column name is used); the label may be edited using the editLabel qualifier and a standard editing sequence. If the endsLine qualifier is given, a line break is issued after the last column of the list is printed. The blankLines qualifier may be used to specify that one or more blank lines be emitted following such a line break. Any number of -columns options may be given.
  • -parameters... — Identical to -columns, except that printout of parameters is specified.
  • -spreadsheet[=delimiter=string][,quoteMark=string][,noLabels][,schFile=filename] — Specifies spreadsheet compatible output, using the given delimiter between columns. In this mode, simplified header is printed and no line width limits are imposed. The default delimiter is a tab. The default quotation mark is ". If the schFile qualifier is given, a header file for comma-separated-values data is generated. In this case, the delimiter should be a comma.
  • -fromPage=number — Specifies the first data page of the file that will appear in the printout. By default, the printout starts with data page 1.
  • -toPage=number — Specifies the last page of the file that will appear in the printout. By default, the printout ends with the last data page in the file.
  • -formatDefaults=SDDStype=formatString[,SDDStype=formatString...] — Specifies default printf format strings for named SDDS data types. The SDDStype qualifier may be one of float, double, long, short, string, or character.
  • -width=integer — Specifies the width of the output line in number of characters. The default is 130.
  • -pageAdvance — Specifies that the page be advanced at the end of every data page of the SDDS file. This is done by emitting an ASCII page advance character, which will probably work only if the output is sent to a printer.
  • -paginate — Specifies pagination of the output, using a default 66 line page. The lines qualifier may be used to change the page length. By default, the title and column labels are printed for each page. These may be disabled using the noTitle and noLabels qualifiers.
  • -postPageLines — Specifies that a number of blank lines shall be emitted at the end of the printout for each page. By default, there are no blank lines between pages.
  • -title=string — Specifies the title for the printout.
  • -noTitle — Specifies that no title be printed.
  • -noWarnings — Suppresses warning messages, such as those concerning data elements requested in the printout that are not in the input file.
• see also:
  • Data for Examples
  • sdds2plaindata()
  • sdds2spreadsheet()
  • sdds2stream()
• author: M. Borland, ANL/APS.