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

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::RawFileInfo -- a decoder for RawFileInfo, the primary index structure

SYNOPSIS ^

  use Finnigan;
  my $file_info = Finnigan::RawFileInfo->decode(\*INPUT);
  say $file_info->preamble->run_header_addr;
  say $file_info->preamble->data_addr;
  $file_info->dump;

DESCRIPTION ^

This variable-size structure consists of RawFileInfoPreamble followed by six text strings. The first five strings contain the headings for the user-defined labels stored in SeqRow. The sixth string is probably used to store the sample ID.

The older versions of RawFileInfoPreamble contained an unpacked rpresentation of the file creation date in the UTC time zone.

The modern versions of the preamble also contain the pointer to the ScanData stream and the pointer to RunHeader, which in turn stores pointers to all other data streams in the file.

There are other data elements in the modern preamble, whose meaning is unkonwn.

METHODS

decode

The constructor method

preamble

Get the Finnigan::RawFileInfoPreamble object

stringify

Make a concise string representation of the structure

SEE ALSO ^

Finnigan::RawFileInfoPreamble

Finnigan::SeqRow

Finnigan::Runheader

uf-rfi

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: