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

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::PacketHeader -- a decoder for PacketHeader, a substructure of ScanDataPaket

SYNOPSIS ^

  use Finnigan;
  my $ph = Finnigan::PacketHeader->decode(\*INPUT);
  say $ph->layout;
  say $ph->profile_size;

DESCRIPTION ^

Calling this decoder is a pre-requisite to reading any scan data. It reads the data packet layout indicator and the sizes of the data streams included in the packet.

METHODS

decode($stream)

The constructor method

layout

Get the layout indicator. Two values have been sighted so far: 0 and 128

profile_size

Get the profile size in 4-byte words

peak_list_size

Get the peak list size in 4-byte words

low_mz

Get the low end of the M/z range

high_mz

Get the high end of the M/z range

UNUSED METHODS

descriptor_list_size
size_of_triplet_stream
size_of_unknown_stream

SEE ALSO ^

Finnigan::Profile

Finnigan::Peaks

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: