TrajectoryStateClosestToPoint Class Reference

#include <TrajectoryStateClosestToPoint.h>

Public Member Functions
void	calculateFTS () const
TrackCharge	charge () const
bool	hasError () const
bool	isValid () const
GlobalVector	momentum () const
const PerigeeTrajectoryError &	perigeeError () const
const PerigeeTrajectoryParameters &	perigeeParameters () const
GlobalPoint	position () const
double	pt () const
const GlobalPoint &	referencePoint () const
const FreeTrajectoryState &	theState () const
	TrajectoryStateClosestToPoint ()
	parameter dimension More...
	TrajectoryStateClosestToPoint (const PerigeeTrajectoryParameters &perigeeParameters, double pt, const GlobalPoint &referencePoint, const MagneticField *field)
	TrajectoryStateClosestToPoint (const PerigeeTrajectoryParameters &perigeeParameters, double pt, const PerigeeTrajectoryError &perigeeError, const GlobalPoint &referencePoint, const MagneticField *field)
	TrajectoryStateClosestToPoint (const FTS &originalFTS, const GlobalPoint &referencePoint)

Private Types
typedef FreeTrajectoryState	FTS
typedef TrajectoryStateOnSurface	TSOS

Private Attributes
bool	errorIsAvailable
const MagneticField *	theField
FTS	theFTS
bool	theFTSavailable
PerigeeTrajectoryParameters	theParameters
PerigeeTrajectoryError	thePerigeeError
double	thePt
GlobalPoint	theRefPoint
bool	valid

Friends
class	TrajectoryStateClosestToPointBuilder

Detailed Description

Trajectory state defined at a given point on the helix, which is the point of closest approach to the reference point. In addition to the FreeTrajectoryState at that point, it also gives the perigee parameters. This state can also be invalid, e.g. in case the propagation was not successful.

Definition at line 18 of file TrajectoryStateClosestToPoint.h.

Member Typedef Documentation

typedef FreeTrajectoryState TrajectoryStateClosestToPoint::FTS

private

Definition at line 21 of file TrajectoryStateClosestToPoint.h.

typedef TrajectoryStateOnSurface TrajectoryStateClosestToPoint::TSOS

private

Definition at line 20 of file TrajectoryStateClosestToPoint.h.

Constructor & Destructor Documentation

TrajectoryStateClosestToPoint::TrajectoryStateClosestToPoint ( )

inline

parameter dimension

Definition at line 26 of file TrajectoryStateClosestToPoint.h.

                                 :
    valid(false), theFTSavailable(false), errorIsAvailable(false) {}

TrajectoryStateClosestToPoint::TrajectoryStateClosestToPoint ( const PerigeeTrajectoryParameters &  perigeeParameters, double  pt, const GlobalPoint &  referencePoint, const MagneticField *  field  )

inline

Public constructor, which is used to convert perigee parameters to a FreeTrajectoryState. For the case where no error is provided.

Definition at line 34 of file TrajectoryStateClosestToPoint.h.

                                                                              :
    theField(field), theRefPoint(referencePoint), 
    theParameters(perigeeParameters), thePt( pt ), 
    valid(true),  theFTSavailable(false), errorIsAvailable(false)
  {}

TrajectoryStateClosestToPoint::TrajectoryStateClosestToPoint ( const PerigeeTrajectoryParameters &  perigeeParameters, double  pt, const PerigeeTrajectoryError &  perigeeError, const GlobalPoint &  referencePoint, const MagneticField *  field  )

inline

Public constructor, which is used to convert perigee parameters to a FreeTrajectoryState. For the case where an error is provided.

Definition at line 46 of file TrajectoryStateClosestToPoint.h.

                                           :
    theField(field),  theRefPoint(referencePoint),
    theParameters(perigeeParameters), thePt( pt ), thePerigeeError(perigeeError),
    valid(true), theFTSavailable(false), errorIsAvailable(true){}

TrajectoryStateClosestToPoint::TrajectoryStateClosestToPoint	(	const FTS &	originalFTS,
		const GlobalPoint &	referencePoint
	)

Use the appropriate TrajectoryStateClosestToPointBuilder to get access to this constructor

Definition at line 7 of file TrajectoryStateClosestToPoint.cc.

