NAME

MS::Reader::MzML::Chromatogram - An MzML chromatogram object

SYNOPSIS

            

              
              
use MS::Reader::MzML;
my $run = MS::Reader::MzML->new('run.mzML');
my $tic = $run->get_tic; # an MS::Reader::MzML::Chromatogram object
     
my $id  = $tic->id;
my $rt  = $tic->rt;
my $int = $tic->int;
# print the underlying data structure
$tic->dump;
}
            
          

DESCRIPTION

MS::Reader::MzML::Chromatogram objects represent chromatograms parsed or calculated from an mzML file. The constructor is not intended to be used directly but rather by via methods of MS::Reader::MzML.

METHODS

id

            

              
              
my $id = $chrom->id;
            
          

Returns the native ID of the chromatogram, or undefined if not available

rt

            

              
              
my $rt = $chrom->rt;
for (@$rt) { # do something }
            
          

Returns an array reference to the retention time data array (in SECONDS)

int

            

              
              
my $int = $chrom->int;
for (@$int) { # do something }
            
          

Returns an array reference to the peak intensity data array

param, get_array

See MS::Reader::MzML::Record

CAVEATS AND BUGS

The API is in alpha stage and is not guaranteed to be stable.

Please reports bugs or feature requests through the issue tracker at https://github.com/jvolkening/p5-MS/issues.

SEE ALSO

• MS::Spectrum

• MS::Reader::MzML::Record

AUTHOR

Jeremy Volkening <jdv@base2bio.com>

COPYRIGHT AND LICENSE

Copyright 2015-2016 Jeremy Volkening

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.