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

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::Peak -- a full-featured decoder for a single (M/z, abundance) pair, an element of the PeakList structure

SYNOPSIS ^

  use Finnigan;
  my $peak = Finnigan::Peak->decode(\*INPUT);
  say $peak->mz;
  say $peak->abundance;
  say "$peak";

DESCRIPTION ^

This decoder is useless in normal life. It is a full-featured decoder for the pair of floating-point numbers representing the centroid _M/z_ and intensity of a peak. The data it generates contain the seek addresses, sizes and types of both attributes. These features may be useful in the exploration of the file format and in writing new code, but not in production work.

In performance-sensitive applications, the more lightweight Finnigan::Scan module should be used, which includes Finnigan::Scan::CentroidList and other related submodules. It does not store the seek addresses and object types, greatly reducing the overhead.

There is no equivalent object in Finnigan::Scan::CentroidList; it simply uses a pair of scalars for the data, since the location data and decoding templates are jettisoned, eliminating the need for an object.

METHODS

decode($stream)

The constructor method

mz

Get the M/z value, the first in the pair

abundance

Get the abundance value, the second in the pair

stringify

Get both attributes concatenated with a tab character. Used in the list method of the containing object, Finnigan::Peaks

SEE ALSO ^

Finnigan::Peaks

uf-scan

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: