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

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::RawFileInfoPreamble -- a decoder for RawFileInfoPreamble, the binary data part of RawFileInfo

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->preamble->dump;

DESCRIPTION ^

This this object decodes the binary preamble to RawFileInfo, which contains an unpacked representation of a UTC date (apparently, the file creation date), a set of unknown numbers, and most importantly, the more modern versions of this structure contain the pointers to the ScanDataPacket stream and to RunHeader, which stores the pointers to all other data streams in the file.

The older versions of this structure did not contain anything except the date stamp.

METHODS

decode($stream, $version)

The constructor method

timestamp

Get the timestamp in text form: Wkd Mmm DD YYYY hh:mm:ss.ms

xmlTimestamp

Get the timestamp in text form, in the format adopted in mzML: YYYY-MM-DDThh:mm:ssZ

data_addr

Get the pointer to the first ScanDataPacket

run_header_addr

Get the pointer to RunHeader (which contains further pointers)

stringify

Make a concise string representation of the structure

SEE ALSO ^

Finnigan::RawFileInfo

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: