MomentumFilter< T > Class Template Reference

MomentumFilter can filter objects upon their four-momentum properties. More...

#include <MomentumFilter.h>

Inheritance diagram for MomentumFilter< T >:

Collaboration diagram for MomentumFilter< T >:

Public Member Functions
	MomentumFilter ()
	Default constructor:
	MomentumFilter (const MomentumFilter< T > &filter)
	Copy constructor:
virtual	~MomentumFilter ()
	Destructor:
MomentumFilter< T > &	operator= (const MomentumFilter< T > &rhs)
	Assignment operator:
virtual bool	isAccepted (const T *element) const
	Main filter method.
double	pxMin () const
	Returns the minimum px required by the filter.
double	pxMax () const
	Returns the maximum px required by the filter.
double	pyMin () const
	Returns the minimum py required by the filter.
double	pyMax () const
	Returns the maximum py required by the filter.
double	pzMin () const
	Returns the minimum pz required by the filter.
double	pzMax () const
	Returns the maximum pz required by the filter.
double	eneMin () const
	Returns the minimum energy required by the filter.
double	eneMax () const
	Returns the maximum energy required by the filter.
double	etaMin () const
	Returns the minimum eta required by the filter.
double	etaMax () const
	Returns the maximum eta required by the filter.
double	phiMin () const
	Returns the minimum phi required by the filter.
double	phiMax () const
	Returns the maximum phi required by the filter.
double	massMin () const
	Returns the minimum mass required by the filter.
double	massMax () const
	Returns the maximum mass required by the filter.
double	ptMin () const
	Returns the minimum pt required by the filter.
double	ptMax () const
	Returns the maximum pt required by the filter.
double	atlasPhi (const double phi) const
	Convert a phi angle in the ATLAS conventional range -PI->PI inspired from FourMom package (could also use CaloPhiRange)
void	setFilter (const IFilterCuts *filter)
	Copies the IFilterCuts properties of the given object to the current IFilterCuts object (ie: it copies all the ranges in px,py,... to the current object)
void	setPxMin (const double pxMin)
	Sets the minimum px required by the filter.
void	setPxMax (const double pxMax)
	Sets the maximum px required by the filter.
void	setPyMin (const double pyMin)
	Sets the minimum py required by the filter.
void	setPyMax (const double pyMax)
	Sets the maximum py required by the filter.
void	setPzMin (const double pzMin)
	Sets the minimum pz required by the filter.
void	setPzMax (const double pzMax)
	Sets the maximum pz required by the filter.
void	setEneMin (const double eneMin)
	Sets the minimum energy required by the filter.
void	setEneMax (const double eneMax)
	Sets the maximum energy required by the filter.
void	setEtaMin (const double etaMin)
	Sets the minimum eta required by the filter.
void	setEtaMax (const double etaMax)
	Sets the maximum eta required by the filter.
void	setPhiMin (const double phiMin)
	Sets the minimum phi required by the filter.
void	setPhiMax (const double phiMax)
	Sets the maximum phi required by the filter.
void	setMassMin (const double massMin)
	Sets the minimum mass required by the filter.
void	setMassMax (const double massMax)
	Sets the maximum mass required by the filter.
void	setPtMin (const double ptMin)
	Sets the minimum pt required by the filter.
void	setPtMax (const double ptMax)
	Sets the maximum pt required by the filter.
void	setRange (const std::string &name, const double min, const double max)
	Set range for a given momentum component (by name)
bool	operator() (const T *element) const

Protected Attributes
FilterRange	m_pxRange
	The range in px required by the filter.
FilterRange	m_pyRange
	The range in py required by the filter.
FilterRange	m_pzRange
	The range in pz required by the filter.
FilterRange	m_eneRange
	The range in energy required by the filter.
FilterRange	m_etaRange
	The range in eta required by the filter.
PhiFilterRange	m_phiRange
	The range in phi required by the filter.
FilterRange	m_massRange
	The range in mass required by the filter.
FilterRange	m_ptRange
	The range in pt required by the filter.

Detailed Description

template<typename T>
class MomentumFilter< T >

MomentumFilter can filter objects upon their four-momentum properties.

It can select particles based on their px,py,pz and energy as well as their mass, pt, eta or phi. One can requires minimum or maximum cuts (or both).

Definition at line 30 of file MomentumFilter.h.

Constructor & Destructor Documentation

MomentumFilter() [1/2]

template<typename T>

MomentumFilter< T >::MomentumFilter ( )

inline

Default constructor:

Definition at line 274 of file MomentumFilter.h.

                                         :
  IFilterCuts(),
  IFilter<T>(),
  m_pxRange(),
  m_pyRange(),
  m_pzRange(),
  m_eneRange(),
  m_etaRange(),
  m_phiRange(),
  m_massRange(),
  m_ptRange()
{}

MomentumFilter() [2/2]

template<typename T>

MomentumFilter< T >::MomentumFilter ( const MomentumFilter< T > & filter )

inline

Copy constructor:

Definition at line 288 of file MomentumFilter.h.

                                                                       :
  IFilterCuts(rhs),
  IFilter<T>( rhs ),
  m_pxRange( rhs.m_pxRange ),
  m_pyRange( rhs.m_pyRange ),
  m_pzRange( rhs.m_pzRange ),
  m_eneRange(rhs.m_eneRange ),
  m_etaRange(rhs.m_etaRange ),
  m_phiRange(rhs.m_phiRange ),
  m_massRange(rhs.m_massRange ),
  m_ptRange( rhs.m_ptRange )
{}

~MomentumFilter()

template<typename T>

MomentumFilter< T >::~MomentumFilter ( )

virtual

Destructor:

Definition at line 302 of file MomentumFilter.h.

{}

Member Function Documentation

atlasPhi()

template<typename T>

double MomentumFilter< T >::atlasPhi ( const double phi ) const

inline

Convert a phi angle in the ATLAS conventional range -PI->PI inspired from FourMom package (could also use CaloPhiRange)

Definition at line 457 of file MomentumFilter.h.

{
  return m_phiRange.atlasPhi( phi );
}

eneMax()

template<typename T>

double MomentumFilter< T >::eneMax ( ) const

inline

Returns the maximum energy required by the filter.

Definition at line 403 of file MomentumFilter.h.

{
  return m_eneRange.upper();
}

eneMin()

template<typename T>

double MomentumFilter< T >::eneMin ( ) const

inline

Returns the minimum energy required by the filter.

Definition at line 397 of file MomentumFilter.h.

{
  return m_eneRange.lower();
}

etaMax()

template<typename T>

double MomentumFilter< T >::etaMax ( ) const

inline

Returns the maximum eta required by the filter.

Definition at line 415 of file MomentumFilter.h.

{
  return m_etaRange.upper();
}

etaMin()

template<typename T>

double MomentumFilter< T >::etaMin ( ) const

inline

Returns the minimum eta required by the filter.

Definition at line 409 of file MomentumFilter.h.

{
  return m_etaRange.lower();
}

isAccepted()

template<typename T>

bool MomentumFilter< T >::isAccepted ( const T * element ) const

virtual

Main filter method.

This method takes the decision whether or not the filter has to accept the element. It returns true or false accordingly if all the thresholds defined by the set_xyzMin or set_xyzMax are met. If no threshold has been defined, it returns true by default. Ex: a particle will be accepted if its px is as : pxMin() <= px <= pxMax()

Warning : it will not complain if you require a non-consistent set of cuts ( eg: ptMin < 10.*GeV and ptMax < 5.*GeV )

Implements IFilter< T >.

Definition at line 328 of file MomentumFilter.h.

