TotemRPUVPatternFinder Class Reference

Class to recognize straight line tracks, based on optimized Hough trasform. More...

Inheritance diagram for TotemRPUVPatternFinder:

Classes
struct	RPSettings
	block of (exceptional) settings for 1 RP More...

Public Member Functions
void	produce (edm::Event &e, const edm::EventSetup &c) override
	TotemRPUVPatternFinder (const edm::ParameterSet &conf)
	~TotemRPUVPatternFinder () override
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
bool	hasAbilityToProduceInLumis () const final
bool	hasAbilityToProduceInRuns () const final

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &)

Private Member Functions
void	recognizeAndSelect (TotemRPUVPattern::ProjectionType proj, double z0, double threshold, unsigned int planes_required, const edm::DetSetVector< TotemRPRecHit > &hits, edm::DetSet< TotemRPUVPattern > &patterns)
	executes line recognition in a projection More...

Private Attributes
edm::EDGetTokenT< edm::DetSetVector< TotemRPRecHit > >	detSetVectorTotemRPRecHitToken
std::map< unsigned int, RPSettings >	exceptionalSettings
	exceptional settings: RP Id –> settings More...
edm::ESWatcher< VeryForwardRealGeometryRecord >	geometryWatcher
FastLineRecognition *	lrcgn
	the line recognition algorithm More...
double	max_a_toFit
	maximal angle (in any projection) to mark candidate as fittable - controls track parallelity More...
unsigned int	maxHitsPerPlaneToSearch
	above this limit, planes are considered noisy More...
unsigned char	minPlanesPerProjectionToFit
	minimal required number of active planes per projection to mark track candidate as fittable More...
unsigned char	minPlanesPerProjectionToSearch
	minimal required number of active planes per projection to even start track recognition More...
edm::InputTag	tagRecHit
double	threshold
	minimal weight of (Hough) cluster to accept it as candidate More...
unsigned int	verbosity

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

Detailed Description

Class to recognize straight line tracks, based on optimized Hough trasform.

The search is perfomed in global U,V coordinates (wrt. beam). In this way (some of) the alignment corrections can be taken into account.

Definition at line 36 of file TotemRPUVPatternFinder.cc.

Constructor & Destructor Documentation

TotemRPUVPatternFinder::TotemRPUVPatternFinder

(

const edm::ParameterSet &

conf

)

Definition at line 95 of file TotemRPUVPatternFinder.cc.

References detSetVectorTotemRPRecHitToken, exceptionalSettings, edm::ParameterSet::getParameter(), TotemRPUVPatternFinder::RPSettings::minPlanesPerProjectionToFit_U, and tagRecHit.

                                                                          :
  tagRecHit(conf.getParameter<edm::InputTag>("tagRecHit")),
  verbosity(conf.getUntrackedParameter<unsigned int>("verbosity", 0)),
  minPlanesPerProjectionToSearch(conf.getParameter<unsigned int>("minPlanesPerProjectionToSearch")),
  minPlanesPerProjectionToFit(conf.getParameter<unsigned int>("minPlanesPerProjectionToFit")),
  maxHitsPerPlaneToSearch(conf.getParameter<unsigned int>("maxHitsPerPlaneToSearch")),
  lrcgn(new FastLineRecognition(conf.getParameter<double>("clusterSize_a"), conf.getParameter<double>("clusterSize_b"))),
  threshold(conf.getParameter<double>("threshold")),
  max_a_toFit(conf.getParameter<double>("max_a_toFit"))
{
  for (const auto &ps : conf.getParameter< vector<ParameterSet> >("exceptionalSettings"))
  {
    unsigned int rpId = ps.getParameter<unsigned int>("rpId");

    RPSettings settings;
    settings.minPlanesPerProjectionToFit_U = ps.getParameter<unsigned int>("minPlanesPerProjectionToFit_U");
    settings.minPlanesPerProjectionToFit_V = ps.getParameter<unsigned int>("minPlanesPerProjectionToFit_V");
    settings.threshold_U = ps.getParameter<double>("threshold_U");
    settings.threshold_V = ps.getParameter<double>("threshold_V");

    exceptionalSettings[rpId] = settings;
  }

  detSetVectorTotemRPRecHitToken = consumes<edm::DetSetVector<TotemRPRecHit> >(tagRecHit);

  produces<DetSetVector<TotemRPUVPattern>>();
}

TotemRPUVPatternFinder::~TotemRPUVPatternFinder ( )

override

Definition at line 125 of file TotemRPUVPatternFinder.cc.

References lrcgn.

{
  delete lrcgn;
}

Member Function Documentation

void TotemRPUVPatternFinder::fillDescriptions ( edm::ConfigurationDescriptions &  descr )

static

Definition at line 301 of file TotemRPUVPatternFinder.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addUntracked(), edm::ParameterSetDescription::addVPSet(), DEFINE_FWK_MODULE, and funct::false.

{
  edm::ParameterSetDescription desc;

  desc.add<edm::InputTag>( "tagRecHit", edm::InputTag( "totemRPRecHitProducer" ) )
    ->setComment( "input rechits collection to retrieve" );
  desc.addUntracked<unsigned int>( "verbosity", 0 );
  desc.add<unsigned int>( "maxHitsPerPlaneToSearch", 5 )
    ->setComment( "minimum threshold of hits multiplicity to flag the pattern as dirty" );
  desc.add<unsigned int>( "minPlanesPerProjectionToSearch", 3 )
    ->setComment( "minimal number of reasonable (= not empty and not dirty) planes per projection and per RP, to start the pattern search" );
  desc.add<double>( "clusterSize_a", 0.02 /* rad */ )
    ->setComment( "(full) cluster size (in rad) in slope-intercept space" );
  desc.add<double>( "clusterSize_b", 0.3 /* mm */ );

  desc.add<double>( "threshold", 2.99 )
    ->setComment( "minimal weight of (Hough) cluster to accept it as candidate\n"
                  "  weight of cluster = sum of weights of contributing points\n"
                  "  weight of point = sigma0 / sigma_of_point\n"
                  "most often: weight of point ~ 1, thus cluster weight is roughly number of contributing points" );

  desc.add<unsigned int>( "minPlanesPerProjectionToFit", 3 )
    ->setComment( "minimal number of planes (in the recognised patterns) per projection and per RP, to tag the candidate as fittable" );

  desc.add<bool>( "allowAmbiguousCombination", false )
    ->setComment( "whether to allow combination of most significant U and V pattern, in case there several of them.\n"
                  "don't set it to True, unless you have reason" );

  desc.add<double>( "max_a_toFit", 10.0 )
    ->setComment( "maximal angle (in any projection) to mark the candidate as fittable -> controls track parallelity with beam\n"
                  "huge value -> no constraint" );

  edm::ParameterSetDescription exceptions_validator;
  exceptions_validator.add<unsigned int>( "rpId" )
    ->setComment( "RP id according to CTPPSDetId" );
  exceptions_validator.add<unsigned int>( "minPlanesPerProjectionToFit_U" );
  exceptions_validator.add<unsigned int>( "minPlanesPerProjectionToFit_V" );
  exceptions_validator.add<double>( "threshold_U" );
  exceptions_validator.add<double>( "threshold_V" );

  std::vector<edm::ParameterSet> exceptions_default;
  desc.addVPSet( "exceptionalSettings", exceptions_validator, exceptions_default );

  descr.add( "totemRPUVPatternFinder", desc );
}

void TotemRPUVPatternFinder::produce ( edm::Event &  e, const edm::EventSetup &  c  )

override

Definition at line 163 of file TotemRPUVPatternFinder.cc.

References edm::ESWatcher< T >::check(), data, detSetVectorTotemRPRecHitToken, exceptionalSettings, edm::DetSetVector< T >::find_or_insert(), geometry, geometryWatcher, edm::EventSetup::get(), CTPPSGeometry::getRP(), CTPPSDetId::getRPId(), h, input, lrcgn, maxHitsPerPlaneToSearch, minPlanesPerProjectionToFit, minPlanesPerProjectionToSearch, AlCaHLTBitMon_ParallelJobs::p, TotemRPDetId::plane(), edm::ESHandle< T >::product(), TotemRPUVPattern::projU, TotemRPUVPattern::projV, recognizeAndSelect(), FastLineRecognition::resetGeometry(), threshold, DetGeomDesc::translation(), and verbosity.

{
  if (verbosity > 5)
    LogVerbatim("TotemRPUVPatternFinder")
      << ">> TotemRPUVPatternFinder::produce " << event.id().run() << ":" << event.id().event();

  // geometry
  ESHandle<CTPPSGeometry> geometry;
  es.get<VeryForwardRealGeometryRecord>().get(geometry);
  if (geometryWatcher.check(es))
    lrcgn->resetGeometry(geometry.product());
  
  // get input
  edm::Handle< edm::DetSetVector<TotemRPRecHit> > input;
  event.getByToken(detSetVectorTotemRPRecHitToken, input);

  // prepare output
  DetSetVector<TotemRPUVPattern> patternsVector;
  
  // split input per RP and per U/V projection
  struct RPData
  {
    DetSetVector<TotemRPRecHit> hits_U, hits_V;
    map<uint8_t, uint16_t> planeOccupancy_U, planeOccupancy_V;
  };
  map<unsigned int, RPData> rpData;

  for (auto &ids : *input)
  {
    TotemRPDetId detId(ids.detId());
    unsigned int plane = detId.plane();
    bool uDir = detId.isStripsCoordinateUDirection();

    CTPPSDetId rpId = detId.getRPId();

    RPData &data = rpData[rpId];

    for (auto &h : ids)
    {
      if (uDir)
      {
        auto &ods = data.hits_U.find_or_insert(ids.detId());
        ods.push_back(h);
        data.planeOccupancy_U[plane]++;
      } else {
        auto &ods = data.hits_V.find_or_insert(ids.detId());
        ods.push_back(h);
        data.planeOccupancy_V[plane]++;
      }
    }
  }

  // track recognition pot by pot
  for (auto it : rpData)
  {
    CTPPSDetId rpId(it.first);
    RPData &data = it.second;

    // merge default and exceptional settings (if available)
    unsigned int minPlanesPerProjectionToFit_U = minPlanesPerProjectionToFit;
    unsigned int minPlanesPerProjectionToFit_V = minPlanesPerProjectionToFit;
    double threshold_U = threshold;
    double threshold_V = threshold;
    
    auto setIt = exceptionalSettings.find(rpId);
    if (setIt != exceptionalSettings.end())
    {
      minPlanesPerProjectionToFit_U = setIt->second.minPlanesPerProjectionToFit_U;
      minPlanesPerProjectionToFit_V = setIt->second.minPlanesPerProjectionToFit_V;
      threshold_U = setIt->second.threshold_U;
      threshold_V = setIt->second.threshold_V;
    }

    auto &uColl = data.planeOccupancy_U;
    auto &vColl = data.planeOccupancy_V;

    if (verbosity > 5)
    {
      LogVerbatim("TotemRPUVPatternFinder")
        << "\tRP " << rpId
        << "\n\t\tall planes: u = " << uColl.size() << ", v = " << vColl.size();
    }

    // count planes with clean data (no showers, noise, ...)
    unsigned int uPlanes = 0, vPlanes = 0;
    for (auto pit : uColl)
      if (pit.second <= maxHitsPerPlaneToSearch)
        uPlanes++;

    for (auto pit : vColl)
      if (pit.second <= maxHitsPerPlaneToSearch)
        vPlanes++;

    if (verbosity > 5)
      LogVerbatim("TotemRPUVPatternFinder") << "\t\tplanes with clean data: u = " << uPlanes << ", v = " << vPlanes;

    // discard RPs with too few reasonable planes
    if (uPlanes < minPlanesPerProjectionToSearch || vPlanes < minPlanesPerProjectionToSearch)
      continue;

    // prepare data containers
    DetSet<TotemRPUVPattern> &patterns = patternsVector.find_or_insert(rpId);

    // "typical" z0 for the RP
    double z0 = geometry->getRP(rpId)->translation().z();

    // u then v recognition
    recognizeAndSelect(TotemRPUVPattern::projU, z0, threshold_U, minPlanesPerProjectionToFit_U, data.hits_U, patterns);

    recognizeAndSelect(TotemRPUVPattern::projV, z0, threshold_V, minPlanesPerProjectionToFit_V, data.hits_V, patterns);

    if (verbosity > 5)
    {
      LogVerbatim("TotemRPUVPatternFinder") << "\t\tpatterns:";
      for (const auto &p : patterns)
      {
        unsigned int n_hits = 0;
        for (auto &hds : p.getHits())
          n_hits += hds.size();
      
        LogVerbatim("TotemRPUVPatternFinder")
          << "\t\t\tproj = " << ((p.getProjection() == TotemRPUVPattern::projU) ? "U" : "V")
          << ", a = " << p.getA()
          << ", b = " << p.getB()
          << ", w = " << p.getW()
          << ", fittable = " << p.getFittable()
          << ", hits = " << n_hits;
      }
    }
  }
 
  // save output
  event.put(make_unique<DetSetVector<TotemRPUVPattern>>(patternsVector));
}

void TotemRPUVPatternFinder::recognizeAndSelect ( TotemRPUVPattern::ProjectionType  proj, double  z0, double  threshold, unsigned int  planes_required, const edm::DetSetVector< TotemRPRecHit > &  hits, edm::DetSet< TotemRPUVPattern > &  patterns  )

private

executes line recognition in a projection

Definition at line 132 of file TotemRPUVPatternFinder.cc.

References FastLineRecognition::getPatterns(), lrcgn, max_a_toFit, AlCaHLTBitMon_ParallelJobs::p, and edm::DetSet< T >::push_back().

Referenced by produce().

{
  // run recognition
  DetSet<TotemRPUVPattern> newPatterns;
  lrcgn->getPatterns(hits, z0, threshold_loc, newPatterns);
  
  // set pattern properties and copy to the global pattern collection
  for (auto &p : newPatterns)
  {
    p.setProjection(proj);

    p.setFittable(true);

    set<unsigned int> planes;
    for (const auto &ds : p.getHits())
        planes.insert(TotemRPDetId(ds.detId()).plane());

    if (planes.size() < planes_required)
      p.setFittable(false);
    
    if (fabs(p.getA()) > max_a_toFit)
      p.setFittable(false);

    patterns.push_back(p);
  }
}

Member Data Documentation

edm::EDGetTokenT<edm::DetSetVector<TotemRPRecHit> > TotemRPUVPatternFinder::detSetVectorTotemRPRecHitToken

private

Definition at line 48 of file TotemRPUVPatternFinder.cc.

Referenced by produce(), and TotemRPUVPatternFinder().

std::map<unsigned int, RPSettings> TotemRPUVPatternFinder::exceptionalSettings

private

exceptional settings: RP Id –> settings

Definition at line 78 of file TotemRPUVPatternFinder.cc.

Referenced by produce(), and TotemRPUVPatternFinder().

edm::ESWatcher<VeryForwardRealGeometryRecord> TotemRPUVPatternFinder::geometryWatcher

private

Definition at line 80 of file TotemRPUVPatternFinder.cc.

Referenced by produce().

FastLineRecognition* TotemRPUVPatternFinder::lrcgn

private

the line recognition algorithm

Definition at line 62 of file TotemRPUVPatternFinder.cc.

Referenced by produce(), recognizeAndSelect(), and ~TotemRPUVPatternFinder().

double TotemRPUVPatternFinder::max_a_toFit

private

maximal angle (in any projection) to mark candidate as fittable - controls track parallelity

Definition at line 68 of file TotemRPUVPatternFinder.cc.

Referenced by recognizeAndSelect().

unsigned int TotemRPUVPatternFinder::maxHitsPerPlaneToSearch

private

above this limit, planes are considered noisy

Definition at line 59 of file TotemRPUVPatternFinder.cc.

Referenced by produce().

unsigned char TotemRPUVPatternFinder::minPlanesPerProjectionToFit

private

minimal required number of active planes per projection to mark track candidate as fittable

Definition at line 56 of file TotemRPUVPatternFinder.cc.

Referenced by produce().

unsigned char TotemRPUVPatternFinder::minPlanesPerProjectionToSearch

private

minimal required number of active planes per projection to even start track recognition

Definition at line 53 of file TotemRPUVPatternFinder.cc.

Referenced by produce().

edm::InputTag TotemRPUVPatternFinder::tagRecHit

private

Definition at line 47 of file TotemRPUVPatternFinder.cc.

Referenced by TotemRPUVPatternFinder().

double TotemRPUVPatternFinder::threshold

private

minimal weight of (Hough) cluster to accept it as candidate

Definition at line 65 of file TotemRPUVPatternFinder.cc.

Referenced by utils.StatisticalTest::get_status(), and produce().

unsigned int TotemRPUVPatternFinder::verbosity

private

Definition at line 50 of file TotemRPUVPatternFinder.cc.

Referenced by produce().