SteppingHelixStateInfo Class Reference

#include <SteppingHelixStateInfo.h>

Classes
struct	VolumeBounds

Public Types
typedef CLHEP::Hep3Vector	Point
enum	Result {   OK = 0, FAULT, APPROX, RANGEOUT,   INACC, NOT_IMPLEMENTED, WRONG_VOLUME, UNDEFINED,   MAX_RESULT }
typedef CLHEP::Hep3Vector	Vector

Public Member Functions
int	charge () const
void	getFreeState (FreeTrajectoryState &fts) const
	convert internal structure into the fts More...
TrajectoryStateOnSurface	getStateOnSurface (const Surface &surf, bool returnTangentPlane=false) const
bool	hasErrorPropagated () const
bool	isValid () const
GlobalVector	momentum () const
double	path () const
GlobalPoint	position () const
double	radPath () const
Result	status () const
	SteppingHelixStateInfo ()
	SteppingHelixStateInfo (const FreeTrajectoryState &fts)

Static Public Attributes
static const std::string	ResultName [MAX_RESULT]

Protected Attributes
Vector	bf
Vector	bfGradLoc
AlgebraicSymMatrix55	covCurv
double	dEdx
double	dEdXPrime
double	dir
const MagneticField *	field
bool	hasErrorPropagated_
bool	isComplete
bool	isValid_
bool	isYokeVol
const MagVolume *	magVol
AlgebraicSymMatrix55	matDCovCurv
Vector	p3
double	path_
int	q
Point	r3
double	radPath_
double	radX0
VolumeBounds	rzLims
Result	status_

Friends
class	SteppingHelixPropagator

Detailed Description

Holder of SteppingHelixState information

Author

Vyacheslav Krutelyov (slava77)

Implementation part of the stepping helix propagator state data structure

Author

Vyacheslav Krutelyov (slava77)

Definition at line 27 of file SteppingHelixStateInfo.h.

Member Typedef Documentation

Point

typedef CLHEP::Hep3Vector SteppingHelixStateInfo::Point

Definition at line 32 of file SteppingHelixStateInfo.h.

Vector

typedef CLHEP::Hep3Vector SteppingHelixStateInfo::Vector

Definition at line 31 of file SteppingHelixStateInfo.h.

Member Enumeration Documentation

Result

enum SteppingHelixStateInfo::Result

Enumerator
OK
FAULT
APPROX
RANGEOUT
INACC
NOT_IMPLEMENTED
WRONG_VOLUME
UNDEFINED
MAX_RESULT

Definition at line 34 of file SteppingHelixStateInfo.h.

{ OK = 0, FAULT, APPROX, RANGEOUT, INACC, NOT_IMPLEMENTED, WRONG_VOLUME, UNDEFINED, MAX_RESULT };

Constructor & Destructor Documentation

SteppingHelixStateInfo() [1/2]

SteppingHelixStateInfo::SteppingHelixStateInfo ( )

inline

Definition at line 38 of file SteppingHelixStateInfo.h.

      : path_(0),
        radPath_(0),
        dir(0),
        magVol(nullptr),
        isYokeVol(false),
        field(nullptr),
        dEdx(0),
        dEdXPrime(0),
        radX0(1e12),
        isComplete(false),
        isValid_(false),
        hasErrorPropagated_(false),
        status_(UNDEFINED) {}

SteppingHelixStateInfo() [2/2]

SteppingHelixStateInfo::SteppingHelixStateInfo

(

const FreeTrajectoryState &

fts

)

Definition at line 27 of file SteppingHelixStateInfo.cc.

