hltriggeroffline::PropagateToMuon Class Reference

#include <PropagateToMuon.h>

Public Types
using	ESTokens = std::tuple< edm::ESGetToken< MagneticField, IdealMagneticFieldRecord >, edm::ESGetToken< Propagator, TrackingComponentsRecord >, edm::ESGetToken< Propagator, TrackingComponentsRecord >, edm::ESGetToken< Propagator, TrackingComponentsRecord >, edm::ESGetToken< MuonDetLayerGeometry, MuonRecoGeometryRecord >>

Public Member Functions
TrajectoryStateOnSurface	extrapolate (const reco::Track &tk) const
TrajectoryStateOnSurface	extrapolate (const reco::Candidate &tk) const
TrajectoryStateOnSurface	extrapolate (const FreeTrajectoryState &state) const
void	init (const edm::EventSetup &iSetup)
	PropagateToMuon (const edm::ParameterSet &iConfig, const ESTokens &)
	~PropagateToMuon ()

Static Public Member Functions
static ESTokens	getESTokens (edm::ConsumesCollector)

Private Types
enum	WhichState { AtVertex, Innermost, Outermost }
enum	WhichTrack { None, TrackerTk, MuonTk, GlobalTk }

Private Member Functions
TrajectoryStateOnSurface	getBestDet (const TrajectoryStateOnSurface &tsos, const DetLayer *station) const
FreeTrajectoryState	startingState (const reco::Candidate &reco) const
	Starting state for the propagation. More...
FreeTrajectoryState	startingState (const reco::Track &tk) const
	Starting state for the propagation. More...

Private Attributes
const BoundCylinder *	barrelCylinder_
double	barrelHalfLength_
bool	cosmicPropagation_
const BoundDisk *	endcapDiskNeg_
const BoundDisk *	endcapDiskPos_
std::pair< float, float >	endcapRadii_
edm::ESHandle< MagneticField >	magfield_
edm::ESGetToken< MagneticField, IdealMagneticFieldRecord >	magfieldToken_
edm::ESHandle < MuonDetLayerGeometry >	muonGeometry_
edm::ESGetToken < MuonDetLayerGeometry, MuonRecoGeometryRecord >	muonGeometryToken_
edm::ESHandle< Propagator >	propagator_
edm::ESHandle< Propagator >	propagatorAny_
edm::ESGetToken< Propagator, TrackingComponentsRecord >	propagatorAnyToken_
edm::ESHandle< Propagator >	propagatorOpposite_
edm::ESGetToken< Propagator, TrackingComponentsRecord >	propagatorOppositeToken_
edm::ESGetToken< Propagator, TrackingComponentsRecord >	propagatorToken_
bool	useSimpleGeometry_
	Labels for input collections. More...
WhichState	whichState_
WhichTrack	whichTrack_

Detailed Description

Definition at line 38 of file PropagateToMuon.h.

Member Typedef Documentation

using hltriggeroffline::PropagateToMuon::ESTokens = std::tuple<edm::ESGetToken<MagneticField, IdealMagneticFieldRecord>, edm::ESGetToken<Propagator, TrackingComponentsRecord>, edm::ESGetToken<Propagator, TrackingComponentsRecord>, edm::ESGetToken<Propagator, TrackingComponentsRecord>, edm::ESGetToken<MuonDetLayerGeometry, MuonRecoGeometryRecord>>

Definition at line 44 of file PropagateToMuon.h.

Member Enumeration Documentation

enum hltriggeroffline::PropagateToMuon::WhichState

private

Enumerator
AtVertex
Innermost
Outermost

Definition at line 69 of file PropagateToMuon.h.

{ AtVertex, Innermost, Outermost };

enum hltriggeroffline::PropagateToMuon::WhichTrack

private

Enumerator
None
TrackerTk
MuonTk
GlobalTk

Definition at line 68 of file PropagateToMuon.h.

{ None, TrackerTk, MuonTk, GlobalTk };

Constructor & Destructor Documentation

PropagateToMuon::PropagateToMuon ( const edm::ParameterSet &  iConfig, const ESTokens &  iTokens  )

explicit

Definition at line 33 of file PropagateToMuon.cc.

References AtVertex, cosmicPropagation_, Exception, edm::ParameterSet::getParameter(), GlobalTk, Innermost, MuonTk, None, Outermost, AlCaHLTBitMon_QueryRunRegistry::string, TrackerTk, whichState_, and whichTrack_.

    : useSimpleGeometry_(iConfig.getParameter<bool>("useSimpleGeometry")),
      whichTrack_(None),
      whichState_(AtVertex),
      cosmicPropagation_(iConfig.existsAs<bool>("cosmicPropagationHypothesis")
                             ? iConfig.getParameter<bool>("cosmicPropagationHypothesis")
                             : false),
      magfieldToken_(std::get<0>(iTokens)),
      propagatorToken_(std::get<1>(iTokens)),
      propagatorAnyToken_(std::get<2>(iTokens)),
      propagatorOppositeToken_(std::get<3>(iTokens)),
      muonGeometryToken_(std::get<4>(iTokens)) {
  std::string whichTrack = iConfig.getParameter<std::string>("useTrack");
  if (whichTrack == "none") {
    whichTrack_ = None;
  } else if (whichTrack == "tracker") {
    whichTrack_ = TrackerTk;
  } else if (whichTrack == "muon") {
    whichTrack_ = MuonTk;
  } else if (whichTrack == "global") {
    whichTrack_ = GlobalTk;
  } else
    throw cms::Exception("Configuration") << "Parameter 'useTrack' must be 'none', 'tracker', 'muon', 'global'\n";
  if (whichTrack_ != None) {
    std::string whichState = iConfig.getParameter<std::string>("useState");
    if (whichState == "atVertex") {
      whichState_ = AtVertex;
    } else if (whichState == "innermost") {
      whichState_ = Innermost;
    } else if (whichState == "outermost") {
      whichState_ = Outermost;
    } else
      throw cms::Exception("Configuration") << "Parameter 'useState' must be 'atVertex', 'innermost', "
                                               "'outermost'\n";
  }
  if (cosmicPropagation_ && (whichTrack_ == None || whichState_ == AtVertex)) {
    throw cms::Exception("Configuration") << "When using 'cosmicPropagationHypothesis' useTrack must not be "
                                             "'none', and the state must not be 'atVertex'\n";
  }
}

PropagateToMuon::~PropagateToMuon

(

)

Definition at line 74 of file PropagateToMuon.cc.

{}

Member Function Documentation

TrajectoryStateOnSurface hltriggeroffline::PropagateToMuon::extrapolate ( const reco::Track &  tk ) const

inline

Extrapolate reco::Track to the muon station 2, return an invalid TSOS if it fails

Definition at line 57 of file PropagateToMuon.h.

References extrapolate(), and startingState().

Referenced by hltriggeroffline::L1MuonMatcherAlgo::extrapolate(), and extrapolate().

{ return extrapolate(startingState(tk)); }

TrajectoryStateOnSurface hltriggeroffline::PropagateToMuon::extrapolate ( const reco::Candidate &  tk ) const

inline

Extrapolate reco::Candidate to the muon station 2, return an invalid TSOS if it fails

Definition at line 61 of file PropagateToMuon.h.

References extrapolate(), and startingState().

Referenced by extrapolate().

{ return extrapolate(startingState(tk)); }

TrajectoryStateOnSurface PropagateToMuon::extrapolate

(

const FreeTrajectoryState &

state

)

const

Extrapolate a FreeTrajectoryState to the muon station 2, return an invalid TSOS if it fails

Definition at line 156 of file PropagateToMuon.cc.