References cms::Exception::category(), errorIsAvailable, cms::Exception::explainSelf(), PerigeeConversions::ftsToPerigeeError(), PerigeeConversions::ftsToPerigeeParameters(), FreeTrajectoryState::hasError(), GlobalTrajectoryParameters::magneticField(), FreeTrajectoryState::parameters(), theField, theFTS, theParameters, thePerigeeError, thePt, and valid.

                                                                                         :
  theFTS(originalFTS), theRefPoint(referencePoint),valid(true), theFTSavailable(true) {
  try {
    theParameters = PerigeeConversions::ftsToPerigeeParameters(originalFTS, referencePoint, thePt);
    if (theFTS.hasError()) {
      thePerigeeError = PerigeeConversions::ftsToPerigeeError(originalFTS);
      errorIsAvailable = true;
    } 
    else {
      errorIsAvailable = false;
    }
    theField = &(originalFTS.parameters().magneticField());
  } catch (const cms::Exception &ex) {
    if (ex.category() != "PerigeeConversions") throw;
    edm::LogWarning("TrajectoryStateClosestToPoint_PerigeeConversions") << "Caught exception " << ex.explainSelf() << ".\n";
    valid = false;
  }
}

Member Function Documentation

void TrajectoryStateClosestToPoint::calculateFTS

(

)

const

Definition at line 28 of file TrajectoryStateClosestToPoint.cc.

References PerigeeTrajectoryParameters::charge(), PerigeeConversions::curvilinearError(), errorIsAvailable, isValid(), PerigeeConversions::momentumFromPerigee(), PerigeeConversions::positionFromPerigee(), theField, theFTS, theFTSavailable, theParameters, thePerigeeError, thePt, and theRefPoint.

Referenced by theState().

                                                       {
  if(!isValid()) throw TrajectoryStateException("TrajectoryStateClosestToPoint is invalid and cannot return any parameters");
  GlobalTrajectoryParameters gtp(
                 PerigeeConversions::positionFromPerigee(theParameters, theRefPoint),
                 PerigeeConversions::momentumFromPerigee(theParameters, thePt, theRefPoint),
                 theParameters.charge(), theField);
  if (errorIsAvailable) {
    theFTS = FTS(gtp, PerigeeConversions::curvilinearError(thePerigeeError, gtp));
  } else {
    theFTS = FTS(gtp);
  }
  theFTSavailable = true;
}

TrackCharge TrajectoryStateClosestToPoint::charge ( void  ) const

inline

Definition at line 101 of file TrajectoryStateClosestToPoint.h.

References PerigeeTrajectoryParameters::charge(), and theParameters.

Referenced by PhysicsObjectsMonitor::analyze(), and TestOutliers::analyze().

                             {
    return theParameters.charge();
  }

bool TrajectoryStateClosestToPoint::hasError ( void  ) const

inline

tells whether the error of the perigee parameters is available.

Definition at line 116 of file TrajectoryStateClosestToPoint.h.

References errorIsAvailable.

Referenced by HLTMuon::analyze(), and MatcherUsingTracksAlgorithm::getChi2().

                        {
    return errorIsAvailable;
  }

bool TrajectoryStateClosestToPoint::isValid ( void  ) const

inline

Tells whether the state is valid or not

Definition at line 123 of file TrajectoryStateClosestToPoint.h.

References valid.

Referenced by HLTMuon::analyze(), calculateFTS(), V0Fitter::fitAll(), HLTMuonTrackMassFilter::hltFilter(), HLTMuonDimuonL3Filter::hltFilter(), HLTMuonTrimuonL3Filter::hltFilter(), reco::modules::DuplicateTrackMerger::produce(), and MuonUpdatorAtVertex::propagateToNominalLine().

                       {
    return valid;
  }

GlobalVector TrajectoryStateClosestToPoint::momentum ( ) const

inline

Definition at line 96 of file TrajectoryStateClosestToPoint.h.

References PerigeeConversions::momentumFromPerigee(), theParameters, thePt, and theRefPoint.

Referenced by PhysicsObjectsMonitor::analyze(), V0Fitter::fitAll(), MatcherUsingTracksAlgorithm::matchWithPropagation(), and reco::modules::DuplicateTrackMerger::produce().

                                {
    return PerigeeConversions::momentumFromPerigee(theParameters, thePt, theRefPoint);
  }

const PerigeeTrajectoryError& TrajectoryStateClosestToPoint::perigeeError ( ) const

inline

returns the error of the perigee parameters if it is available

Definition at line 83 of file TrajectoryStateClosestToPoint.h.

References thePerigeeError.

Referenced by HLTMuon::analyze(), PerigeeRefittedTrackState::covariance(), tauImpactParameter::ParticleBuilder::createTrackParticle(), VertexFitterResult::fill(), MatcherUsingTracksAlgorithm::getChi2(), AddTvTrack::getSecondaryVertices(), and PFTauTransverseImpactParameters::produce().

                                                      {
    return thePerigeeError;
  }

const PerigeeTrajectoryParameters& TrajectoryStateClosestToPoint::perigeeParameters ( ) const

inline

returns the perigee parameters at the p.c.a. to the reference point.

