Nanga Parbat 1.1.0
A TMD fitting framework
Public Member Functions | Protected Attributes | List of all members
NangaParbat::Cut Class Referenceabstract

Purely virtual mother class that implements the main feautures of a cut function on a given dataset. Given a DataHandler object as an input, it returns a mask of bools that selects the points that pass the specific cut. More...

#include <cut.h>

Inheritance diagram for NangaParbat::Cut:
NangaParbat::QCut NangaParbat::TrainingCut NangaParbat::ZCut

Public Member Functions

 Cut (Cut const &cut)
 The "Cut" copy constructor. More...
 
 Cut (DataHandler const &dataset, double const &min, double const &max)
 The "Cut" constructor. More...
 
virtual ~Cut ()
 The "Cut" destructor. More...
 
virtual void EnforceCut ()=0
 Purely virtual function to be used implemented in the derived class to eforce the cut. More...
 
std::valarray< bool > GetMask () const
 Function that returns the cut mask. More...
 

Protected Attributes

DataHandler const & _dataset
 The dataset to be processed. More...
 
double const _min
 Minimal value. More...
 
double const _max
 Maximal value. More...
 
std::valarray< bool > _mask
 Cut mask. More...
 

Detailed Description

Purely virtual mother class that implements the main feautures of a cut function on a given dataset. Given a DataHandler object as an input, it returns a mask of bools that selects the points that pass the specific cut.

Constructor & Destructor Documentation

◆ Cut() [1/2]

NangaParbat::Cut::Cut ( Cut const &  cut)

The "Cut" copy constructor.

Parameters
cutobjects to be copied

◆ Cut() [2/2]

NangaParbat::Cut::Cut ( DataHandler const &  dataset,
double const &  min,
double const &  max 
)

The "Cut" constructor.

Parameters
datasetthe DataHandler object subject to the cuts
minmininum value
maxmaximal value

◆ ~Cut()

virtual NangaParbat::Cut::~Cut ( )
inlinevirtual

The "Cut" destructor.

Member Function Documentation

◆ EnforceCut()

virtual void NangaParbat::Cut::EnforceCut ( )
pure virtual

Purely virtual function to be used implemented in the derived class to eforce the cut.

Implemented in NangaParbat::QCut, NangaParbat::TrainingCut, and NangaParbat::ZCut.

◆ GetMask()

std::valarray< bool > NangaParbat::Cut::GetMask ( ) const
inline

Function that returns the cut mask.

Member Data Documentation

◆ _dataset

DataHandler const& NangaParbat::Cut::_dataset
protected

The dataset to be processed.

◆ _mask

std::valarray<bool> NangaParbat::Cut::_mask
protected

Cut mask.

◆ _max

double const NangaParbat::Cut::_max
protected

Maximal value.

◆ _min

double const NangaParbat::Cut::_min
protected

Minimal value.


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