References AtVertex, barrelCylinder_, barrelHalfLength_, cosmicPropagation_, Vector3DBase< T, FrameTag >::dot(), endcapDiskNeg_, endcapDiskPos_, endcapRadii_, PVValHelper::eta, PV3DBase< T, PVType, FrameType >::eta(), getBestDet(), TrajectoryStateOnSurface::globalPosition(), sistrip::SpyUtilities::isValid(), TrajectoryStateOnSurface::isValid(), PV3DBase< T, PVType, FrameType >::mag(), FreeTrajectoryState::momentum(), muonGeometry_, PV3DBase< T, PVType, FrameType >::perp(), FreeTrajectoryState::position(), Propagator::propagate(), propagator_, propagatorOpposite_, useSimpleGeometry_, whichState_, PV3DBase< T, PVType, FrameType >::x(), PV3DBase< T, PVType, FrameType >::y(), and PV3DBase< T, PVType, FrameType >::z().

                                                                                            {
  TrajectoryStateOnSurface final;
  if (start.momentum().mag() == 0)
    return final;
  double eta = start.momentum().eta();

  const Propagator *propagatorBarrel = &*propagator_;
  const Propagator *propagatorEndcaps = &*propagator_;

  if (whichState_ != AtVertex) {
    if (start.position().perp() > barrelCylinder_->radius())
      propagatorBarrel = &*propagatorOpposite_;
    if (fabs(start.position().z()) > endcapDiskPos_->position().z())
      propagatorEndcaps = &*propagatorOpposite_;
  }
  if (cosmicPropagation_) {
    if (start.momentum().dot(GlobalVector(start.position().x(), start.position().y(), start.position().z())) < 0) {
      // must flip the propagations
      propagatorBarrel = (propagatorBarrel == &*propagator_ ? &*propagatorOpposite_ : &*propagator_);
      propagatorEndcaps = (propagatorEndcaps == &*propagator_ ? &*propagatorOpposite_ : &*propagator_);
    }
  }

  TrajectoryStateOnSurface tsos = propagatorBarrel->propagate(start, *barrelCylinder_);
  if (tsos.isValid()) {
    if (useSimpleGeometry_) {
      if (fabs(tsos.globalPosition().z()) <= barrelHalfLength_)
        final = tsos;
    } else {
      final = getBestDet(tsos, muonGeometry_->allDTLayers()[1]);
    }
  }

  if (!final.isValid()) {
    tsos = propagatorEndcaps->propagate(start, (eta > 0 ? *endcapDiskPos_ : *endcapDiskNeg_));
    if (tsos.isValid()) {
      if (useSimpleGeometry_) {
        float rho = tsos.globalPosition().perp();
        if ((rho >= endcapRadii_.first) && (rho <= endcapRadii_.second))
          final = tsos;
      } else {
        final =
            getBestDet(tsos, (eta > 0 ? muonGeometry_->forwardCSCLayers()[2] : muonGeometry_->backwardCSCLayers()[2]));
      }
    }
  }
  return final;
}

TrajectoryStateOnSurface PropagateToMuon::getBestDet ( const TrajectoryStateOnSurface &  tsos, const DetLayer *  station  ) const

private

Get the best TSOS on one of the chambres of this DetLayer, or an invalid TSOS if none match

Definition at line 205 of file PropagateToMuon.cc.

References Chi2MeasurementEstimator_cfi::Chi2MeasurementEstimator, GeometricSearchDet::compatibleDets(), propagatorAny_, and runTheMatrix::ret.

Referenced by extrapolate().

                                                                                  {
  TrajectoryStateOnSurface ret;  // start as null
  Chi2MeasurementEstimator estimator(1e10,
                                     3.);  // require compatibility at 3 sigma
  std::vector<GeometricSearchDet::DetWithState> dets = layer->compatibleDets(tsos, *propagatorAny_, estimator);
  if (!dets.empty()) {
    ret = dets.front().second;
  }
  return ret;
}

PropagateToMuon::ESTokens PropagateToMuon::getESTokens ( edm::ConsumesCollector  iCollector )

static

Definition at line 20 of file PropagateToMuon.cc.

References edm::BeginRun, edm::ConsumesCollector::esConsumes(), and runTheMatrix::ret.

Referenced by HLTMuonPlotter::getESTokens().

                                                                                    {
  ESTokens ret;
  std::get<0>(ret) = iCollector.esConsumes<edm::Transition::BeginRun>();
  std::get<1>(ret) =
      iCollector.esConsumes<edm::Transition::BeginRun>(edm::ESInputTag("", "SteppingHelixPropagatorAlong"));
  std::get<2>(ret) =
      iCollector.esConsumes<edm::Transition::BeginRun>(edm::ESInputTag("", "SteppingHelixPropagatorAny"));
  std::get<3>(ret) =
      iCollector.esConsumes<edm::Transition::BeginRun>(edm::ESInputTag("", "SteppingHelixPropagatorOpposite"));
  std::get<4>(ret) = iCollector.esConsumes<edm::Transition::BeginRun>();
  return ret;
}

void PropagateToMuon::init

(

const edm::EventSetup &

iSetup

)

Call this method at the beginning of each run, to initialize geometry, magnetic field and propagators

Definition at line 76 of file PropagateToMuon.cc.

