NAME

Finnigan::SampleInfo -- a decoder for SampleInfo, the primary file index structure

SYNOPSIS

  use Finnigan;
  my $rh = Finnigan::RunHeader->decode(\*INPUT, $version);
  my $si = $rh->sample_info; # calls Finnigan::SampleInfo->decode
  say $si->first_scan;
  say $si->last_scan;
  say $si->tot_ion_current;
  my $scan_index_addr = $si->scan_index_addr;
  . . .

DESCRIPTION

SampleInfo is a static (fixed-size) binary preamble to RunHeader containing data stream lengths and addresses, as well as some unidentified data. All data streams in the file, except for the list of ScanHeader records and TrailerScanEvent stream have their addresses stored in SampleInfo.

The addresses of the ScanHeader and TrailerScanEvent streams are stored in the parent structure, RunHeader.

It appears as though RunHeader is a recently introduced wrapper around the older SampleInfo structure.

METHODS

decode($stream)

The constructor method

first_scan

Get the first scan number

last_scan

Get the last scan number

inst_log_length

Get the number of instrument log records

max_ion_current

Get the pointer to the stream of ScanPrarameters? structures

low_mz

Get the low end of the M/z range

high_mz

Get the high end of the M/z range

start_time

Get the start time (retention time in seconds)

end_time

Get the end time (retention time in seconds)

scan_index_addr

Deprecated. See RunHeader->scan_index_addr

data_addr

Deprecated. See RunHeader->data_addr

inst_log_addr

Deprecated. See RunHeader->inst_log_addr

error_log_addr

Deprecated. See RunHeader->error_log_addr

SEE ALSO

Finnigan::RunHeader

AUTHOR

Gene Selkov, <selkovjr@gmail.com>

COPYRIGHT AND LICENSE

Copyright (C) 2010 by Gene Selkov

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.