MuonErrorMatrixAdjuster Class Reference

#include <MuonErrorMatrixAdjuster.h>

Inheritance diagram for MuonErrorMatrixAdjuster:

Public Member Functions
	MuonErrorMatrixAdjuster (const edm::ParameterSet &)
	constructor More...
	~MuonErrorMatrixAdjuster () override
	destructor More...
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete

Private Member Functions
bool	attachRecHits (const reco::Track &recotrack_orig, reco::Track &recotrack, reco::TrackExtra &trackextra, TrackingRecHitCollection &RHcol, const TrackerTopology &ttopo)
	attached rechits to the newly created reco::Track and reco::TrackExtra More...
bool	divide (reco::TrackBase::CovarianceMatrix &num_matrix, const reco::TrackBase::CovarianceMatrix &denom_matrix)
	divide the num_matrix (first argument) by second matrix, TERM by TERM More...
reco::TrackBase::CovarianceMatrix	fix_cov_matrix (const reco::TrackBase::CovarianceMatrix &error_matrix, const GlobalVector &momentum)
	return a corrected error matrix More...
reco::Track	makeTrack (const reco::Track &recotrack_orig, const FreeTrajectoryState &PCAstate)
	create a corrected reco::Track from itself and trajectory state (redundant information) More...
reco::TrackExtra *	makeTrackExtra (const reco::Track &recotrack_orig, reco::Track &recotrack, reco::TrackExtraCollection &TEcol)
	create a track extra for the newly created recotrack, scaling the outer/inner measurment error matrix by the scale matrix recotrack/recotrack_orig More...
void	multiply (reco::TrackBase::CovarianceMatrix &revised_matrix, const reco::TrackBase::CovarianceMatrix &scale_matrix)
	mutliply revised_matrix (first argument) by second matrix TERM by TERM More...
void	produce (edm::Event &, const edm::EventSetup &) override
	framework method More...
bool	selectTrack (const reco::Track &recotrack_orig)
	make a selection on the reco:Track. (dummy for the moment) More...

Private Attributes
std::string	theCategory
	log category: MuonErrorMatrixAdjuster More...
edm::ESHandle< MagneticField >	theField
	hold on to the magnetic field More...
const edm::ESGetToken< MagneticField, IdealMagneticFieldRecord >	theFieldToken
const edm::ESGetToken< TrackerTopology, TrackerTopologyRcd >	theHttopoToken
std::string	theInstanceName
	instrance name of the created track collecion. rechit and trackextra have no instance name More...
std::unique_ptr< MuonErrorMatrix >	theMatrixProvider
	holds the error matrix parametrization More...
edm::RefProd< TrackingRecHitCollection >	theRefprodRH
	get reference before put rechit to the event, in order to create edm::Ref More...
edm::RefProd< reco::TrackExtraCollection >	theRefprodTE
	get reference before put track extra to the event, in order to create edm::Ref More...
bool	theRescale
	select the rescaling or replacing method to correct the error matrix More...
edm::Ref< TrackingRecHitCollection >::key_type	theRHi
edm::Ref< reco::TrackExtraCollection >::key_type	theTEi
edm::InputTag	theTrackLabel
	input tag of the reco::Track collection to be corrected More...

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
using	CacheTypes = CacheContexts< T... >
using	GlobalCache = typename CacheTypes::GlobalCache
using	HasAbility = AbilityChecker< T... >
using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache
using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache
using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >
using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache
using	RunCache = typename CacheTypes::RunCache
using	RunContext = RunContextT< RunCache, GlobalCache >
using	RunSummaryCache = typename CacheTypes::RunSummaryCache

Detailed Description

EDProducer which duplicatesa collection of track, adjusting their error matrix

track collection is retrieve from the event, duplicated, while the error matrix is corrected rechit are copied into a new collection track extra is also copied and error matrix are corrected by the same scale factors

Author

Jean-Roch Vlimant UCSB

Finn Rebassoo UCSB

Definition at line 46 of file MuonErrorMatrixAdjuster.h.

Constructor & Destructor Documentation

MuonErrorMatrixAdjuster()