{
  bool isAccepted = true;
  
  if ( m_pxRange.isActive() ) {
    isAccepted = isAccepted && m_pxRange.isInRange  ( element->px()  );
  }
  if ( m_pyRange.isActive() ) {
    isAccepted = isAccepted && m_pyRange.isInRange  ( element->py()  );
  }
  if ( m_pzRange.isActive() ) {
    isAccepted = isAccepted && m_pzRange.isInRange  ( element->pz()  );
  }
  if ( m_eneRange.isActive() ) {
    isAccepted = isAccepted && m_eneRange.isInRange ( element->e()   );
  }
  if ( m_etaRange.isActive() ) {
    isAccepted = isAccepted && m_etaRange.isInRange ( element->eta() );
  }
  if ( m_phiRange.isActive() ) {
    isAccepted = isAccepted && m_phiRange.isInRange( element->phi() );
  }
  if ( m_massRange.isActive() ) {
    isAccepted = isAccepted && m_massRange.isInRange( element->m()   );
  }
  if ( m_ptRange.isActive() ) {
    isAccepted = isAccepted && m_ptRange.isInRange  ( element->pt()  );
  }
 
  return isAccepted;
}

massMax()

template<typename T>

double MomentumFilter< T >::massMax ( ) const

inline

Returns the maximum mass required by the filter.

Definition at line 439 of file MomentumFilter.h.

{
  return m_massRange.upper();
}

massMin()

template<typename T>

double MomentumFilter< T >::massMin ( ) const

inline

Returns the minimum mass required by the filter.

Definition at line 433 of file MomentumFilter.h.

{
  return m_massRange.lower();
}

operator()()

template<typename T>

bool IFilter< T >::operator() ( const T * element ) const

inlineinherited

Definition at line 101 of file IFilter.h.

{ 
  return isAccepted(element); 
}

operator=()

template<typename T>

MomentumFilter< T > & MomentumFilter< T >::operator= ( const MomentumFilter< T > & rhs )

inline

Assignment operator:

Definition at line 306 of file MomentumFilter.h.

{
  if ( this != &rhs ) {
    IFilterCuts::operator=(rhs);
    IFilter<T>::operator=(rhs);
    m_pxRange   = rhs.m_pxRange;
    m_pyRange   = rhs.m_pyRange;
    m_pzRange   = rhs.m_pzRange;
    m_eneRange  = rhs.m_eneRange;
    m_etaRange  = rhs.m_etaRange;
    m_phiRange  = rhs.m_phiRange;
    m_massRange = rhs.m_massRange;
    m_ptRange   = rhs.m_ptRange;
  }
  return *this;
}

phiMax()

template<typename T>

double MomentumFilter< T >::phiMax ( ) const

inline

Returns the maximum phi required by the filter.

Definition at line 427 of file MomentumFilter.h.

{
  return m_phiRange.upper();
}

phiMin()

template<typename T>

double MomentumFilter< T >::phiMin ( ) const

inline

Returns the minimum phi required by the filter.

Definition at line 421 of file MomentumFilter.h.

{
  return m_phiRange.lower();
}

ptMax()

template<typename T>

double MomentumFilter< T >::ptMax ( ) const

inline

Returns the maximum pt required by the filter.

Definition at line 451 of file MomentumFilter.h.

{
  return m_ptRange.upper();
}

ptMin()

template<typename T>

double MomentumFilter< T >::ptMin ( ) const

inline

Returns the minimum pt required by the filter.

Definition at line 445 of file MomentumFilter.h.

{
  return m_ptRange.lower();
}

pxMax()

template<typename T>

double MomentumFilter< T >::pxMax ( ) const

inline

Returns the maximum px required by the filter.

Definition at line 367 of file MomentumFilter.h.

{
  return m_pxRange.upper();
}

pxMin()

template<typename T>

double MomentumFilter< T >::pxMin ( ) const

inline

Returns the minimum px required by the filter.

Definition at line 361 of file MomentumFilter.h.

{
  return m_pxRange.lower();
}

pyMax()

template<typename T>

double MomentumFilter< T >::pyMax ( ) const

inline

Returns the maximum py required by the filter.

Definition at line 379 of file MomentumFilter.h.

{
  return m_pyRange.upper();
}

pyMin()

template<typename T>

double MomentumFilter< T >::pyMin ( ) const

inline

Returns the minimum py required by the filter.

Definition at line 373 of file MomentumFilter.h.

{
  return m_pyRange.lower();
}

pzMax()

template<typename T>

double MomentumFilter< T >::pzMax ( ) const

inline

Returns the maximum pz required by the filter.

Definition at line 391 of file MomentumFilter.h.

{
  return m_pzRange.upper();
}

pzMin()

template<typename T>

double MomentumFilter< T >::pzMin ( ) const

inline

Returns the minimum pz required by the filter.

Definition at line 385 of file MomentumFilter.h.

{
  return m_pzRange.lower();
}

setEneMax()

template<typename T>

void MomentumFilter< T >::setEneMax ( const double eneMax )

inline

Sets the maximum energy required by the filter.

Definition at line 534 of file MomentumFilter.h.

{
  m_eneRange.setMax(eneMax);
}

setEneMin()

template<typename T>

void MomentumFilter< T >::setEneMin ( const double eneMin )

inline

Sets the minimum energy required by the filter.

Definition at line 528 of file MomentumFilter.h.

{
  m_eneRange.setMin(eneMin);
}

setEtaMax()

template<typename T>

void MomentumFilter< T >::setEtaMax ( const double etaMax )

inline

Sets the maximum eta required by the filter.

Definition at line 546 of file MomentumFilter.h.

{
  m_etaRange.setMax(etaMax);
}

setEtaMin()

template<typename T>

void MomentumFilter< T >::setEtaMin ( const double etaMin )

inline

Sets the minimum eta required by the filter.

Definition at line 540 of file MomentumFilter.h.

{
  m_etaRange.setMin(etaMin);
}

setFilter()

template<typename T>

void MomentumFilter< T >::setFilter ( const IFilterCuts * filter )

virtual

Copies the IFilterCuts properties of the given object to the current IFilterCuts object (ie: it copies all the ranges in px,py,... to the current object)

Implements IFilterCuts.

Definition at line 466 of file MomentumFilter.h.

{
  if ( filter ) {
    try {
      const MomentumFilter<T> * momFilter = 
    dynamic_cast<const MomentumFilter<T> *>(filter);
 
      if ( momFilter ) {
    operator=(*momFilter);
      } else {
    MsgStream log( Athena::getMessageSvc(), "MomentumFilter" );
    log << MSG::ERROR
        << "Can't dynamic_cast " << typeid(filter).name() 
        << " to a MomentumFilter"
        << endmsg;
      }
    } catch (...) {
      MsgStream log( Athena::getMessageSvc(), "MomentumFilter" );
      log << MSG::ERROR
      << "Can't dynamic_cast " << filter << " to a MomentumFilter"
      << endmsg;
    }
  } //> filter is a valid pointer
}

setMassMax()

template<typename T>

void MomentumFilter< T >::setMassMax ( const double massMax )

inline

Sets the maximum mass required by the filter.

Definition at line 572 of file MomentumFilter.h.

{
  m_massRange.setMax(massMax);
}

setMassMin()

template<typename T>

void MomentumFilter< T >::setMassMin ( const double massMin )

inline

Sets the minimum mass required by the filter.

Definition at line 566 of file MomentumFilter.h.

{
  m_massRange.setMin(massMin);
}

setPhiMax()

template<typename T>

void MomentumFilter< T >::setPhiMax ( const double phiMax )

inline

Sets the maximum phi required by the filter.

Phi range convention -PI,PI is enforced within the PhiFilterRange

Definition at line 559 of file MomentumFilter.h.

{
  m_phiRange.setMax(phiMax);
}

setPhiMin()

template<typename T>

void MomentumFilter< T >::setPhiMin ( const double phiMin )

inline

Sets the minimum phi required by the filter.

Phi range convention -PI,PI is enforced within the PhiFilterRange

Definition at line 552 of file MomentumFilter.h.

{
  m_phiRange.setMin(phiMin);
}

setPtMax()

template<typename T>

void MomentumFilter< T >::setPtMax ( const double ptMax )

inline

Sets the maximum pt required by the filter.

Definition at line 584 of file MomentumFilter.h.

{
  m_ptRange.setMax(ptMax);
}

setPtMin()

template<typename T>

void MomentumFilter< T >::setPtMin ( const double ptMin )

inline

Sets the minimum pt required by the filter.

Definition at line 578 of file MomentumFilter.h.

{
  m_ptRange.setMin(ptMin);
}

setPxMax()

template<typename T>

void MomentumFilter< T >::setPxMax ( const double pxMax )

inline

Sets the maximum px required by the filter.

Definition at line 498 of file MomentumFilter.h.

{
  m_pxRange.setMax(pxMax);
}

setPxMin()

template<typename T>

void MomentumFilter< T >::setPxMin ( const double pxMin )

inline

Sets the minimum px required by the filter.

Definition at line 492 of file MomentumFilter.h.

{
  m_pxRange.setMin(pxMin);
}

setPyMax()

template<typename T>

void MomentumFilter< T >::setPyMax ( const double pyMax )

inline

Sets the maximum py required by the filter.

Definition at line 510 of file MomentumFilter.h.

{
  m_pyRange.setMax(pyMax);
}

setPyMin()

template<typename T>

void MomentumFilter< T >::setPyMin ( const double pyMin )

inline

Sets the minimum py required by the filter.

Definition at line 504 of file MomentumFilter.h.

{
  m_pyRange.setMin(pyMin);
}

setPzMax()

template<typename T>

void MomentumFilter< T >::setPzMax ( const double pzMax )

inline

Sets the maximum pz required by the filter.

Definition at line 522 of file MomentumFilter.h.

{
  m_pzRange.setMax(pzMax);
}

setPzMin()

template<typename T>

void MomentumFilter< T >::setPzMin ( const double pzMin )

inline

Sets the minimum pz required by the filter.

Definition at line 516 of file MomentumFilter.h.

{
  m_pzRange.setMin(pzMin);
}

setRange()

template<typename T>

void MomentumFilter< T >::setRange	(	const std::string &	name,
		const double	min,
		const double	max )

Set range for a given momentum component (by name)

Definition at line 590 of file MomentumFilter.h.

{
  if        ( name == "px" )   { m_pxRange   .setRange( min, max );
  } else if ( name == "py" )   { m_pyRange   .setRange( min, max );
  } else if ( name == "pz" )   { m_pzRange   .setRange( min, max );
  } else if ( name == "ene" )  { m_eneRange  .setRange( min, max );
  } else if ( name == "eta" )  { m_etaRange  .setRange( min, max );
  } else if ( name == "phi" )  { m_phiRange  .setRange( min, max );
  } else if ( name == "mass" ) { m_massRange .setRange( min, max );
  } else if ( name == "pt" )   { m_ptRange   .setRange( min, max );
  } else {
    const std::string error = "Range of name <"+name+"> is UNKNOWN !!";
    throw std::invalid_argument(error);
  }
 
  return;
}

Member Data Documentation

m_eneRange

template<typename T>

FilterRange MomentumFilter< T >::m_eneRange

protected

The range in energy required by the filter.

Definition at line 243 of file MomentumFilter.h.

m_etaRange

template<typename T>

FilterRange MomentumFilter< T >::m_etaRange

protected

The range in eta required by the filter.

Definition at line 247 of file MomentumFilter.h.

m_massRange

template<typename T>

FilterRange MomentumFilter< T >::m_massRange

protected

The range in mass required by the filter.

Definition at line 255 of file MomentumFilter.h.

m_phiRange

template<typename T>

PhiFilterRange MomentumFilter< T >::m_phiRange

protected

The range in phi required by the filter.

Definition at line 251 of file MomentumFilter.h.

m_ptRange

template<typename T>

FilterRange MomentumFilter< T >::m_ptRange

protected

The range in pt required by the filter.

Definition at line 259 of file MomentumFilter.h.

m_pxRange

template<typename T>

FilterRange MomentumFilter< T >::m_pxRange

protected

The range in px required by the filter.

Definition at line 231 of file MomentumFilter.h.

m_pyRange

template<typename T>

FilterRange MomentumFilter< T >::m_pyRange

protected

The range in py required by the filter.

Definition at line 235 of file MomentumFilter.h.

m_pzRange

template<typename T>

FilterRange MomentumFilter< T >::m_pzRange

protected

The range in pz required by the filter.

Definition at line 239 of file MomentumFilter.h.

---

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

• MomentumFilter.h