ana::_Cut< T > Class Template Reference

Template for Cut and SpillCut. More...

#include "/cvmfs/nova.opensciencegrid.org/externals/cafanacore/v01.12/src/CAFAna/Core/Cut.h"

Public Types
typedef bool(	CutFunc_t) (const T *sr)
	The type of the function part of a cut. More...

Public Member Functions
	_Cut (const std::function< CutFunc_t > &func, const std::function< ExposureFunc_t > &liveFunc=0, const std::function< ExposureFunc_t > &potFunc=0)
	std::function can wrap a real function, function object, or lambda More...
	_Cut (const _Cut< T > &c)
_Cut &	operator= (const _Cut< T > &c)
	~_Cut ()
bool	operator() (const T *sr) const
	Allows a cut to be called with bool result = myCut(sr) syntax. More...
double	Livetime (const caf::SRSpillProxy *spill) const
	Provide a Livetime function if your cut is a timing cut etc. More...
double	POT (const caf::SRSpillProxy *spill) const
	Could be useful for cuts on specific batches? More...
_Cut< T >	operator&& (const _Cut< T > &c) const
_Cut< T >	operator|| (const _Cut< T > &b) const
_Cut< T >	operator! () const
int	ID () const
	Cuts with the same definition will have the same ID. More...

Static Public Member Functions
static int	MaxID ()

Protected Member Functions
	operator bool () const
	_Cut (const std::function< CutFunc_t > &fun, const std::function< ExposureFunc_t > &liveFunc, const std::function< ExposureFunc_t > &potFunc, int id)

Protected Attributes
std::function< CutFunc_t >	fFunc
std::function< ExposureFunc_t >	fLiveFunc
std::function< ExposureFunc_t >	fPOTFunc
int	fID

Static Protected Attributes
static int	fgNextID = 0
	The next ID that hasn't yet been assigned. More...

Detailed Description

template<class T>
class ana::_Cut< T >

Template for Cut and SpillCut.

Definition at line 15 of file Cut.h.

Member Typedef Documentation

template<class T>

typedef bool( ana::_Cut< T >::CutFunc_t) (const T *sr)

The type of the function part of a cut.

Definition at line 19 of file Cut.h.

Constructor & Destructor Documentation

template<class T >

ana::_Cut< T >::_Cut	(	const std::function< CutFunc_t > &	func,
		const std::function< ExposureFunc_t > &	liveFunc = 0,
		const std::function< ExposureFunc_t > &	potFunc = 0
	)

std::function can wrap a real function, function object, or lambda

Definition at line 12 of file Cut.cxx.

References ana::DepMan< T >::RegisterConstruction().

Referenced by ana::_Cut< caf::SRProxy >::MaxID().

    : fFunc(func), fLiveFunc(liveFunc), fPOTFunc(potFunc),
      fID(fgNextID++)
  {
    DepMan<_Cut<T>>::Instance().RegisterConstruction(this);
  }

template<class T>

ana::_Cut< T >::_Cut

(

const _Cut< T > &

c

)

Definition at line 39 of file Cut.cxx.

References ana::_Cut< T >::fFunc, ana::_Cut< T >::fID, ana::_Cut< T >::fLiveFunc, ana::_Cut< T >::fPOTFunc, ana::_Cut< T >::operator=(), ana::DepMan< T >::RegisterConstruction(), and ana::DepMan< T >::RegisterDependency().

    : fFunc(0), fLiveFunc(0), fPOTFunc(0), fID(-1)
  {
    if(&c == this) return;

    if(c.fFunc){
      fFunc = c.fFunc;
      fLiveFunc = c.fLiveFunc;
      fPOTFunc = c.fPOTFunc;
      fID = c.fID;

      DepMan<_Cut<T>>::Instance().RegisterConstruction(this);
    }
    else{
      // If we are copying from a Cut with NULL func, that is probably because
      // it is all zero because it hasn't been statically constructed
      // yet. Register our interest of getting constructed in turn once it is.
      DepMan<_Cut<T>>::Instance().RegisterDependency(&c, this);
    }
  }

template<class T >

ana::_Cut< T >::~_Cut

(

)

Definition at line 33 of file Cut.cxx.

References ana::DepMan< T >::RegisterDestruction().

  {
    DepMan<_Cut<T>>::Instance().RegisterDestruction(this);
  }

template<class T>

ana::_Cut< T >::_Cut ( const std::function< CutFunc_t > &  fun, const std::function< ExposureFunc_t > &  liveFunc, const std::function< ExposureFunc_t > &  potFunc, int  id  )