MuonErrorMatrixAdjuster::MuonErrorMatrixAdjuster ( const edm::ParameterSet &  iConfig )

explicit

constructor

Definition at line 19 of file MuonErrorMatrixAdjuster.cc.

References deDxTools::esConsumes().

    : theFieldToken{esConsumes()}, theHttopoToken{esConsumes()} {
  theCategory = "MuonErrorMatrixAdjuster";
  theInstanceName = iConfig.getParameter<std::string>("instanceName");
  //register your products
  produces<reco::TrackCollection>(theInstanceName);
  produces<TrackingRecHitCollection>();
  produces<reco::TrackExtraCollection>();

  theTrackLabel = iConfig.getParameter<edm::InputTag>("trackLabel");
  consumes<reco::TrackCollection>(theTrackLabel);
  theRescale = iConfig.getParameter<bool>("rescale");

  auto matrixProvider_pset = iConfig.getParameter<edm::ParameterSet>("errorMatrix_pset");

  theMatrixProvider = std::make_unique<MuonErrorMatrix>(matrixProvider_pset);
}

~MuonErrorMatrixAdjuster()

MuonErrorMatrixAdjuster::~MuonErrorMatrixAdjuster ( )

override

destructor

Definition at line 37 of file MuonErrorMatrixAdjuster.cc.

                                                  {
  // do anything here that needs to be done at desctruction time
  // (e.g. close files, deallocate resources etc.)
}

Member Function Documentation

attachRecHits()

bool MuonErrorMatrixAdjuster::attachRecHits ( const reco::Track &  recotrack_orig, reco::Track &  recotrack, reco::TrackExtra &  trackextra, TrackingRecHitCollection &  RHcol, const TrackerTopology &  ttopo  )

private

attached rechits to the newly created reco::Track and reco::TrackExtra

Definition at line 148 of file MuonErrorMatrixAdjuster.cc.

References reco::TrackBase::appendHitPattern(), edm::OwnVector< T, P >::push_back(), rpcPointValidation_cfi::recHit, reco::Track::recHitsBegin(), reco::Track::recHitsEnd(), reco::TrackExtraBase::setHits(), theRefprodRH, and theRHi.

Referenced by produce().

                                                                          {
  //loop over the hits of the original track
  trackingRecHit_iterator recHit = recotrack_orig.recHitsBegin();
  auto const firstHitIndex = theRHi;
  for (; recHit != recotrack_orig.recHitsEnd(); ++recHit) {
    //clone it. this is meandatory
    TrackingRecHit* hit = (*recHit)->clone();

    //put it on the new track
    recotrack.appendHitPattern(*hit, ttopo);
    //copy them in the new collection
    RHcol.push_back(hit);
    ++theRHi;

  }  //loop over original rechits
  //do something with the trackextra
  trackextra.setHits(theRefprodRH, firstHitIndex, theRHi - firstHitIndex);

  return true;  //if nothing fails
}

divide()

bool MuonErrorMatrixAdjuster::divide ( reco::TrackBase::CovarianceMatrix &  num_matrix, const reco::TrackBase::CovarianceMatrix &  denom_matrix  )

private

divide the num_matrix (first argument) by second matrix, TERM by TERM

Definition at line 70 of file MuonErrorMatrixAdjuster.cc.

References mps_fire::i, and dqmiolumiharvest::j.

Referenced by makeTrackExtra().

                                                                                        {
  //divide term by term the matrix
  // the true type of the matrix is such that [i][j] is the same memory object as [j][i]: looping i:0-5, j:0-5 double multiply the terms
  // need to loop only on i:0-5, j:i-5
  for (int i = 0; i != 5; i++) {
    for (int j = i; j != 5; j++) {
      if (denom_matrix(i, j) == 0)
        return false;
      num_matrix(i, j) /= denom_matrix(i, j);
    }
  }
  return true;
}

fix_cov_matrix()

reco::TrackBase::CovarianceMatrix MuonErrorMatrixAdjuster::fix_cov_matrix ( const reco::TrackBase::CovarianceMatrix &  error_matrix, const GlobalVector &  momentum  )

private

return a corrected error matrix

Definition at line 47 of file MuonErrorMatrixAdjuster.cc.

References multiply(), theMatrixProvider, and theRescale.

Referenced by makeTrack().

                                                                                     {
  //CovarianceMatrix is template for SMatrix
  reco::TrackBase::CovarianceMatrix revised_matrix(theMatrixProvider->get(momentum));

  if (theRescale) {
    //rescale old error matrix up by a factor
    multiply(revised_matrix, error_matrix);
  }
  return revised_matrix;
}

makeTrack()

reco::Track MuonErrorMatrixAdjuster::makeTrack ( const reco::Track &  recotrack_orig, const FreeTrajectoryState &  PCAstate  )

private

create a corrected reco::Track from itself and trajectory state (redundant information)

Definition at line 85 of file MuonErrorMatrixAdjuster.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, reco::TrackBase::charge(), hltPixelTracks_cff::chi2, reco::TrackBase::chi2(), reco::TrackBase::covariance(), fix_cov_matrix(), LogDebug, FreeTrajectoryState::momentum(), reco::TrackBase::momentum(), ndof, reco::TrackBase::ndof(), reco::TrackBase::referencePoint(), and theCategory.

Referenced by produce().

                                                                                                                 {
  //get the parameters of the track so I can reconstruct it
  double chi2 = recotrack_orig.chi2();
  double ndof = recotrack_orig.ndof();
  const math::XYZPoint& refpos = recotrack_orig.referencePoint();
  const math::XYZVector& mom = recotrack_orig.momentum();
  int charge = recotrack_orig.charge();

  reco::TrackBase::CovarianceMatrix covariance_matrix =
      fix_cov_matrix(recotrack_orig.covariance(), PCAstate.momentum());

  LogDebug(theCategory) << "chi2: " << chi2 << "\n ndof: " << ndof << "\n refpos: " << refpos << "\n mom: " << mom
                        << "\n charge: " << charge << "\n covariance:\n"
                        << recotrack_orig.covariance() << "\n replaced by:\n"
                        << covariance_matrix;

  return reco::Track(chi2, ndof, refpos, mom, charge, covariance_matrix);
}

makeTrackExtra()

reco::TrackExtra * MuonErrorMatrixAdjuster::makeTrackExtra ( const reco::Track &  recotrack_orig, reco::Track &  recotrack, reco::TrackExtraCollection &  TEcol  )

private

create a track extra for the newly created recotrack, scaling the outer/inner measurment error matrix by the scale matrix recotrack/recotrack_orig

Definition at line 104 of file MuonErrorMatrixAdjuster.cc.

References reco::TrackBase::covariance(), divide(), reco::Track::extra(), edm::Ref< C, T, F >::isNull(), multiply(), reco::Track::setExtra(), theCategory, theRefprodTE, and theTEi.

Referenced by produce().

                                                                                           {
  //get the 5x5 matrix of recotrack/recotrack_orig
  reco::TrackBase::CovarianceMatrix scale_matrix(recotrack.covariance());
  if (!divide(scale_matrix, recotrack_orig.covariance())) {
    edm::LogError(theCategory) << "original track error matrix has term ==0... skipping.";
    return nullptr;
  }

  const reco::TrackExtraRef& trackExtra_orig = recotrack_orig.extra();
  if (trackExtra_orig.isNull()) {
    edm::LogError(theCategory) << "original track has no track extra... skipping.";
    return nullptr;
  }

  //copy the outer state. rescaling the error matrix
  reco::TrackBase::CovarianceMatrix outerCov(trackExtra_orig->outerStateCovariance());
  multiply(outerCov, scale_matrix);

  //copy the inner state, rescaling the error matrix
  reco::TrackBase::CovarianceMatrix innerCov(trackExtra_orig->innerStateCovariance());
  multiply(innerCov, scale_matrix);

  //put the trackExtra
  TEcol.push_back(reco::TrackExtra(trackExtra_orig->outerPosition(),
                                   trackExtra_orig->outerMomentum(),
                                   true,
                                   trackExtra_orig->innerPosition(),
                                   trackExtra_orig->innerMomentum(),
                                   true,
                                   outerCov,
                                   trackExtra_orig->outerDetId(),
                                   innerCov,
                                   trackExtra_orig->innerDetId(),
                                   trackExtra_orig->seedDirection()));

  //add a reference to the trackextra on the track
  recotrack.setExtra(edm::Ref<reco::TrackExtraCollection>(theRefprodTE, theTEi++));

  //return the reference to the last inserted then
  return &(TEcol.back());
}

multiply()

void MuonErrorMatrixAdjuster::multiply ( reco::TrackBase::CovarianceMatrix &  revised_matrix, const reco::TrackBase::CovarianceMatrix &  scale_matrix  )

private

mutliply revised_matrix (first argument) by second matrix TERM by TERM

Definition at line 59 of file MuonErrorMatrixAdjuster.cc.

References mps_fire::i, and dqmiolumiharvest::j.

Referenced by fix_cov_matrix(), and makeTrackExtra().

                                                                                          {
  //scale term by term the matrix
  // the true type of the matrix is such that [i][j] is the same memory object as [j][i]: looping i:0-5, j:0-5 double multiply the terms
  // need to loop only on i:0-5, j:i-5
  for (int i = 0; i != 5; i++) {
    for (int j = i; j != 5; j++) {
      revised_matrix(i, j) *= scale_matrix(i, j);
    }
  }
}

produce()

void MuonErrorMatrixAdjuster::produce ( edm::Event &  iEvent, const edm::EventSetup &  iSetup  )

overrideprivate

framework method

Definition at line 176 of file MuonErrorMatrixAdjuster.cc.

References attachRecHits(), edm::EventSetup::getData(), edm::EventSetup::getHandle(), iEvent, trajectoryStateTransform::initialFreeState(), LogDebug, PV3DBase< T, PVType, FrameType >::mag(), makeTrack(), makeTrackExtra(), eostools::move(), FreeTrajectoryState::position(), edm::ESHandle< T >::product(), selectTrack(), theCategory, theField, theFieldToken, theHttopoToken, theInstanceName, theRefprodRH, theRefprodTE, theRHi, theTEi, theTrackLabel, and tracks.

                                                                                   {
  using namespace edm;

  //open a collection of track
  edm::Handle<reco::TrackCollection> tracks;
  iEvent.getByLabel(theTrackLabel, tracks);
  LogDebug(theCategory) << "considering: " << tracks->size() << " uncorrected reco::Track from the event.("
                        << theTrackLabel << ")";

  //get the mag field
  theField = iSetup.getHandle(theFieldToken);

  const TrackerTopology& ttopo = iSetup.getData(theHttopoToken);

  //prepare the output collection
  auto Toutput = std::make_unique<reco::TrackCollection>();
  auto TRHoutput = std::make_unique<TrackingRecHitCollection>();
  auto TEoutput = std::make_unique<reco::TrackExtraCollection>();
  theRefprodTE = iEvent.getRefBeforePut<reco::TrackExtraCollection>();
  theTEi = 0;
  theRefprodRH = iEvent.getRefBeforePut<TrackingRecHitCollection>();
  theRHi = 0;

  for (unsigned int it = 0; it != tracks->size(); it++) {
    const reco::Track& recotrack_orig = (*tracks)[it];
    FreeTrajectoryState PCAstate = trajectoryStateTransform::initialFreeState(recotrack_orig, theField.product());
    if (PCAstate.position().mag() == 0) {
      edm::LogError(theCategory) << "invalid state from track initial state in " << theTrackLabel << ". skipping.";
      continue;
    }

    //create a reco::Track
    reco::Track recotrack = makeTrack(recotrack_orig, PCAstate);

    //make a selection on the create reco::Track
    if (!selectTrack(recotrack))
      continue;

    Toutput->push_back(recotrack);
    reco::Track& recotrackref = Toutput->back();

    //build the track extra
    reco::TrackExtra* extra = makeTrackExtra(recotrack_orig, recotrackref, *TEoutput);
    if (!extra) {
      edm::LogError(theCategory) << "cannot create the track extra for this track.";
      //pop the inserted track
      Toutput->pop_back();
      continue;
    }

    //attach the collection of rechits
    if (!attachRecHits(recotrack_orig, recotrackref, *extra, *TRHoutput, ttopo)) {
      edm::LogError(theCategory) << "cannot attach any rechits on this track";
      //pop the inserted track
      Toutput->pop_back();
      //pop the track extra
      TEoutput->pop_back();
      theTEi--;
      continue;
    }

  }  //loop over the original reco tracks

  LogDebug(theCategory) << "writing: " << Toutput->size() << " corrected reco::Track to the event.";

  iEvent.put(std::move(Toutput), theInstanceName);
  iEvent.put(std::move(TEoutput));
  iEvent.put(std::move(TRHoutput));
}

