/ 
Finnigan-0.02
River stage zero No dependents
/ uf-params

NAME

uf-params - list or dump the ScanParameters records in a Finnigan raw file

SYNOPSIS

uf-params [options] file

Options:

 -header              extract the log header (record structure)
 -d[ump]              dump the requested feature showing file seek addresses
 -a[ll]               detailed dump of all field descriptors [requires: -d]
 -s[ize]              print record size [requires: -d]
 -n[unmber] <n:0+n>   extract the log entry number <n>
 -h[tml]              format as html
 -w[iki]              format as a wiki table
 -r[elative]          show relative addersess in the dump [requires: -d]
 <file>               input file [required]

OPTIONS

-help

Print a brief help message and exit.

-d[ump]

Prints a table listing all fields in the requested object (a log entry or the file header), with their seek addresses, sizes, names and values. Individual entries can be selected with the -n[umber] option.

-n[umber]

Gives the number of a single InstrumentLogRecord to extract

-h[tml]

Format the dump output as an html table. When multiple entries are specified, each will be rendered in its own table

-w[iki]

Format the dump output as a wiki table.

-s[ize]

Show structure size in bytes (works with the -d[ump] option).

-r[elative]

Show relative addresses of all itmes in the dump. The default is to show the absolute seek address. (works with the -d[ump] option)

-a[ll]

Dump all GenericDataDescriptor entries in the file header (requires -header)

DESCRIPTION

uf-params can be used to examine the ScanParameters? records in a Finnigan raw file. These records contain a miscellany of data pertaining to a single scan: ion injection time, retention time, charge state and M/z of the precursor ion, M/z conversion coefficients, and other data.

SEE ALSO

Finnigan::ScanParameters

EXAMPLES

uf-params sample.raw

(lists all ScanParameters? records in the tabular form: <record number, label, value>)

uf-params -n 5 sample.raw

(prints the parameters record for the fifth scan)

uf-params -dswr -n 5 sample.raw

(dumps the fifth ScanParameters? record in wiki format with total size and relative addresses)

uf-params -header sample.raw

(prints the contents of the stream header in the tabular form: <type, length, label>)

uf-params -header -dw sample.raw

(dumps the header in the compact wiki format, with a stringified GenericDataDescriptor list)

uf-params -header -daw sample.raw

(dumps the header in the extended wiki format, showing the location of echa GenericDataDescriptor's element)