Version of helper class for cells taken from the cluster itself. More...

Inheritance diagram for CaloClusterCorr::SamplingHelper_Cluster:

Collaboration diagram for CaloClusterCorr::SamplingHelper_Cluster:

Public Member Functions
	SamplingHelper_Cluster (const CaloClusterCorrection &parent, const CaloFillRectangularCluster::WindowArray_t &windows, CaloCluster *cluster)
	Constructor. More...

virtual void	calculate (double eta, double phi, double deta, double dphi, CaloSampling::CaloSample sampling, bool dofill=false)
	Calculate layer variables. More...

virtual const CaloCell *	max_et_cell () const
	Return the cell with the maximum energy. More...

virtual bool	empty () const
	Test for empty candidate cell list. More...

void	calculate_cluster (double eta, double phi, double deta, double dphi, CaloSampling::CaloSample sampling)
	Calculate layer variables for cells in the cluster. More...

void	calculate_and_set (double eta, double phi, int layer, int fallback_layer, const CaloSampling::CaloSample samplings[4], bool allow_badpos=false)
	Calculate layer variables and update cluster. More...

CaloCluster *	cluster ()
	Return the cluster we're updating. More...

double	etam () const
	Return the \(\eta\) position from the last calculation. More...

double	phim () const
	Return the \(\phi\) position from the last calculation. More...

double	etamax () const
	Return the \(\eta\) maximum position from the last calculation. More...

double	phimax () const
	Return the \(\phi\) maximum position from the last calculation. More...

double	etareal () const

double	deta (int layer) const

double	dphi (int layer) const

Protected Attributes
CaloLayerCalculator	m_calc
	The calculator object. More...

const CaloClusterCorrection &	m_parent
	The correction object using us. More...

CaloCluster *	m_cluster
	The cluster we're updating. More...

CaloFillRectangularCluster::WindowArray_t	m_windows
	Window size, per layer. More...

double	m_etam
	\(\eta\) position from last calculation. More...

double	m_phim
	\(\phi\) position from last calculation. More...

Detailed Description

Version of helper class for cells taken from the cluster itself.

Definition at line 666 of file CaloFillRectangularCluster.cxx.

Constructor & Destructor Documentation

◆ SamplingHelper_Cluster()

CaloClusterCorr::SamplingHelper_Cluster::SamplingHelper_Cluster	(	const CaloClusterCorrection &	parent,
		const CaloFillRectangularCluster::WindowArray_t &	windows,
		CaloCluster *	cluster
	)

Constructor.

Parameters

parent	The parent correction class.
windows	Per-layer array of window eta,phi sizes.
cluster	The cluster being operated on.

Definition at line 717 of file CaloFillRectangularCluster.cxx.

   : SamplingHelper (parent, windows, cluster)
 {
 }

Member Function Documentation

◆ calculate()

void CaloClusterCorr::SamplingHelper_Cluster::calculate	(	double	eta,
		double	phi,
		double	deta,
		double	dphi,
		CaloSampling::CaloSample	sampling,
		bool	dofill = `false`
	)

virtual

Calculate layer variables.

Parameters

eta	Center of the cluster in \(\eta\).
phi	Center of the cluster in \(\phi\).
deta	Full width of the cluster in \(\eta\).
dphi	Full width of the cluster in \(\phi\).
sampling	The sampling for which to do the calculation.
dofill	(Ignored for this implementation.)

This method selects the cells within the specified window in the specified sampling from the list of candidate cells and calculates the layer variables.

The result of the calculation will be held in internal variables.

Implements CaloClusterCorr::SamplingHelper.

Definition at line 741 of file CaloFillRectangularCluster.cxx.

 {
   calculate_cluster (eta, phi, deta, dphi, sampling);
 }

◆ calculate_and_set()

void CaloClusterCorr::SamplingHelper::calculate_and_set	(	double	eta,
		double	phi,
		int	layer,
		int	fallback_layer,
		const CaloSampling::CaloSample	samplings[4],
		bool	allow_badpos = `false`
	)

inherited

Calculate layer variables and update cluster.

Parameters

eta	Center of the cluster in \(\eta\).
phi	Center of the cluster in \(\phi\).
layer	Calorimeter layer being calculated (0-3).
fallback_layer	Layer for fallback values (see below).
samplings	List of samplings for this region.
allow_badpos	Should error flags be allowed into the cluster?

This method selects the cells within the specified window for the sampling for the specified layer from the current list of cells in the cluster and calculates the layer variables.

The result of the calculation will be held in internal variables. In addition, the cluster variables for this sampling will be updated with the result.

In some cases, the calculation of the cluster position may yield an error (for example, if there are no selected cells). In this case, we use the cluster eta/phi from the layer given by fallback_layer instead of the calculated result. (If fallback_layer is < 0, then we use the eta, phi arguments instead.) If allow_badpos is true, then the error flags are used to update the cluster variables; otherwise, the fallback position is used when updating the cluster.

Definition at line 383 of file CaloFillRectangularCluster.cxx.

 {
   calculate (eta, phi, deta(layer), dphi(layer), samplings[layer], true);
  
   double seteta = m_calc.etam();
   double setphi = m_calc.phim();
  
   double fallback_eta = eta;
   double fallback_phi = phi;
   if ((seteta == -999 || setphi == -999) && fallback_layer >= 0 && fallback_layer < 4) {
     // In the calo frame
     fallback_eta = m_cluster->etaSample (samplings[fallback_layer]);
     fallback_phi = m_cluster->phiSample (samplings[fallback_layer]);
   }
  
   if (!allow_badpos) {
     //if (m_etam == -999) m_etam = fallback_eta;
     //if (m_phim == -999) m_phim = fallback_phi;
     if (seteta == -999) seteta = fallback_eta;
     if (setphi == -999) setphi = fallback_phi;
   }
  
   //FIXME: Sampling pattern not yet set! 
   m_parent.setsample (m_cluster,
                       samplings[layer],
                       m_calc.em(),
               seteta,
               setphi,
                       m_calc.emax(),
                       m_calc.etamax(),
                       m_calc.phimax(),
                       m_calc.etas(),
                       m_calc.phis());
   if (allow_badpos) {
     if (m_etam == -999) m_etam = fallback_eta;
     if (m_phim == -999) m_phim = fallback_phi;
   }
 }

◆ calculate_cluster()

void CaloClusterCorr::SamplingHelper::calculate_cluster	(	double	eta,
		double	phi,
		double	deta,
		double	dphi,
		CaloSampling::CaloSample	sampling
	)

inherited

Calculate layer variables for cells in the cluster.

Parameters

eta	Center of the cluster in \(\eta\).
phi	Center of the cluster in \(\phi\).
deta	Full width of the cluster in \(\eta\).
dphi	Full width of the cluster in \(\phi\).
sampling	The sampling for which to do the calculation.

This method selects the cells within the specified window in the specified sampling from the current list of cells in the cluster and calculates the layer variables.

The result of the calculation will be held in internal variables.

Definition at line 444 of file CaloFillRectangularCluster.cxx.

 {
   m_calc.fill (m_cluster->cell_begin(), m_cluster->cell_end(),
                eta, phi, deta, dphi, sampling);
   m_etam = m_calc.etamr();
   m_phim = m_calc.phimr();
 }

◆ cluster()

CaloCluster * CaloClusterCorr::SamplingHelper::cluster ( )

inlineinherited

Return the cluster we're updating.

Definition at line 460 of file CaloFillRectangularCluster.cxx.

 {
   return m_cluster;
 }

◆ deta()

double CaloClusterCorr::SamplingHelper::deta ( int layer ) const

inlineinherited

Definition at line 313 of file CaloFillRectangularCluster.cxx.

313 { return m_windows[layer].first; }

◆ dphi()

double CaloClusterCorr::SamplingHelper::dphi ( int layer ) const

inlineinherited

Definition at line 314 of file CaloFillRectangularCluster.cxx.

314 { return m_windows[layer].second; }

◆ empty()

bool CaloClusterCorr::SamplingHelper_Cluster::empty ( ) const

virtual

Test for empty candidate cell list.

Implements CaloClusterCorr::SamplingHelper.

Definition at line 763 of file CaloFillRectangularCluster.cxx.

 {
   return m_cluster->size()==0;
 }

◆ etam()

double CaloClusterCorr::SamplingHelper::etam ( ) const

inlineinherited

Return the \(\eta\) position from the last calculation.

Definition at line 468 of file CaloFillRectangularCluster.cxx.

 {
   return m_etam;
 }

◆ etamax()

double CaloClusterCorr::SamplingHelper::etamax ( ) const

inlineinherited

Return the \(\eta\) maximum position from the last calculation.

Definition at line 484 of file CaloFillRectangularCluster.cxx.

 {
   return m_calc.etarmax();
 }

◆ etareal()

double CaloClusterCorr::SamplingHelper::etareal ( ) const

inlineinherited

Definition at line 310 of file CaloFillRectangularCluster.cxx.

310 { return m_calc.etam(); }

◆ max_et_cell()

const CaloCell * CaloClusterCorr::SamplingHelper_Cluster::max_et_cell ( ) const

virtual

Return the cell with the maximum energy.

Implements CaloClusterCorr::SamplingHelper.

Definition at line 754 of file CaloFillRectangularCluster.cxx.

 {
   return *std::max_element(std::as_const(*m_cluster).cell_begin(),
                            std::as_const(*m_cluster).cell_end(),
                            et_compare_larem_only());
 }

◆ phim()

double CaloClusterCorr::SamplingHelper::phim ( ) const

inlineinherited

Return the \(\phi\) position from the last calculation.

Definition at line 476 of file CaloFillRectangularCluster.cxx.

 {
   return m_phim;
 }

◆ phimax()

double CaloClusterCorr::SamplingHelper::phimax ( ) const

inlineinherited

Return the \(\phi\) maximum position from the last calculation.

Definition at line 492 of file CaloFillRectangularCluster.cxx.

 {
   return m_calc.phirmax();
 }

Member Data Documentation

◆ m_calc

CaloLayerCalculator CaloClusterCorr::SamplingHelper::m_calc

protectedinherited

The calculator object.

Definition at line 319 of file CaloFillRectangularCluster.cxx.

◆ m_cluster

CaloCluster* CaloClusterCorr::SamplingHelper::m_cluster

protectedinherited

The cluster we're updating.

Definition at line 325 of file CaloFillRectangularCluster.cxx.

◆ m_etam

double CaloClusterCorr::SamplingHelper::m_etam

protectedinherited

\(\eta\) position from last calculation.

Definition at line 331 of file CaloFillRectangularCluster.cxx.

◆ m_parent

const CaloClusterCorrection& CaloClusterCorr::SamplingHelper::m_parent

protectedinherited

The correction object using us.

Definition at line 322 of file CaloFillRectangularCluster.cxx.

◆ m_phim

double CaloClusterCorr::SamplingHelper::m_phim

protectedinherited

\(\phi\) position from last calculation.

Definition at line 334 of file CaloFillRectangularCluster.cxx.

◆ m_windows

CaloFillRectangularCluster::WindowArray_t CaloClusterCorr::SamplingHelper::m_windows

protectedinherited

Window size, per layer.

Definition at line 328 of file CaloFillRectangularCluster.cxx.

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

CaloFillRectangularCluster.cxx

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SamplingHelper_Cluster()

Member Function Documentation

◆ calculate()

◆ calculate_and_set()

◆ calculate_cluster()

◆ cluster()

◆ deta()

◆ dphi()

◆ empty()

◆ etam()

◆ etamax()

◆ etareal()

◆ max_et_cell()

◆ phim()

◆ phimax()

Member Data Documentation

◆ m_calc

◆ m_cluster

◆ m_etam

◆ m_parent

◆ m_phim

◆ m_windows