selectTrack()

bool MuonErrorMatrixAdjuster::selectTrack ( const reco::Track &  recotrack_orig )

private

make a selection on the reco:Track. (dummy for the moment)

Definition at line 173 of file MuonErrorMatrixAdjuster.cc.

Referenced by produce().

{ return true; }

Member Data Documentation

theCategory

std::string MuonErrorMatrixAdjuster::theCategory

private

log category: MuonErrorMatrixAdjuster

Definition at line 86 of file MuonErrorMatrixAdjuster.h.

Referenced by makeTrack(), makeTrackExtra(), and produce().

theField

edm::ESHandle<MagneticField> MuonErrorMatrixAdjuster::theField

private

hold on to the magnetic field

Definition at line 101 of file MuonErrorMatrixAdjuster.h.

Referenced by produce().

theFieldToken

const edm::ESGetToken<MagneticField, IdealMagneticFieldRecord> MuonErrorMatrixAdjuster::theFieldToken

private

Definition at line 102 of file MuonErrorMatrixAdjuster.h.

Referenced by produce().

theHttopoToken

const edm::ESGetToken<TrackerTopology, TrackerTopologyRcd> MuonErrorMatrixAdjuster::theHttopoToken

private

Definition at line 103 of file MuonErrorMatrixAdjuster.h.

Referenced by produce().

theInstanceName

std::string MuonErrorMatrixAdjuster::theInstanceName

private

instrance name of the created track collecion. rechit and trackextra have no instance name

Definition at line 92 of file MuonErrorMatrixAdjuster.h.

Referenced by produce().

theMatrixProvider

std::unique_ptr<MuonErrorMatrix> MuonErrorMatrixAdjuster::theMatrixProvider

private

holds the error matrix parametrization

Definition at line 98 of file MuonErrorMatrixAdjuster.h.

Referenced by fix_cov_matrix().

theRefprodRH

edm::RefProd<TrackingRecHitCollection> MuonErrorMatrixAdjuster::theRefprodRH

private

get reference before put rechit to the event, in order to create edm::Ref

Definition at line 110 of file MuonErrorMatrixAdjuster.h.

Referenced by attachRecHits(), and produce().

theRefprodTE

edm::RefProd<reco::TrackExtraCollection> MuonErrorMatrixAdjuster::theRefprodTE

private

get reference before put track extra to the event, in order to create edm::Ref

Definition at line 106 of file MuonErrorMatrixAdjuster.h.

Referenced by makeTrackExtra(), and produce().

theRescale

bool MuonErrorMatrixAdjuster::theRescale

private

select the rescaling or replacing method to correct the error matrix

Definition at line 95 of file MuonErrorMatrixAdjuster.h.

Referenced by fix_cov_matrix().

theRHi

edm::Ref<TrackingRecHitCollection>::key_type MuonErrorMatrixAdjuster::theRHi

private

Definition at line 111 of file MuonErrorMatrixAdjuster.h.

Referenced by attachRecHits(), and produce().

theTEi

edm::Ref<reco::TrackExtraCollection>::key_type MuonErrorMatrixAdjuster::theTEi

private

Definition at line 107 of file MuonErrorMatrixAdjuster.h.

Referenced by makeTrackExtra(), and produce().

theTrackLabel

edm::InputTag MuonErrorMatrixAdjuster::theTrackLabel

private

input tag of the reco::Track collection to be corrected

Definition at line 89 of file MuonErrorMatrixAdjuster.h.

Referenced by produce().