sddssequence

• description: sddssequence generates an SDDS file with a single page and several columns of data of arithmetic sequences. An example application is generating values for an independent variable, whose values can be used by sddsprocess to produce a mathematical function.
• examples: Make a file example.sdds with column Index of type long with 100 rows. The value of Index in the first row is 1 and is incremented by 1 for each successive row.
  sddssequence example.sdds -define=Index -sequence=begin=1,number=100,delta=1
• synopsis:
  sddssequence [-pipe=[output]] [<outputfile>] -define=<columnName>[,<definitionEntries>] [-repeat=<number>] -sequence=begin=<value>[,number=<integer>][,end=<value>] [,delta=<value>][,interval=<integer>] [-sequence=[begin=<value>][,number=<integer>][,end=<value>] [,delta=<value>][,interval=<integer> ...]

• files: outputfile is the name of the SDDS file containing data generated.

• switches:
  • -pipe=[output] -- The standard SDDS Toolkit pipe option.
  • -define=<columnName>[,<definitionEntries>] -- Defines a new column. One or more -sequence options should follow. Definition entries have the form fieldName=value where fieldName is the name of any namelist command field (except the name field) for a column. The default data type is double. To get a different type, use type=<typeName>.

    Multiple -define options can be used to create mutliple columns, each with their own set of -sequence options.

  • -sequence=begin=<value>[,number=<integer>][,end=<value>] [,delta=<value>][,interval=<integer>] -- Defines the arithmetic sequence for the data column. More that one sequence option can be given for a column definition, thus allowing arithmetic sequences of different character in one column. The begin value must be given in the first sequence option. If any sequence options follows immediately, a default value equal to the previous end value plus the previous delta value is used. For the rest of the suboptions, the user must supply (end, delta), (end, number), or (delta, number). If number isn't supplied, then the set of start, end, delta must imply a positive number of rows.

    The interval field specifies the number of rows for which the value is frozen within the sequence. For instance,

    sddssequence example.sdds -def=Index,type=long -sequ=beg=1,num=10,end=10,inte=2
    sddsprintout -col=Index example.sdds
    

    produces

    Printout for SDDS file example.sdds
     
      Index    
    ------------
              1 
              1 
              3 
              3 
              5 
              5 
              7 
              7 
              9 
              9
    

  • -repeat=<number> -- Repeats the sequence identically for the given number of times.
• see also:
• author: M. Borland, ANL/APS.