BALL  1.4.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members
BALL::PeakList< PT > Class Template Reference

#include <BALL/NMR/peakList.h>

Inherits std::list< T >.

Public Types

Typedefs
typedef PT::Position Position
 The peak position type.
typedef PT PeakType
 The peak type.
typedef std::list< PT >::iterator Iterator
typedef std::list< PT >
::const_iterator 
ConstIterator

Public Member Functions

Constructors and Destructors
 PeakList ()
 PeakList (const PeakList &peak_list)
virtual ~PeakList ()
Accessors
void scale (float x)
float getMaxIntensity () const
float getMinIntensity () const

Additional Inherited Members

- Public Attributes inherited from std::list< T >
elements
 STL member.

Detailed Description

template<typename PT>
class BALL::PeakList< PT >

A generic peak list for spectra of arbitrary dimension.

Definition at line 26 of file peakList.h.

Member Typedef Documentation

template<typename PT>
typedef std::list<PT>::const_iterator BALL::PeakList< PT >::ConstIterator

Definition at line 47 of file peakList.h.

template<typename PT>
typedef std::list<PT>::iterator BALL::PeakList< PT >::Iterator

Definition at line 44 of file peakList.h.

template<typename PT>
typedef PT BALL::PeakList< PT >::PeakType

The peak type.

Definition at line 41 of file peakList.h.

template<typename PT>
typedef PT::Position BALL::PeakList< PT >::Position

The peak position type.

Definition at line 38 of file peakList.h.

Constructor & Destructor Documentation

template<typename PT>
BALL::PeakList< PT >::PeakList ( )
inline

Default Constructor

Definition at line 56 of file peakList.h.

template<typename PT>
BALL::PeakList< PT >::PeakList ( const PeakList< PT > &  peak_list)
inline

Copy constructor

Definition at line 62 of file peakList.h.

template<typename PT>
virtual BALL::PeakList< PT >::~PeakList ( )
inlinevirtual

Destructor

Definition at line 69 of file peakList.h.

Member Function Documentation

template<typename PT>
float BALL::PeakList< PT >::getMaxIntensity ( ) const
inline

Determine the maximum intensity of all peaks.

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

Definition at line 93 of file peakList.h.

template<typename PT>
float BALL::PeakList< PT >::getMinIntensity ( ) const
inline

Determine the minimum intensity of all peaks.

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

Definition at line 108 of file peakList.h.

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

Scale all peak intensities with a factor.

Definition at line 81 of file peakList.h.