References FreeTrajectoryState::charge(), covCurv, FreeTrajectoryState::curvilinearError(), FreeTrajectoryState::hasError(), hasErrorPropagated_, isComplete, isValid_, LogTrace, CurvilinearTrajectoryError::matrix(), metname, FreeTrajectoryState::momentum(), p3, FreeTrajectoryState::position(), q, r3, AlCaHLTBitMon_QueryRunRegistry::string, PV3DBase< T, PVType, FrameType >::x(), PV3DBase< T, PVType, FrameType >::y(), and PV3DBase< T, PVType, FrameType >::z().

    : path_(0),
      radPath_(0),
      dir(0),
      magVol(nullptr),
      isYokeVol(false),
      field(nullptr),
      dEdx(0),
      dEdXPrime(0),
      radX0(1e12),
      status_(UNDEFINED) {
  p3.set(fts.momentum().x(), fts.momentum().y(), fts.momentum().z());
  r3.set(fts.position().x(), fts.position().y(), fts.position().z());
  q = fts.charge();

  if (fts.hasError()) {
    covCurv = fts.curvilinearError().matrix();
    hasErrorPropagated_ = true;
  } else {
    covCurv = AlgebraicSymMatrix55();
    hasErrorPropagated_ = false;
  }
  static const std::string metname = "SteppingHelixPropagator";
  if (fts.hasError()) {
    LogTrace(metname) << "Created SHPStateInfo from FTS\n" << fts;
    //    LogTrace(metname)<<"and cartesian error of\n"<<fts.cartesianError().matrix();
  } else
    LogTrace(metname) << "Created SHPStateInfo from FTS without errors";

  isComplete = false;
  isValid_ = true;
}

Member Function Documentation

charge()

int SteppingHelixStateInfo::charge ( void  ) const

inline

Definition at line 61 of file SteppingHelixStateInfo.h.

References q.

{ return q; }

getFreeState()

void SteppingHelixStateInfo::getFreeState

(

FreeTrajectoryState &

fts

)

const

convert internal structure into the fts

Definition at line 88 of file SteppingHelixStateInfo.cc.

References covCurv, field, hasErrorPropagated_, isValid(), p3, q, and r3.

Referenced by SteppingHelixPropagator::propagateWithPath().

                                                                        {
  if (isValid()) {
    GlobalVector p3GV(p3.x(), p3.y(), p3.z());
    GlobalPoint r3GP(r3.x(), r3.y(), r3.z());
    GlobalTrajectoryParameters tPars(r3GP, p3GV, q, field);
    //    CartesianTrajectoryError tCov(cov);
    //    CurvilinearTrajectoryError tCCov(ROOT::Math::Similarity(JacobianCartesianToCurvilinear(tPars).jacobian(), cov));
    CurvilinearTrajectoryError tCCov(covCurv);

    fts = (hasErrorPropagated_) ? FreeTrajectoryState(tPars, tCCov) : FreeTrajectoryState(tPars);
    //      ? FreeTrajectoryState(tPars, tCov, tCCov) : FreeTrajectoryState(tPars);
    //    if (fts.hasError()) fts.curvilinearError(); //call it so it gets created
  }
}

getStateOnSurface()

TrajectoryStateOnSurface SteppingHelixStateInfo::getStateOnSurface	(	const Surface &	surf,
		bool	returnTangentPlane = false
	)		const

Definition at line 60 of file SteppingHelixStateInfo.cc.

References SurfaceSideDefinition::afterSurface, SurfaceSideDefinition::atCenterOfSurface, SurfaceSideDefinition::beforeSurface, covCurv, dir, field, hasErrorPropagated_, isValid(), LogTrace, metname, p3, FreeTrajectoryState::position(), q, r3, HLT_2022v14_cff::returnTangentPlane, AlCaHLTBitMon_QueryRunRegistry::string, and Surface::tangentPlane().

Referenced by CaloDetIdAssociator::crossedElement(), MuonSimHitProducer::produce(), and SteppingHelixPropagator::propagateWithPath().

                                                                                                                     {
  static const std::string metname = "SteppingHelixPropagator";
  if (!isValid())
    LogTrace(metname) << "Return TSOS is invalid";
  else
    LogTrace(metname) << "Return TSOS is valid";
  if (!isValid())
    return TrajectoryStateOnSurface();
  GlobalVector p3GV(p3.x(), p3.y(), p3.z());
  GlobalPoint r3GP(r3.x(), r3.y(), r3.z());
  GlobalTrajectoryParameters tPars(r3GP, p3GV, q, field);
  //  CartesianTrajectoryError tCov(cov);

  //  CurvilinearTrajectoryError tCCov(ROOT::Math::Similarity(JacobianCartesianToCurvilinear(tPars).jacobian(), cov));
  CurvilinearTrajectoryError tCCov(covCurv);

  FreeTrajectoryState fts(tPars, tCCov);
  if (!hasErrorPropagated_)
    fts = FreeTrajectoryState(tPars);

  SurfaceSideDefinition::SurfaceSide side = SurfaceSideDefinition::atCenterOfSurface;
  if (dir > 0)
    side = SurfaceSideDefinition::beforeSurface;
  if (dir < 0)
    side = SurfaceSideDefinition::afterSurface;
  return TrajectoryStateOnSurface(fts, returnTangentPlane ? *surf.tangentPlane(fts.position()) : surf, side);
}

hasErrorPropagated()

bool SteppingHelixStateInfo::hasErrorPropagated ( ) const

inline

Definition at line 66 of file SteppingHelixStateInfo.h.

References hasErrorPropagated_.

{ return hasErrorPropagated_; }

isValid()

bool SteppingHelixStateInfo::isValid ( void  ) const

inline

Definition at line 65 of file SteppingHelixStateInfo.h.

References isValid_.

Referenced by ntupleDataFormat._Object::_checkIsValid(), AlCaHOCalibProducer::fillHOStore(), getFreeState(), getStateOnSurface(), TrackDetectorAssociator::getTAMuonChamberMatches(), CachedTrajectory::getTrajectory(), SteppingHelixPropagator::propagate(), CachedTrajectory::propagateAll(), core.AutoHandle.AutoHandle::ReallyLoad(), and CachedTrajectory::trajectoryDelta().

{ return isValid_; }

momentum()

GlobalVector SteppingHelixStateInfo::momentum ( ) const

inline

Definition at line 60 of file SteppingHelixStateInfo.h.

References p3.

Referenced by TrackDetectorAssociator::associate(), AlCaHOCalibProducer::fillHOStore(), TrackDetectorAssociator::getTAMuonChamberMatches(), CachedTrajectory::getTrajectory(), and CachedTrajectory::trajectoryDelta().

{ return GlobalVector(p3.x(), p3.y(), p3.z()); }

path()

double SteppingHelixStateInfo::path ( ) const

inline

Definition at line 62 of file SteppingHelixStateInfo.h.

References isValid_, and path_.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), SteppingHelixPropagator::makeAtomStep(), MuonSimHitProducer::produce(), SteppingHelixPropagator::propagate(), and SteppingHelixPropagator::propagateWithPath().

{ return isValid_ ? path_ : 0; }

position()

GlobalPoint SteppingHelixStateInfo::position ( ) const

inline

Definition at line 59 of file SteppingHelixStateInfo.h.

References r3.

Referenced by AlCaHOCalibProducer::fillHOStore(), TrackDetectorAssociator::getTAMuonChamberMatches(), CachedTrajectory::getTrajectory(), and CachedTrajectory::propagateAll().

{ return GlobalPoint(r3.x(), r3.y(), r3.z()); }

radPath()

double SteppingHelixStateInfo::radPath ( ) const

inline

Definition at line 63 of file SteppingHelixStateInfo.h.

References isValid_, and radPath_.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), SteppingHelixPropagator::makeAtomStep(), and MuonSimHitProducer::produce().

{ return isValid_ ? radPath_ : 0; }

status()

Result SteppingHelixStateInfo::status ( void  ) const

inline

Definition at line 68 of file SteppingHelixStateInfo.h.

References status_.

{ return status_; }

Friends And Related Function Documentation

SteppingHelixPropagator

friend class SteppingHelixPropagator

friend

Definition at line 28 of file SteppingHelixStateInfo.h.

Member Data Documentation

bf

Vector SteppingHelixStateInfo::bf

protected

Definition at line 92 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), and SteppingHelixPropagator::makeAtomStep().

bfGradLoc

Vector SteppingHelixStateInfo::bfGradLoc

protected

Definition at line 93 of file SteppingHelixStateInfo.h.

covCurv

AlgebraicSymMatrix55 SteppingHelixStateInfo::covCurv

protected

Definition at line 87 of file SteppingHelixStateInfo.h.

Referenced by getFreeState(), SteppingHelixPropagator::getNextState(), getStateOnSurface(), SteppingHelixPropagator::loadState(), SteppingHelixPropagator::setIState(), and SteppingHelixStateInfo().

dEdx

double SteppingHelixStateInfo::dEdx

protected

Definition at line 99 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), SteppingHelixPropagator::makeAtomStep(), and SteppingHelixPropagator::propagate().

dEdXPrime

double SteppingHelixStateInfo::dEdXPrime

protected