References barrelCylinder_, barrelHalfLength_, endcapDiskNeg_, endcapDiskPos_, endcapRadii_, Exception, edm::EventSetup::getHandle(), magfield_, magfieldToken_, muonGeometry_, muonGeometryToken_, propagator_, propagatorAny_, propagatorAnyToken_, propagatorOpposite_, propagatorOppositeToken_, propagatorToken_, and GeometricSearchDet::surface().

Referenced by hltriggeroffline::L1MuonMatcherAlgo::init().

                                                      {
  magfield_ = iSetup.getHandle(magfieldToken_);
  propagator_ = iSetup.getHandle(propagatorToken_);
  propagatorOpposite_ = iSetup.getHandle(propagatorOppositeToken_);
  propagatorAny_ = iSetup.getHandle(propagatorAnyToken_);
  muonGeometry_ = iSetup.getHandle(muonGeometryToken_);

  const DetLayer *dt2 = muonGeometry_->allDTLayers()[1];
  const DetLayer *csc2Pos = muonGeometry_->forwardCSCLayers()[2];
  const DetLayer *csc2Neg = muonGeometry_->backwardCSCLayers()[2];
  barrelCylinder_ = dynamic_cast<const BoundCylinder *>(&dt2->surface());
  endcapDiskPos_ = dynamic_cast<const BoundDisk *>(&csc2Pos->surface());
  endcapDiskNeg_ = dynamic_cast<const BoundDisk *>(&csc2Neg->surface());
  if (barrelCylinder_ == nullptr || endcapDiskPos_ == nullptr || endcapDiskNeg_ == nullptr)
    throw cms::Exception("Geometry") << "Bad muon geometry!?";
  barrelHalfLength_ = barrelCylinder_->bounds().length() / 2;
  ;
  endcapRadii_ = std::make_pair(endcapDiskPos_->innerRadius(), endcapDiskPos_->outerRadius());
  // std::cout << "L1MuonMatcher: barrel radius = " << barrelCylinder_->radius()
  // << ", half length = " << barrelHalfLength_ <<
  //             "; endcap Z = " << endcapDiskPos_->position().z() << ", radii =
  //             " << endcapRadii_.first << "," << endcapRadii_.second <<
  //             std::std::endl;
}

FreeTrajectoryState PropagateToMuon::startingState ( const reco::Candidate &  reco ) const

private

Starting state for the propagation.

Definition at line 101 of file PropagateToMuon.cc.

References reco::Candidate::charge(), reco::RecoCandidate::combinedMuon(), Exception, GlobalTk, edm::Ref< C, T, F >::isNull(), magfield_, MuonTk, None, edm::ESHandle< class >::product(), reco::Candidate::px(), reco::Candidate::py(), reco::Candidate::pz(), dt_dqm_sourceclient_common_cff::reco, runTheMatrix::ret, reco::RecoCandidate::standAloneMuon(), reco::RecoCandidate::track(), TrackerTk, reco::Candidate::vx(), reco::Candidate::vy(), reco::Candidate::vz(), and whichTrack_.

Referenced by extrapolate().

                                                                                  {
  FreeTrajectoryState ret;
  if (whichTrack_ != None) {
    const reco::RecoCandidate *rc = dynamic_cast<const reco::RecoCandidate *>(&reco);
    if (rc == nullptr)
      throw cms::Exception("Invalid Data") << "Input object is not a RecoCandidate.\n";
    reco::TrackRef tk;
    switch (whichTrack_) {
      case TrackerTk:
        tk = rc->track();
        break;
      case MuonTk:
        tk = rc->standAloneMuon();
        break;
      case GlobalTk:
        tk = rc->combinedMuon();
        break;
      default:
        break;  // just to make gcc happy
    }
    if (tk.isNull()) {
      ret = FreeTrajectoryState();
    } else {
      ret = startingState(*tk);
    }
  } else {
    ret = FreeTrajectoryState(GlobalPoint(reco.vx(), reco.vy(), reco.vz()),
                              GlobalVector(reco.px(), reco.py(), reco.pz()),
                              reco.charge(),
                              magfield_.product());
  }
  return ret;
}

FreeTrajectoryState PropagateToMuon::startingState ( const reco::Track &  tk ) const

private

Starting state for the propagation.

Definition at line 135 of file PropagateToMuon.cc.

References AtVertex, cosmicPropagation_, trajectoryStateTransform::initialFreeState(), trajectoryStateTransform::innerFreeState(), Innermost, reco::Track::innerPosition(), magfield_, trajectoryStateTransform::outerFreeState(), Outermost, reco::Track::outerPosition(), edm::ESHandle< class >::product(), and whichState_.

                                                                            {
  WhichState state = whichState_;
  if (cosmicPropagation_) {
    if (whichState_ == Innermost) {
      state = tk.innerPosition().Mag2() <= tk.outerPosition().Mag2() ? Innermost : Outermost;
    } else if (whichState_ == Outermost) {
      state = tk.innerPosition().Mag2() <= tk.outerPosition().Mag2() ? Outermost : Innermost;
    }
  }
  switch (state) {
    case Innermost:
      return trajectoryStateTransform::innerFreeState(tk, magfield_.product());
    case Outermost:
      return trajectoryStateTransform::outerFreeState(tk, magfield_.product());

    case AtVertex:
    default:
      return trajectoryStateTransform::initialFreeState(tk, magfield_.product());
  }
}

Member Data Documentation

const BoundCylinder* hltriggeroffline::PropagateToMuon::barrelCylinder_

private

Definition at line 90 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

double hltriggeroffline::PropagateToMuon::barrelHalfLength_

private

Definition at line 92 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

bool hltriggeroffline::PropagateToMuon::cosmicPropagation_

private

for cosmics, some things change: the along-opposite is not in-out, nor the innermost/outermost states are in-out really

Definition at line 78 of file PropagateToMuon.h.

Referenced by extrapolate(), PropagateToMuon(), and startingState().

const BoundDisk * hltriggeroffline::PropagateToMuon::endcapDiskNeg_

private

Definition at line 91 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

const BoundDisk* hltriggeroffline::PropagateToMuon::endcapDiskPos_

private

Definition at line 91 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

std::pair<float, float> hltriggeroffline::PropagateToMuon::endcapRadii_

private

Definition at line 93 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

edm::ESHandle<MagneticField> hltriggeroffline::PropagateToMuon::magfield_

private

Definition at line 81 of file PropagateToMuon.h.

Referenced by init(), and startingState().

edm::ESGetToken<MagneticField, IdealMagneticFieldRecord> hltriggeroffline::PropagateToMuon::magfieldToken_

private

Definition at line 85 of file PropagateToMuon.h.

Referenced by init().

edm::ESHandle<MuonDetLayerGeometry> hltriggeroffline::PropagateToMuon::muonGeometry_

private

Definition at line 83 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

edm::ESGetToken<MuonDetLayerGeometry, MuonRecoGeometryRecord> hltriggeroffline::PropagateToMuon::muonGeometryToken_

private

Definition at line 88 of file PropagateToMuon.h.

Referenced by init().

edm::ESHandle<Propagator> hltriggeroffline::PropagateToMuon::propagator_

private

Definition at line 82 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

edm::ESHandle<Propagator> hltriggeroffline::PropagateToMuon::propagatorAny_

private

Definition at line 82 of file PropagateToMuon.h.

Referenced by getBestDet(), and init().

edm::ESGetToken<Propagator, TrackingComponentsRecord> hltriggeroffline::PropagateToMuon::propagatorAnyToken_

private

Definition at line 86 of file PropagateToMuon.h.

Referenced by init().

edm::ESHandle<Propagator> hltriggeroffline::PropagateToMuon::propagatorOpposite_

private

Definition at line 82 of file PropagateToMuon.h.

Referenced by extrapolate(), and init().

edm::ESGetToken<Propagator, TrackingComponentsRecord> hltriggeroffline::PropagateToMuon::propagatorOppositeToken_

private

Definition at line 86 of file PropagateToMuon.h.

Referenced by init().

edm::ESGetToken<Propagator, TrackingComponentsRecord> hltriggeroffline::PropagateToMuon::propagatorToken_

private

Definition at line 86 of file PropagateToMuon.h.

Referenced by init().

bool hltriggeroffline::PropagateToMuon::useSimpleGeometry_

private

Labels for input collections.

Definition at line 72 of file PropagateToMuon.h.

Referenced by extrapolate().

WhichState hltriggeroffline::PropagateToMuon::whichState_

private

Definition at line 74 of file PropagateToMuon.h.

Referenced by extrapolate(), PropagateToMuon(), and startingState().

WhichTrack hltriggeroffline::PropagateToMuon::whichTrack_

private

Definition at line 73 of file PropagateToMuon.h.

Referenced by PropagateToMuon(), and startingState().