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

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::ScanParameters -- a decoder for ScanParameters, a GenericRecord containing various scan meta-data.

SYNOPSIS ^

  use Finnigan;
  my $p = Finnigan::ScanParameters->decode(\*INPUT, $generic_header_ref);
  say $p->charge_state;

DESCRIPTION ^

This decoder augments the GenericRecord decoder with the charge_state method. Copies of all other elements in this structure can be found in other streams, so there is no need in making accessors for them. The purpose of this stream is to provide pre-formatted human-readable messages describing the scan data; The charge_state element seems to be unique in that it either does not exist anywhere else, or has not been discovered so far.

The entire set can be printed in the following manner:

  foreach my $key (@{$header->labels}) {
    say $key  . "\t" . $p->{data}->{$key}->{value};
  }

METHODS

decode($stream, $header->field_templates)

The constructor method. It needs a previously decoded header to work.

charge_state

Get the charge state of the base ion

injection_time

Get ion injection time in milliseconds

monoisotopic_mz

Get the monoisotopic mass of precursor ion

scan_segment

Get the current ScanSegment number (1 .. )

scan_event

Get the cunnent ScanEvent number (1 .. )

SEE ALSO ^

Finnigan::GenericRecord

Finnigan::GenericDataHeader

uf-params

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: