meerkat is hosted by Hepforge, IPPP Durham
Meerkat  v1r3
Multidimensional kernel density estimation package
OneDimPhaseSpace Class Reference

#include <OneDimPhaseSpace.hh>

Inheritance diagram for OneDimPhaseSpace:
AbsPhaseSpace

Public Member Functions

 OneDimPhaseSpace (const char *phaseSpaceName, Double_t lowerLimit, Double_t upperLimit)
 Constructor. More...
 
virtual ~OneDimPhaseSpace ()
 Destructor. More...
 
UInt_t dimensionality ()
 Get dimensionality of the phase space. Always equals to one. More...
 
Bool_t withinLimits (std::vector< Double_t > &x)
 Check if the point is within the phase space limits. More...
 
Double_t lowerLimit (UInt_t var)
 Get lower limit. More...
 
Double_t upperLimit (UInt_t var)
 Get upper limit. More...
 
Bool_t limits (UInt_t var, std::vector< Double_t > &x, Double_t *lower, Double_t *upper)
 Return limits (lower and upper) for the variable at the certain point of the phase space. More...
 
- Public Member Functions inherited from AbsPhaseSpace
 AbsPhaseSpace (const char *phaseSpaceName)
 Constructor. More...
 
virtual ~AbsPhaseSpace ()
 Destructor. More...
 
const char * name (void)
 Return the name of the phase space. More...
 

Private Attributes

Double_t m_lowerLimit
 Lower limit. More...
 
Double_t m_upperLimit
 Upper limit. More...
 

Additional Inherited Members

- Protected Attributes inherited from AbsPhaseSpace
char m_name [256]
 Phase space name. More...
 

Detailed Description

Class which describes one-dimensional flat phase space (i.e. the finite range in one variable)

Definition at line 13 of file OneDimPhaseSpace.hh.

Constructor & Destructor Documentation

OneDimPhaseSpace::OneDimPhaseSpace ( const char *  phaseSpaceName,
Double_t  lowerLimit,
Double_t  upperLimit 
)

Constructor.

Parameters
[in]phaseSpaceNamename of the phase space
[in]lowerLimitlower limit of the phase space
[in]upperLimitupper limit of the phase space

Definition at line 15 of file OneDimPhaseSpace.cpp.

OneDimPhaseSpace::~OneDimPhaseSpace ( )
virtual

Destructor.

Definition at line 32 of file OneDimPhaseSpace.cpp.

Member Function Documentation

UInt_t OneDimPhaseSpace::dimensionality ( )
inlinevirtual

Get dimensionality of the phase space. Always equals to one.

Implements AbsPhaseSpace.

Definition at line 31 of file OneDimPhaseSpace.hh.

Bool_t OneDimPhaseSpace::limits ( UInt_t  var,
std::vector< Double_t > &  x,
Double_t *  lower,
Double_t *  upper 
)
virtual

Return limits (lower and upper) for the variable at the certain point of the phase space.

Parameters
[in]varnumber of the variable
[in]xpoint in the phase space
[out]lowerlower limit
[out]upperupper limit

Implements AbsPhaseSpace.

Definition at line 58 of file OneDimPhaseSpace.cpp.

Double_t OneDimPhaseSpace::lowerLimit ( UInt_t  var)
virtual

Get lower limit.

Implements AbsPhaseSpace.

Definition at line 43 of file OneDimPhaseSpace.cpp.

Double_t OneDimPhaseSpace::upperLimit ( UInt_t  var)
virtual

Get upper limit.

Implements AbsPhaseSpace.

Definition at line 50 of file OneDimPhaseSpace.cpp.

Bool_t OneDimPhaseSpace::withinLimits ( std::vector< Double_t > &  x)
virtual

Check if the point is within the phase space limits.

Implements AbsPhaseSpace.

Definition at line 36 of file OneDimPhaseSpace.cpp.

Member Data Documentation

Double_t OneDimPhaseSpace::m_lowerLimit
private

Lower limit.

Definition at line 54 of file OneDimPhaseSpace.hh.

Double_t OneDimPhaseSpace::m_upperLimit
private

Upper limit.

Definition at line 57 of file OneDimPhaseSpace.hh.


The documentation for this class was generated from the following files: