Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

PeakList< PT > Class Template Reference
[NMR spectra and related classes]

A generic peak list for spectra of arbitrary dimension. More...

#include <peakList.h>

Inheritance diagram for PeakList< PT >:

List< PT > List of all members.

Public Types

Typedefs
typedef PT::Position Position
 The peak position type.
typedef PT PeakType
 The peak type.
typedef List< PT >::iterator Iterator
 Iterator type.
typedef List< PT >::ConstIterator ConstIterator
 Constant iterator type.

Public Member Functions

Constructors and Destructors
 PeakList ()
 Default Constructor.
 PeakList (const PeakList &peak_list)
 Copy constructor.
virtual ~PeakList () throw ()
 Destructor.
Accessors
void scale (float x)
 Scale all peak intensities with a factor.
float getMaxIntensity () const
 Determine the maximum intensity of all peaks.
float getMinIntensity () const
 Determine the minimum intensity of all peaks.

Detailed Description

template<typename PT>
class PeakList< PT >

A generic peak list for spectra of arbitrary dimension.


Member Typedef Documentation

template<typename PT>
typedef List<PT>::ConstIterator PeakList< PT >::ConstIterator
 

Constant iterator type.

Reimplemented from List< PT >.

template<typename PT>
typedef List<PT>::iterator PeakList< PT >::Iterator
 

Iterator type.

Reimplemented from List< PT >.


Member Function Documentation

template<typename PT>
float PeakList< PT >::getMaxIntensity  )  const
 

Determine the maximum intensity of all peaks.

Returns:
maximum intensity, Limits<float>::min() for an empty peak list

template<typename PT>
float PeakList< PT >::getMinIntensity  )  const
 

Determine the minimum intensity of all peaks.

Returns:
minimum intensity, Limits<float>::max() for an empty peak list

template<typename PT>
void PeakList< PT >::scale float  x  ) 
 

Scale all peak intensities with a factor.