BALL::SimpleExperiment1D Class Reference
[NMR spectra and related classes]

#include <BALL/NMR/experiment.h>

Inheritance diagram for BALL::SimpleExperiment1D:
BALL::Experiment< PeakList1D > BALL::ShiftModule BALL::UnaryProcessor< Composite > BALL::UnaryFunctor< Composite, Processor::Result >

List of all members.


Public Member Functions

Constructors and destructors
 SimpleExperiment1D ()
 

Default constructor.


 SimpleExperiment1D (const SimpleExperiment1D &experiment)
 

Copy constructor.


virtual ~SimpleExperiment1D ()
 

Destructor.


Processor related methods
virtual bool start ()
virtual Processor::Result operator() (Composite &composite)
Accessors
void setExpression (const String &expression)
const ExpressiongetExpression () const

Protected Attributes

Expression expression_

Detailed Description

Simple 1D NMR experiment class. This experiment extracts all atoms with an assigned shift value, which match a given kernel expression. The default expression is "true()", so by default all atoms with an assigned shift value are added to the peak list. The default peak intensity and width are user-defined ( setDefaultPeak ).


Constructor & Destructor Documentation

BALL::SimpleExperiment1D::SimpleExperiment1D (  ) 

Default constructor.

BALL::SimpleExperiment1D::SimpleExperiment1D ( const SimpleExperiment1D experiment  ) 

Copy constructor.

virtual BALL::SimpleExperiment1D::~SimpleExperiment1D (  )  [virtual]

Destructor.


Member Function Documentation

const Expression& BALL::SimpleExperiment1D::getExpression (  )  const
virtual Processor::Result BALL::SimpleExperiment1D::operator() ( Composite composite  )  [virtual]

Processor application operator. This operator creates a new peak in the peak list for every atom it encounters that possesses shift data and matches the expression set with setExpression . The default is an empty expression, which matches all atoms. Each peak in the peak list is assigned the intensity and width defined using setDefaultPeak (defaults to zero).

Reimplemented from BALL::UnaryProcessor< Composite >.

void BALL::SimpleExperiment1D::setExpression ( const String expression  ) 
virtual bool BALL::SimpleExperiment1D::start (  )  [virtual]

Initialize the experiment. This method simply clears the internal peak list.

Returns:
always true

Reimplemented from BALL::ShiftModule.


Member Data Documentation