/usr/include/BALL/NMR/experiment.h is in libball1.4-dev 1.4.1+20111206-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | // -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: experiment.h,v 1.11 2005/12/23 17:01:56 amoll Exp $
//
#ifndef BALL_NMR_EXPERIMENT_H
#define BALL_NMR_EXPERIMENT_H
#ifndef BALL_NMR_PEAKLIST_H
# include <BALL/NMR/peakList.h>
#endif
#ifndef BALL_NMR_SHIFTMODULE_H
# include <BALL/NMR/shiftModule.h>
#endif
#ifndef BALL_KERNEL_EXPRESSION_H
# include <BALL/KERNEL/expression.h>
#endif
namespace BALL
{
/** Class describing a certain type of NMR experiment.
This class (and its subclasses) are used to describe
how a list of peaks is derived from the shifts calculated
for a system.
\par
\par
\ingroup Spectra
*/
template <typename PeakListType>
class BALL_EXPORT Experiment
: public ShiftModule
{
public:
BALL_CREATE(Experiment)
/** @name Typedefs
*/
//@{
/// The peak type
typedef typename PeakListType::PeakType PeakType;
//@}
/** @name Constructors and Destructors
*/
//@{
/** Default Constructor
*/
Experiment();
/** Copy constructor
*/
Experiment(const Experiment& experiment);
/** Destructor
*/
virtual ~Experiment()
;
//@}
/** @name Accessors
*/
//@{
/** Return the peak list
*/
const PeakListType& getPeakList() const;
/** Return the default peak.
This peak can be assigned a default width and intensity
that is assigned to all extracted peaks in the peak list.
This is the default behaviour and can be overridden in
derived classes.
*/
const PeakType& getDefaultPeak() const;
/** Assign the default peak.
@see getDefaultPeak
*/
void setDefaultPeak(const PeakType& peak);
//@}
protected:
PeakListType peak_list_;
PeakType default_peak_;
};
template <typename PeakListType>
Experiment<PeakListType>::Experiment()
: ShiftModule(),
peak_list_(),
default_peak_()
{
}
template <typename PeakListType>
Experiment<PeakListType>::Experiment(const Experiment<PeakListType>& experiment)
: ShiftModule(experiment),
peak_list_(experiment.peak_list_),
default_peak_(experiment.default_peak_)
{
}
template <typename PeakListType>
Experiment<PeakListType>::~Experiment()
{
}
template <typename PeakListType>
const PeakListType& Experiment<PeakListType>::getPeakList() const
{
return peak_list_;
}
template <typename PeakListType>
const typename Experiment<PeakListType>::PeakType& Experiment<PeakListType>::getDefaultPeak() const
{
return default_peak_;
}
template <typename PeakListType>
void Experiment<PeakListType>::setDefaultPeak(const typename Experiment<PeakListType>::PeakType& peak)
{
default_peak_ = peak;
}
/** @name Convenience typedefs
\ingroup Spectra
*/
//@{
/** 1D NMR experiment
*/
typedef Experiment<PeakList1D> Experiment1D;
/** 2D NMR experiment
*/
// ?????
//typedef Experiment<PeakList2D> Experiment2D;
/** 3D NMR experiment
*/
typedef Experiment<PeakList3D> Experiment3D;
//@}
/** 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 <b>"true()"</b>, 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 ( \link setDefaultPeak setDefaultPeak \endlink ).
\ingroup Spectra
*/
class BALL_EXPORT SimpleExperiment1D
: public Experiment1D
{
public:
/** @name Constructors and destructors
*/
//@{
/// Default constructor
SimpleExperiment1D();
/// Copy constructor
SimpleExperiment1D(const SimpleExperiment1D& experiment);
/// Destructor
virtual ~SimpleExperiment1D()
;
//@}
/** @name Processor related methods
*/
//@{
/** Initialize the experiment.
This method simply clears the internal peak list.
@return always <b>true</b>
*/
virtual bool start()
;
/** 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 \link setExpression setExpression \endlink .
The default is an empty expression, which matches all atoms.
Each peak in the peak list is assigned the intensity and width
defined using \link setDefaultPeak setDefaultPeak \endlink (defaults to zero).
*/
virtual Processor::Result operator () (Composite& composite)
;
//@}
/** @name Accessors
*/
//@{
/**
*/
void setExpression(const String& expression);
/**
*/
const Expression& getExpression() const;
//@}
protected:
Expression expression_;
};
} //namespace BALL
#endif // BALL_NMR_EXPERIMENT_H
|