Write

Writes a queue element to an external file:

Format:

SPECTRA> wr$*$ite/fio id [file_name[.fio]]
SPECTRA> wr$*$ite/fio /vector_id1/vector_id2... [file_name[.dat]]

Description:

The syntax for creating a FIO file is very much the same as for ASCII files. The FIO structure can be found in section 15.3.57.

SPECTRA writes the values of the symbols FIO_COMMENT_i (i=1, 10) to the comment section of the output file.

Before SPECTRA writes the FIO parameters to the output file, it evaluates them. This evaluation is also used in symbol assignments or by the string() function.

/exa$*$fs

Writes the regions parameter as comment into the output file. This option is used with EXAFS scans.

/hexapod

Writes the Hexapod output parameters to the output file. This option is used at beam line L.

/dform$*$at=string

The output format for the columns, C syntax. This format is only used for the columns that contain double precision numbers.

/fio_comments

The Perl function Spectra::fio_comments() is called and the return value is written to the output file. The function returns a string with may consist of several lines the are delimited by \n. There can be an unlimited number of lines that begin with an exclamation mark "!”. They are written to the output file and are ignored, if this output file is later read into Spectra. Lines that do not begin with an exclamation mark are considered as official comment lines. Mind that there can be only a total 10 lines. The function Spectra::fio_comments() is usually defined in \online_dir\TkIrc.pl.

If the symbol flag_addition_fio_comments is set to 1, the function Spectra::fio_comments() is also invoked.

/xform$*$at=string

The output format for the columns, C syntax. This format is only used for the columns that contain floating point numbers.

/iform$*$at=string

The output format for the columns, C syntax. This format is only used for the columns that contain integer numbers.

/mot$*$or

Writes the current motor positions into the parameter section of the output file.

/noconfirm

The user is not asked for confirmation, if the write command creates an output file that is a higher version of an existing file.

/prefix=string

All SCAN GQEs that begin with string are written.

/reg$*$ions

Writes the regions parameter as comment into the output file. This option is used with motor regions scans.

/ro

FIO feature: the file permissions are set to 0444 (read-only).

/scan

A set of SCAN GQEs is written to a file.

/ssa

Writes the SSA results to the output file.

SPECTRA translates the symbol scan_name to find a generic GQE name. All SCAN GQEs which have names that match scan_name$*$ are written to the output file. The first column of the file are the x-values of scan_name, the next column are the y-values of scan_name. The other columns are the y-values of the other SCAN GQEs. That means it is assumed that all SCAN GQEs have a common x-axis, like the energy.

Apart from normal FIO output, the column names are taken from the SCAN names. For normal FIO output it is the axis descriptions.

Note that there is also a /scan qualifier for the read/fio command.

e.g.:

SPECTRA> write/fio bpu1

SPECTRA> write/fio/x(bpu1)/y(bpu1)/y(temp) fname

Format:

SPECTRA> wr$*$ite/as$*$cii id [file_name[.dat]]
SPECTRA> wr$*$ite/as$*$cii/x(id1)/y(id1)... [file_name[.dat]]

Description:

Normal ASCII files have two column of data. The comment lines of id are put to the beginning of the file. The comment lines begin with a ”!". If no file_name is supplied, the file receives the name of the SCAN.

The second format creates a multicolumn file. The x- and y-values can be taken from different SCANs. The columns are written to the file in the same order as they appear in the qualifier list. There can be at most 20 columns of x- or y-values. If the SCANs have different lengths, SPECTRA fills the shorter columns with zeros. The comment lines are taken from id1, because it is the first SCAN in the list. The name of the output file is the name of id1, if file_name is omitted.

/form$*$at=string

The output format for the (float) columns, C syntax.

/iform$*$at=string

The output format for the (int) columns, C syntax.

/xform$*$at=string

The output format for the (float) columns, C syntax.

/mot$*$or

Writes the current motor positions as comments into the file.

/noconfirm

The user is not asked for confirmation, if the write command creates an output file that is a higher version of an existing file.

e.g.:

SPECTRA> write/asc/form=The columns are written with the format "

SPECTRA> write/asc/x(1)/y(2)/y(3) file_name Write three columns.

Format:

SPECTRA> wr$*$ite/gq$*$e id
SPECTRA> wr$*$ite/gq$*$e $*$.$*$ [fname[.gqe]]
SPECTRA> wr$*$ite/gq$*$e id1 id2 [fname[.gqe]]
SPECTRA> wr$*$ite/gq$*$e id1.$*$ [fname[.gqe]]

Description:

Id: Id is written to an unformatted file. If fname is not specified, the file name is taken from the GQE name. The GQE format writes all types of queue elements to a disk file.

*.*: The whole queue is written to fname. If fname is not supplied, SPECTRA uses the name of the first queue element.

Id1, id2: A range of queue elements is written to fname. If fname is not supplied, SPECTRA uses the name of the id1.

Id1.$*$: All queue elements of slot id1 are written to fname. If fname is not supplied, SPECTRA uses the name of the id1.0.

/fi$*$le_name=fname

/noconfirm

The user is not asked for confirmation, if the write command creates an output file that is a higher version of an existing file.

/selected

Only those GQEs that have been selected before, are written to disk.

Format:

SPECTRA> wr$*$ite[/hs$*$p] id [file_name[.hsp]]

Description:

HSP is the HASYLAB standard data format (VMS) . See the explanations in section 15.3.57 for more details.

/noconfirm

The user is not asked for confirmation, if the write command creates an output file that is a higher version of an existing file.

e.g.:

SPECTRA> write bpu1

Format:

SPECTRA> wr$*$ite/ppm id file_name[.ppm]

Description:

An ARRAY is written to a portable pixel map file.

/swap

Exchanges the RED and BLUE component, useful if the file has been copied from VMS to Unix or vice versa.