protected

Definition at line 23 of file Cut.cxx.

References ana::DepMan< T >::RegisterConstruction().

    : fFunc(fun), fLiveFunc(liveFunc), fPOTFunc(potFunc), fID(id)
  {
    DepMan<_Cut<T>>::Instance().RegisterConstruction(this);
  }

Member Function Documentation

template<class T>

int ana::_Cut< T >::ID ( ) const

inline

Cuts with the same definition will have the same ID.

Definition at line 55 of file Cut.h.

Referenced by ana::ExposureSource::AddSink(), ana::SpectrumLoaderBase::GetSinkSCW(), ana::_Cut< T >::operator!(), ana::_Cut< T >::operator&&(), ana::CompareByID::operator()(), ana::_preview::_RecordSource< T >::operator[](), and ana::_Cut< T >::operator||().

{return fID;}

template<class T>

double ana::_Cut< T >::Livetime ( const caf::SRSpillProxy *  spill ) const

inline

Provide a Livetime function if your cut is a timing cut etc.

Definition at line 39 of file Cut.h.

Referenced by ana::ExposureSource::HandleSpill().

    {
      return fLiveFunc ? fLiveFunc(spill) : -1;
    }

template<class T>

static int ana::_Cut< T >::MaxID ( )

inlinestatic

Definition at line 57 of file Cut.h.

{return fgNextID-1;}

template<class T >

ana::_Cut< T >::operator bool ( ) const

protected

Definition at line 185 of file Cut.cxx.

References om::cout, and allTimeWatchdog::endl.

  {
    std::cout << "*** A Cut object is being evaluated for truth-iness. "
              << "This very likely means you are using python and attempted "
              << "to use one of the 'and', 'or', or 'not' operators. Python "
              << "does not allow these to be overloaded. You should use the "
              << "corresponding bitwise operators '&', '|', '~' instead."
              << std::endl;
    abort();
  }

template<class T >

_Cut< T > ana::_Cut< T >::operator!

(

)

const

Definition at line 170 of file Cut.cxx.

References a, ana::_Cut< T >::fgNextID, ana::_Cut< T >::ID(), PandAna.Demos.tute_pid_validation::ids, ana::_Cut< T >::operator()(), sr, and T.

Referenced by ana::_Cut< caf::SRProxy >::POT().

  {
    static std::map<int, int> ids;

    struct Not
    {
      const _Cut<T> a;
      bool operator()(const T* sr) const {return !a(sr);}
    };

    if(ids.count(ID()) == 0) ids[ID()] = fgNextID++;
    return _Cut<T>(Not{*this}, 0, 0, ids[ID()]);
  }

template<class T>

_Cut< T > ana::_Cut< T >::operator&&

(

const _Cut< T > &

c

)

const

Definition at line 129 of file Cut.cxx.

References a, b, ana::CombineExposures(), ana::_Cut< T >::fgNextID, ana::_Cut< T >::fLiveFunc, ana::_Cut< T >::fPOTFunc, ana::_Cut< T >::ID(), PandAna.Demos.tute_pid_validation::ids, findDuplicateFiles::key, ana::_Cut< T >::operator()(), ana::_Cut< T >::operator||(), sr, and T.

Referenced by ana::CombineExposures(), and ana::_Cut< caf::SRProxy >::POT().

  {
    // The same pairs of cuts are frequently and-ed together. Make sure those
    // duplicates get the same IDs by remembering what we've done in the past.
    static std::map<std::pair<int, int>, int> ids;
    const std::pair<int, int> key(ID(), c.ID());

    struct And
    {
      const _Cut<T> a, b;
      bool operator()(const T* sr) const {return a(sr) && b(sr);}
    };

    if(ids.count(key) == 0) ids[key] = fgNextID++;
    return _Cut<T>(And{*this, c},
                   CombineExposures(fLiveFunc, c.fLiveFunc),
                   CombineExposures(fPOTFunc, c.fPOTFunc),
                   ids[key]);
  }

template<class T>

bool ana::_Cut< T >::operator() ( const T *  sr ) const

inline

Allows a cut to be called with bool result = myCut(sr) syntax.

Definition at line 33 of file Cut.h.

Referenced by ana::CombineExposures(), ana::_Cut< T >::operator!(), ana::_Cut< T >::operator&&(), and ana::_Cut< T >::operator||().

    {
      return fFunc(sr);
    }

template<class T>

_Cut< T > & ana::_Cut< T >::operator=

