Gene Selkov, Jr. > Finnigan > Finnigan::RunHeader

Download:
Finnigan-0.0206d.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.0206   Source  

NAME ^

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

SYNOPSIS ^

  use Finnigan;
  my $rh = Finnigan::RunHeader->decode(\*INPUT, $version);
  my $first_scan_number = $rh->first_scan;
  my $last_scan_number = $rh->last_scan;
  my $max_ion_current = $rh->sample_info->max_ion_current;
  my $data_addr = $rh->data_addr;

DESCRIPTION ^

Decodes RunHeader, the static (fixed-size) structure containing data stream lengths and addresses, as well as some unidentified data. Every data stream in the file has its address stored in RunHeader or in its historical antecedent SampleInfo, which it now includes.

Note: Starting with v.64, the stream addresses are stored as 64-bit integers and because SampleInfo has no space to accommodate the wider pointers, they have been moved to RunHeader proper.

METHODS

decode($stream, $version)

The constructor method

sample_info

Get the Finnigan::SampleInfo object

self_addr

Get own address

trailer_addr

Get the "trailer" address -- the pointer to the stream of ScanEvent structures

params_addr

Get the pointer to the stream of ScanPrarameters? structures

scan_index_addr

Get the address of the ScanIndex stream

data_addr

Get the address of the ScanDataPacket stream

inst_log_addr

Get the address of the instrument log records (of GenericRecord type)

error_log_addr

Get the address of the Error stream

ntrailer

Get the length of the ScanEvent stream

nparams

Get the length of the ScanParameters stream

nsegs

Get the number of scan segments

u1

Get the unknown double 1

u2

Get the unknown double 2

SEE ALSO ^

Finnigan::SampleInfo

uf-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.

syntax highlighting: