Chi2MeasurementEstimatorBase Class Reference

#include <Chi2MeasurementEstimatorBase.h>

Inheritance diagram for Chi2MeasurementEstimatorBase:

Public Member Functions
template<typename... Args>
	Chi2MeasurementEstimatorBase (double maxChi2, double nSigma, float maxDisp, Args &&... args)
	Chi2MeasurementEstimatorBase (double maxChi2, double nSigma=3., float maxDisp=std::numeric_limits< float >::max())
double	chiSquaredCut () const
bool	estimate (const TrajectoryStateOnSurface &ts, const Plane &plane) const final
std::pair< bool, double >	estimate (const TrajectoryStateOnSurface &ts, const TrackingRecHit &) const override=0
Local2DVector	maximalLocalDisplacement (const TrajectoryStateOnSurface &ts, const Plane &plane) const final
double	nSigmaCut () const
Public Member Functions inherited from MeasurementEstimator
virtual MeasurementEstimator *	clone () const =0
float	maxSagitta () const
	MeasurementEstimator ()
	MeasurementEstimator (float maxSag, float minToll, float mpt)
float	minPt2ForHitRecoveryInGluedDet () const
float	minTolerance2 () const
virtual bool	preFilter (const TrajectoryStateOnSurface &, OpaquePayload const &) const
virtual	~MeasurementEstimator ()

Protected Member Functions
std::pair< bool, double >	returnIt (double est) const

Private Attributes
const double	theMaxChi2
const float	theMaxDisplacement
const double	theNSigma

Additional Inherited Members
Public Types inherited from MeasurementEstimator
using	HitReturnType = std::pair< bool, double >
using	Local2DVector = Vector2DBase< float, LocalTag >
using	SurfaceReturnType = bool

Detailed Description

A base class for Chi2 – type of Measurement Estimators. Implements common functionality. Ported from ORCA.

Author

todorov, cerati

Definition at line 14 of file Chi2MeasurementEstimatorBase.h.

Constructor & Destructor Documentation

Chi2MeasurementEstimatorBase() [1/2]

Chi2MeasurementEstimatorBase::Chi2MeasurementEstimatorBase ( double  maxChi2, double  nSigma = 3., float  maxDisp = std::numeric_limits<float>::max()  )

inlineexplicit

Construct with cuts on chi2 and nSigma. The cut on Chi2 is used to define the acceptance of RecHits. The errors of the trajectory state are multiplied by nSigma to define acceptance of Plane and maximalLocalDisplacement.

Definition at line 21 of file Chi2MeasurementEstimatorBase.h.

      : theMaxChi2(maxChi2), theNSigma(nSigma), theMaxDisplacement(maxDisp) {}

Chi2MeasurementEstimatorBase() [2/2]

template<typename... Args>

Chi2MeasurementEstimatorBase::Chi2MeasurementEstimatorBase ( double  maxChi2, double  nSigma, float  maxDisp, Args &&...  args  )

inline

Definition at line 27 of file Chi2MeasurementEstimatorBase.h.

      : MeasurementEstimator(args...), theMaxChi2(maxChi2), theNSigma(nSigma), theMaxDisplacement(maxDisp) {}

Member Function Documentation

chiSquaredCut()

double Chi2MeasurementEstimatorBase::chiSquaredCut ( ) const

inline

Definition at line 36 of file Chi2MeasurementEstimatorBase.h.

{ return theMaxChi2; }

References theMaxChi2.

Referenced by returnIt().

estimate() [1/2]

bool Chi2MeasurementEstimatorBase::estimate ( const TrajectoryStateOnSurface &  ts, const Plane &  plane  ) const

finalvirtual

Returns true if the TrajectoryStateOnSurface is compatible with the Plane, false otherwise. The TrajectoryStateOnSurface must be on the plane.

Implements MeasurementEstimator.

Definition at line 5 of file Chi2MeasurementEstimatorBase.cc.

                                                                                                        {
  if (ts.hasError()) {
    return plane.bounds().inside(ts.localPosition(), ts.localError().positionError(), nSigmaCut());
  } else
    return plane.bounds().inside(ts.localPosition());
}

References Surface::bounds(), TrajectoryStateOnSurface::hasError(), Bounds::inside(), TrajectoryStateOnSurface::localError(), TrajectoryStateOnSurface::localPosition(), nSigmaCut(), and LocalTrajectoryError::positionError().

estimate() [2/2]

std::pair<bool, double> Chi2MeasurementEstimatorBase::estimate ( const TrajectoryStateOnSurface &  ts, const TrackingRecHit &  hit  ) const

overridepure virtual

Returns pair( true, value) if the TrajectoryStateOnSurface is compatible with the RecHit, and pair( false, value) if it is not compatible. The TrajectoryStateOnSurface must be on the same Surface as the RecHit. For an estimator where there is no value computed, e.g. fixed window estimator, only the first(bool) part is of interest.

Implements MeasurementEstimator.

Implemented in EtaPhiEstimator, MRHChi2MeasurementEstimator, MRHChi2MeasurementEstimator, Chi2Switching1DEstimator, MuonChi2MeasurementEstimator, GsfChi2MeasurementEstimator, Chi2MeasurementEstimator, and Chi2Strip1DEstimator.

Referenced by EtaPhiEstimator::estimate().

maximalLocalDisplacement()

MeasurementEstimator::Local2DVector Chi2MeasurementEstimatorBase::maximalLocalDisplacement ( const TrajectoryStateOnSurface &  ts, const Plane &  plane  ) const

finalvirtual

Returns the size of the compatibility region around the local position of the TrajectoryStateOnSurface along the directions of local x and y axis. The TrajectoryStateOnSurface must be on the plane. This method allows to limit the search for compatible detectors or RecHits. The MeasurementEstimator should not return "true" for any RecHit or Plane which is entirely outside of the compatibility region defined by maximalLocalDisplacement().

Implements MeasurementEstimator.

Definition at line 12 of file Chi2MeasurementEstimatorBase.cc.

                                                                  {
  const float emax = theMaxDisplacement;
  if (ts.hasError()) {
    LocalError le = ts.localError().positionError();
    return Local2DVector(std::min(emax, std::sqrt(float(le.xx()))) * nSigmaCut(),
                         std::min(emax, std::sqrt(float(le.yy()))) * nSigmaCut());
  } else
    return Local2DVector(emax, emax);
}

References TrajectoryStateOnSurface::hasError(), TrajectoryStateOnSurface::localError(), min(), nSigmaCut(), LocalTrajectoryError::positionError(), mathSSE::sqrt(), theMaxDisplacement, LocalError::xx(), and LocalError::yy().

nSigmaCut()

double Chi2MeasurementEstimatorBase::nSigmaCut ( ) const

inline

Definition at line 37 of file Chi2MeasurementEstimatorBase.h.

{ return theNSigma; }

References theNSigma.

Referenced by estimate(), and maximalLocalDisplacement().

returnIt()

std::pair<bool, double> Chi2MeasurementEstimatorBase::returnIt ( double  est ) const

inlineprotected

Definition at line 40 of file Chi2MeasurementEstimatorBase.h.

                                                   {
    return est > chiSquaredCut() ? HitReturnType(false, est) : HitReturnType(true, est);
  }

References chiSquaredCut().

Referenced by Chi2MeasurementEstimator::estimate(), MRHChi2MeasurementEstimator::estimate(), and GsfChi2MeasurementEstimator::estimate().

Member Data Documentation

theMaxChi2

const double Chi2MeasurementEstimatorBase::theMaxChi2

private

Definition at line 45 of file Chi2MeasurementEstimatorBase.h.

Referenced by chiSquaredCut().

theMaxDisplacement

const float Chi2MeasurementEstimatorBase::theMaxDisplacement

private

Definition at line 47 of file Chi2MeasurementEstimatorBase.h.

Referenced by maximalLocalDisplacement().

theNSigma

const double Chi2MeasurementEstimatorBase::theNSigma

private

Definition at line 46 of file Chi2MeasurementEstimatorBase.h.

Referenced by nSigmaCut().