Definition at line 100 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), and SteppingHelixPropagator::makeAtomStep().

dir

double SteppingHelixStateInfo::dir

protected

Definition at line 91 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), getStateOnSurface(), SteppingHelixPropagator::loadState(), and Inspector.Inspector::Loop().

field

const MagneticField* SteppingHelixStateInfo::field

protected

Definition at line 96 of file SteppingHelixStateInfo.h.

Referenced by getFreeState(), getStateOnSurface(), and SteppingHelixPropagator::propagate().

hasErrorPropagated_

bool SteppingHelixStateInfo::hasErrorPropagated_

protected

Definition at line 105 of file SteppingHelixStateInfo.h.

Referenced by getFreeState(), SteppingHelixPropagator::getNextState(), getStateOnSurface(), hasErrorPropagated(), SteppingHelixPropagator::makeAtomStep(), SteppingHelixPropagator::setIState(), and SteppingHelixStateInfo().

isComplete

bool SteppingHelixStateInfo::isComplete

protected

Definition at line 103 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::loadState(), SteppingHelixPropagator::setIState(), and SteppingHelixStateInfo().

isValid_

bool SteppingHelixStateInfo::isValid_

protected

Definition at line 104 of file SteppingHelixStateInfo.h.

Referenced by isValid(), SteppingHelixPropagator::loadState(), path(), SteppingHelixPropagator::propagate(), radPath(), and SteppingHelixStateInfo().

isYokeVol

bool SteppingHelixStateInfo::isYokeVol

protected

Definition at line 95 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), and SteppingHelixPropagator::makeAtomStep().

magVol

const MagVolume* SteppingHelixStateInfo::magVol

protected

Definition at line 94 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), and SteppingHelixPropagator::makeAtomStep().

matDCovCurv

AlgebraicSymMatrix55 SteppingHelixStateInfo::matDCovCurv

protected

Definition at line 88 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), and SteppingHelixPropagator::makeAtomStep().

p3

Vector SteppingHelixStateInfo::p3

protected

Definition at line 85 of file SteppingHelixStateInfo.h.

Referenced by getFreeState(), SteppingHelixPropagator::getNextState(), getStateOnSurface(), SteppingHelixPropagator::loadState(), SteppingHelixPropagator::makeAtomStep(), momentum(), SteppingHelixPropagator::propagate(), SteppingHelixPropagator::setIState(), and SteppingHelixStateInfo().

path_

double SteppingHelixStateInfo::path_

protected

Definition at line 89 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), and path().

q

int SteppingHelixStateInfo::q

protected

Definition at line 84 of file SteppingHelixStateInfo.h.

Referenced by charge(), getFreeState(), SteppingHelixPropagator::getNextState(), getStateOnSurface(), SteppingHelixPropagator::loadState(), SteppingHelixPropagator::makeAtomStep(), SteppingHelixPropagator::setIState(), and SteppingHelixStateInfo().

r3

Point SteppingHelixStateInfo::r3

protected

Definition at line 86 of file SteppingHelixStateInfo.h.

Referenced by getFreeState(), SteppingHelixPropagator::getNextState(), getStateOnSurface(), SteppingHelixPropagator::loadState(), SteppingHelixPropagator::makeAtomStep(), position(), SteppingHelixPropagator::propagate(), SteppingHelixPropagator::setIState(), and SteppingHelixStateInfo().

radPath_

double SteppingHelixStateInfo::radPath_

protected

Definition at line 90 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), and radPath().

radX0

double SteppingHelixStateInfo::radX0

protected

Definition at line 101 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), SteppingHelixPropagator::loadState(), and SteppingHelixPropagator::makeAtomStep().

ResultName

const std::string SteppingHelixStateInfo::ResultName

static

Initial value:

= {
    "RESULT_OK", "RESULT_FAULT", "RESULT_RANGEOUT", "RESULT_INACC", "RESULT_NOT_IMPLEMENTED", "RESULT_UNDEFINED"}

Definition at line 36 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::propagate().

rzLims

VolumeBounds SteppingHelixStateInfo::rzLims

protected

Definition at line 98 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::getNextState(), and SteppingHelixPropagator::loadState().

status_

Result SteppingHelixStateInfo::status_

protected

Definition at line 107 of file SteppingHelixStateInfo.h.

Referenced by SteppingHelixPropagator::propagate(), and status().