InSilicoSpectro::Spectra::PeakDescriptor - Description of peak properties


InSilicoSpectro documentation  | view source Contained in the InSilicoSpectro distribution.

Index


NAME

Top

InSilicoSpectro::Spectra::PeakDescriptor - Description of peak properties

SYNOPSIS

Top

use InSilicoSpectro::Spectra::PeakDescriptor;

DESCRIPTION

Top

List peak properties in order. By peak properties we mean physical properties read from fields in the peak list such as mass, intensity, FWHM, etc.

METHODS

Top

my new([$itemOrder])

Constructor. It is possible to give a list of properties in a vector, a reference to which is passed as parameter $itemOrder. The positions in the vector define the order.

setFields(\@v | $line_starting_#)

Initializes with an array of names, or a text line (heading '#\s*' and trailing '#.*' are removed).

getFields([$i])

Return the i^th field. If $i is not present, return the array of fields

getFieldIndex(name)

Return the index of the field corresponding the $name

pushField($n)

Adds field $n at the end of the list of fields already in the PeakDescriptor.

$equalsTo($pd2)

Compares two PeakDescriptor objects and returns true if all the fields are the same and in the same order.

toString

Returns a string with order:field_name pairs separated by comas.

Overloaded "" operator

Returns the result of toString.

AUTHORS

Top

Alexandre Masselot, www.genebio.com


InSilicoSpectro documentation  | view source Contained in the InSilicoSpectro distribution.