(

const _Cut< T > &

c

)

Definition at line 62 of file Cut.cxx.

References ana::_Cut< T >::fFunc, ana::_Cut< T >::fID, ana::_Cut< T >::fLiveFunc, ana::_Cut< T >::fPOTFunc, ana::DepMan< T >::RegisterConstruction(), and ana::DepMan< T >::RegisterDependency().

Referenced by ana::_Cut< T >::_Cut().

  {
    if(&c == this) return *this;

    if(c.fFunc){
      fFunc = c.fFunc;
      fLiveFunc = c.fLiveFunc;
      fPOTFunc = c.fPOTFunc;
      fID = c.fID;

      DepMan<_Cut<T>>::Instance().RegisterConstruction(this);
    }
    else{
      fFunc = 0;
      fLiveFunc = 0;
      fPOTFunc = 0;
      fID = -1;

      // If we are copying from a Cut with NULL func, that is probably because
      // it is all zero because it hasn't been statically constructed
      // yet. Register our interest of getting constructed in turn once it is.
      DepMan<_Cut<T>>::Instance().RegisterDependency(&c, this);
    }

    return *this;
  }

template<class T>

_Cut< T > ana::_Cut< T >::operator||

(

const _Cut< T > &

b

)

const

Definition at line 151 of file Cut.cxx.

References a, b, ana::CombineExposures(), ana::_Cut< T >::fgNextID, ana::_Cut< T >::fLiveFunc, ana::_Cut< T >::fPOTFunc, ana::_Cut< T >::ID(), PandAna.Demos.tute_pid_validation::ids, findDuplicateFiles::key, ana::_Cut< T >::operator()(), sr, and T.

Referenced by ana::_Cut< T >::operator&&(), and ana::_Cut< caf::SRProxy >::POT().

  {
    static std::map<std::pair<int, int>, int> ids;
    const std::pair<int, int> key(ID(), c.ID());

    struct Or
    {
      const _Cut<T> a, b;
      bool operator()(const T* sr) const {return a(sr) || b(sr);}
    };

    if(ids.count(key) == 0) ids[key] = fgNextID++;
    return _Cut<T>(Or{*this, c},
                   CombineExposures(fLiveFunc, c.fLiveFunc),
                   CombineExposures(fPOTFunc, c.fPOTFunc),
                   ids[key]);
  }

template<class T>

double ana::_Cut< T >::POT ( const caf::SRSpillProxy *  spill ) const

inline

Could be useful for cuts on specific batches?

Definition at line 45 of file Cut.h.

Referenced by ana::ExposureSource::HandleSpill().

    {
      return fPOTFunc ? fPOTFunc(spill) : -1;
    }

Member Data Documentation

template<class T>

std::function<CutFunc_t> ana::_Cut< T >::fFunc

protected

Definition at line 80 of file Cut.h.

Referenced by ana::_Cut< T >::_Cut(), ana::_Cut< caf::SRProxy >::operator()(), and ana::_Cut< T >::operator=().

template<class T>

int ana::_Cut< T >::fgNextID = 0

staticprotected

The next ID that hasn't yet been assigned.

Definition at line 85 of file Cut.h.

Referenced by ana::_Cut< caf::SRProxy >::MaxID(), ana::_Cut< T >::operator!(), ana::_Cut< T >::operator&&(), and ana::_Cut< T >::operator||().

template<class T>

int ana::_Cut< T >::fID

protected

Definition at line 83 of file Cut.h.

Referenced by ana::_Cut< T >::_Cut(), ana::_Cut< caf::SRProxy >::ID(), and ana::_Cut< T >::operator=().

template<class T>

std::function<ExposureFunc_t> ana::_Cut< T >::fLiveFunc

protected

Definition at line 81 of file Cut.h.

Referenced by ana::_Cut< T >::_Cut(), ana::_Cut< caf::SRProxy >::Livetime(), ana::_Cut< T >::operator&&(), ana::_Cut< T >::operator=(), and ana::_Cut< T >::operator||().

template<class T>

std::function<ExposureFunc_t> ana::_Cut< T >::fPOTFunc

protected

Definition at line 81 of file Cut.h.

Referenced by ana::_Cut< T >::_Cut(), ana::_Cut< T >::operator&&(), ana::_Cut< T >::operator=(), ana::_Cut< T >::operator||(), and ana::_Cut< caf::SRProxy >::POT().

---

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

• CAFAna/Core/Cut.h
• CAFAna/Core/Cut.cxx