Definition at line 68 of file TrajectoryStateClosestToPoint.h.

References theParameters.

Referenced by HLTMuon::analyze(), tauImpactParameter::ParticleBuilder::createTrackParticle(), MatcherUsingTracksAlgorithm::getChi2(), AddTvTrack::getSecondaryVertices(), PerigeeRefittedTrackState::parameters(), and PFTauTransverseImpactParameters::produce().

                                                                {
     return theParameters;
  }

GlobalPoint TrajectoryStateClosestToPoint::position ( ) const

inline

returns the state defined at the point of closest approach to the reference point.

Definition at line 91 of file TrajectoryStateClosestToPoint.h.

References PerigeeConversions::positionFromPerigee(), theParameters, and theRefPoint.

Referenced by compEcalEnergySum(), compHcalEnergySum(), tauImpactParameter::ParticleBuilder::createTrackParticle(), MatcherUsingTracksAlgorithm::matchWithPropagation(), and PFTauTransverseImpactParameters::produce().

                               {
     return PerigeeConversions::positionFromPerigee(theParameters, theRefPoint);
  }

double TrajectoryStateClosestToPoint::pt ( ) const

inline

returns the transverse momentum magnitude

Definition at line 75 of file TrajectoryStateClosestToPoint.h.

References thePt.

Referenced by reco::modules::DuplicateTrackMerger::produce().

                    {
    return thePt;
  }

const GlobalPoint& TrajectoryStateClosestToPoint::referencePoint ( ) const

inline

returns the reference point which used to construct the state. It is thus the point with respect to which the impact parameters are defined.

Definition at line 59 of file TrajectoryStateClosestToPoint.h.

References theRefPoint.

Referenced by MatcherUsingTracksAlgorithm::getChi2(), and PerigeeRefittedTrackState::position().

                                             {
    return theRefPoint;
  }

const FreeTrajectoryState& TrajectoryStateClosestToPoint::theState ( ) const

inline

Definition at line 106 of file TrajectoryStateClosestToPoint.h.

References calculateFTS(), theFTS, and theFTSavailable.

Referenced by PhysicsObjectsMonitor::analyze(), ValidationMisalignedTracker::analyze(), TestOutliers::analyze(), HLTMuon::analyze(), pat::LeptonVertexSignificance::calculate(), V0Fitter::fitAll(), PerigeeRefittedTrackState::freeTrajectoryState(), HLTMuonTrackMassFilter::hltFilter(), HLTMuonDimuonL3Filter::hltFilter(), HLTMuonTrimuonL3Filter::hltFilter(), TransientTrackKinematicStateBuilder::operator()(), KinematicParticleFactoryFromTransientTrack::particle(), reco::modules::DuplicateTrackMerger::produce(), MuonUpdatorAtVertex::propagateToNominalLine(), TrackClassifier::reconstructionInformation(), and PerigeeRefittedTrackState::trajectoryStateOnSurface().

                                               {
    if (!theFTSavailable) calculateFTS();
    return theFTS;
  }

Friends And Related Function Documentation

friend class TrajectoryStateClosestToPointBuilder

friend

Definition at line 129 of file TrajectoryStateClosestToPoint.h.

Member Data Documentation

bool TrajectoryStateClosestToPoint::errorIsAvailable

private

Definition at line 152 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), hasError(), and TrajectoryStateClosestToPoint().

const MagneticField* TrajectoryStateClosestToPoint::theField

private

Definition at line 142 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), and TrajectoryStateClosestToPoint().

FTS TrajectoryStateClosestToPoint::theFTS

mutableprivate

Definition at line 144 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), theState(), and TrajectoryStateClosestToPoint().

bool TrajectoryStateClosestToPoint::theFTSavailable

mutableprivate

Definition at line 151 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), and theState().

PerigeeTrajectoryParameters TrajectoryStateClosestToPoint::theParameters

private

Definition at line 147 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), charge(), momentum(), perigeeParameters(), position(), and TrajectoryStateClosestToPoint().

PerigeeTrajectoryError TrajectoryStateClosestToPoint::thePerigeeError

private

Definition at line 149 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), perigeeError(), and TrajectoryStateClosestToPoint().

double TrajectoryStateClosestToPoint::thePt

private

Definition at line 148 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), momentum(), pt(), and TrajectoryStateClosestToPoint().

GlobalPoint TrajectoryStateClosestToPoint::theRefPoint

private

Definition at line 146 of file TrajectoryStateClosestToPoint.h.

Referenced by calculateFTS(), momentum(), position(), and referencePoint().

bool TrajectoryStateClosestToPoint::valid

private

Definition at line 150 of file TrajectoryStateClosestToPoint.h.

Referenced by isValid(), and TrajectoryStateClosestToPoint().