MTDThresholdClusterizer Class Reference

An explicit threshold-based clustering algorithm. More...

#include <MTDThresholdClusterizer.h>

Inheritance diagram for MTDThresholdClusterizer:

Public Member Functions
void	clusterize (const FTLRecHitCollection &input, const MTDGeometry *geom, const MTDTopology *topo, FTLClusterCollection &output) override
	Cluster hits. This method operates on a matrix of hits and finds the largest contiguous cluster around each seed hit. Input and output data stored in DetSet. More...
	MTDThresholdClusterizer (edm::ParameterSet const &conf)
	Constructor: More...
	~MTDThresholdClusterizer () override
Public Member Functions inherited from MTDClusterizerBase
virtual	~MTDClusterizerBase ()

Static Public Member Functions
static void	fillPSetDescription (edm::ParameterSetDescription &desc)

Private Member Functions
void	clear_buffer (RecHitIterator itr)
	Clear the internal buffer array. More...
void	copy_to_buffer (RecHitIterator itr, const MTDGeometry *geom, const MTDTopology *topo)
	Copy FTLRecHit into the buffer, identify seeds. More...
FTLCluster	make_cluster (const FTLCluster::FTLHitPos &hit)
	The actual clustering algorithm: group the neighboring hits around the seed. More...
bool	setup (const MTDGeometry *geometry, const MTDTopology *topo, const DetId &id)

Private Attributes
bool	bufferAlreadySet
MTDArrayBuffer	theBuffer
	Data storage. More...
std::vector< FTLCluster >	theClusters
const float	theClusterThreshold
DetId	theCurrentId
const float	theHitThreshold
	Clustering-related quantities: More...
int	theNumOfCols
int	theNumOfRows
	Geometry-related information. More...
const float	thePositionThreshold
std::vector < FTLCluster::FTLHitPos >	theSeeds
const float	theSeedThreshold
const float	theTimeThreshold

Additional Inherited Members
Public Types inherited from MTDClusterizerBase
typedef FTLClusterCollection::const_iterator	ClusterIterator
typedef FTLRecHitCollection::const_iterator	RecHitIterator

Detailed Description

An explicit threshold-based clustering algorithm.

A threshold-based clustering algorithm which clusters FTLRecHits into FTLClusters for each DetUnit. The algorithm is straightforward and purely topological: the clustering process starts with seed hits and continues by adding adjacent hits above the hit threshold. Once the cluster is made, it has to be above the cluster threshold as well.

The clusterization is performed on a matrix with size equal to the size of the MTD detector, each cell containing the cahrge and time of the corresponding hit The matrix is reset after each clusterization.

The search starts from seed hits, i.e. hits with sufficiently large amplitudes

FTLCluster contains a barycenter, but it should be noted that that information is largely useless. One must use a PositionEstimator class to compute the RecHit position and its error for every given cluster.

Sets the MTDArrayBuffer dimensions and pixel thresholds. Makes clusters and stores them in theCache if the option useCache has been set.

Definition at line 51 of file MTDThresholdClusterizer.h.

Constructor & Destructor Documentation

MTDThresholdClusterizer::MTDThresholdClusterizer

(

edm::ParameterSet const &

conf

)

Constructor:

Definition at line 34 of file MTDThresholdClusterizer.cc.

    :  // Get energy thresholds
      theHitThreshold(conf.getParameter<double>("HitThreshold")),
      theSeedThreshold(conf.getParameter<double>("SeedThreshold")),
      theClusterThreshold(conf.getParameter<double>("ClusterThreshold")),
      theTimeThreshold(conf.getParameter<double>("TimeThreshold")),
      thePositionThreshold(conf.getParameter<double>("PositionThreshold")),
      theNumOfRows(0),
      theNumOfCols(0),
      theCurrentId(0),
      theBuffer(theNumOfRows, theNumOfCols),
      bufferAlreadySet(false) {}

MTDThresholdClusterizer::~MTDThresholdClusterizer ( )

override

Definition at line 47 of file MTDThresholdClusterizer.cc.

{}

Member Function Documentation

void MTDThresholdClusterizer::clear_buffer ( RecHitIterator  itr )

private

Clear the internal buffer array.

MTDs which are not part of recognized clusters are NOT ERASED during the cluster finding. Erase them now.

Definition at line 194 of file MTDThresholdClusterizer.cc.

References MTDArrayBuffer::clear(), and theBuffer.

Referenced by clusterize().

{ theBuffer.clear(itr->row(), itr->column()); }

void MTDThresholdClusterizer::clusterize ( const FTLRecHitCollection &  input, const MTDGeometry *  geom, const MTDTopology *  topo, FTLClusterCollection &  output  )

overridevirtual

Cluster hits. This method operates on a matrix of hits and finds the largest contiguous cluster around each seed hit. Input and output data stored in DetSet.

Implements MTDClusterizerBase.

Definition at line 98 of file MTDThresholdClusterizer.cc.

References cms::cuda::assert(), SplitLinear::begin, edm::SortedCollection< T, SORT >::begin(), MTDDetId::BTL, clear_buffer(), copy_to_buffer(), MTDTopologyMode::crysLayoutFromTopoMode(), DEBUG, TauDecayModes::dec, edmNew::DetSetVector< T >::empty(), edm::SortedCollection< T, SORT >::end(), dataset::end, MTDArrayBuffer::energy(), FTLCluster::energy(), MTDDetId::ETL, Exception, MTDDetId::FastTime, MTDTopology::getMTDTopologyMode(), mps_fire::i, make_cluster(), MTDDetId::mtdSubDetector(), edmNew::DetSetVector< T >::FastFiller::push_back(), sistrip::SpyUtilities::range(), DetId::rawId(), setup(), edm::SortedCollection< T, SORT >::size(), FTLCluster::size(), MTDDetId::subDetector(), theBuffer, theClusterThreshold, theSeeds, theSeedThreshold, FTLCluster::time(), FTLCluster::x(), and FTLCluster::y().

                                                                       {
  FTLRecHitCollection::const_iterator begin = input.begin();
  FTLRecHitCollection::const_iterator end = input.end();

  // Do not bother for empty detectors
  if (begin == end) {
    edm::LogInfo("MTDThresholdClusterizer") << "No hits to clusterize";
    return;
  }

  DEBUG("Input collection " << input.size());
  assert(output.empty());

  std::set<unsigned> geoIds;
  std::multimap<unsigned, unsigned> geoIdToIdx;

  unsigned index = 0;
  for (const auto& hit : input) {
    MTDDetId mtdId = MTDDetId(hit.detid());
    if (mtdId.subDetector() != MTDDetId::FastTime) {
      throw cms::Exception("MTDThresholdClusterizer")
          << "MTDDetId: " << std::hex << mtdId.rawId() << " is invalid!" << std::dec << std::endl;
    }

    if (mtdId.mtdSubDetector() == MTDDetId::BTL) {
      BTLDetId hitId(hit.detid());
      //for BTL topology gives different layout id
      DetId geoId = hitId.geographicalId(MTDTopologyMode::crysLayoutFromTopoMode(topo->getMTDTopologyMode()));
      geoIdToIdx.emplace(geoId, index);
      geoIds.emplace(geoId);
      ++index;
    } else if (mtdId.mtdSubDetector() == MTDDetId::ETL) {
      ETLDetId hitId(hit.detid());
      DetId geoId = hitId.geographicalId();
      geoIdToIdx.emplace(geoId, index);
      geoIds.emplace(geoId);
      ++index;
    } else {
      throw cms::Exception("MTDThresholdClusterizer")
          << "MTDDetId: " << std::hex << mtdId.rawId() << " is invalid!" << std::dec << std::endl;
    }
  }

  //cluster hits within geoIds (modules)
  for (unsigned id : geoIds) {
    //  Set up the clusterization on this DetId.
    if (!setup(geom, topo, DetId(id)))
      return;

    auto range = geoIdToIdx.equal_range(id);
    DEBUG("Matching Ids for " << std::hex << id << std::dec << " [" << range.first->second << ","
                              << range.second->second << "]");

    //  Copy MTDRecHits to the buffer array; select the seed hits
    //  on the way, and store them in theSeeds.
    for (auto itr = range.first; itr != range.second; ++itr) {
      const unsigned hitidx = itr->second;
      copy_to_buffer(begin + hitidx, geom, topo);
    }

    FTLClusterCollection::FastFiller clustersOnDet(output, id);

    for (unsigned int i = 0; i < theSeeds.size(); i++) {
      if (theBuffer.energy(theSeeds[i]) > theSeedThreshold) {  // Is this seed still valid?
        //  Make a cluster around this seed
        const FTLCluster& cluster = make_cluster(theSeeds[i]);

        //  Check if the cluster is above threshold
        if (cluster.energy() > theClusterThreshold) {
          DEBUG("putting in this cluster " << i << " #hits:" << cluster.size() << " E:" << cluster.energy()
                                           << " T:" << cluster.time() << " X:" << cluster.x() << " Y:" << cluster.y());
          clustersOnDet.push_back(cluster);
        }
      }
    }

    // Erase the seeds.
    theSeeds.clear();
    //  Need to clean unused hits from the buffer array.
    for (auto itr = range.first; itr != range.second; ++itr) {
      const unsigned hitidx = itr->second;
      clear_buffer(begin + hitidx);
    }
  }
}

void MTDThresholdClusterizer::copy_to_buffer ( RecHitIterator  itr, const MTDGeometry *  geom, const MTDTopology *  topo  )

private

Copy FTLRecHit into the buffer, identify seeds.

Definition at line 199 of file MTDThresholdClusterizer.cc.

References GeomDetEnumerators::barrel, MTDDetId::BTL, cuy::col, MTDTopologyMode::crysLayoutFromTopoMode(), DEBUG, GeomDetEnumerators::endcap, relval_parameters_module::energy, MTDDetId::ETL, MTDTopology::getMTDTopologyMode(), MTDGeometry::idToDet(), GeomDetEnumerators::invalidLoc, BTLRecHitsErrorEstimatorIM::localError(), RectangularMTDTopology::localPosition(), MTDDetId::mtdSubDetector(), RectangularMTDTopology::pitch(), position, MTDArrayBuffer::set(), ProxyMTDTopology::specificTopology(), theBuffer, theHitThreshold, theSeeds, theSeedThreshold, PV3DBase< T, PVType, FrameType >::x(), PV3DBase< T, PVType, FrameType >::y(), and PV3DBase< T, PVType, FrameType >::z().

Referenced by clusterize().

                                                                                                                 {
  MTDDetId mtdId = MTDDetId(itr->detid());
  int row = itr->row();
  int col = itr->column();
  GeomDetEnumerators::Location subDet = GeomDetEnumerators::invalidLoc;
  float energy = itr->energy();
  float time = itr->time();
  float timeError = itr->timeError();
  float position = itr->position();
  // position is the longitudinal offset that should be added into local x for bars in phi geometry
  LocalError local_error(0, 0, 0);
  GlobalPoint global_point(0, 0, 0);
  if (mtdId.mtdSubDetector() == MTDDetId::BTL) {
    subDet = GeomDetEnumerators::barrel;
    BTLDetId id = itr->id();
    DetId geoId = id.geographicalId(MTDTopologyMode::crysLayoutFromTopoMode(topo->getMTDTopologyMode()));
    const auto& det = geom->idToDet(geoId);
    const ProxyMTDTopology& topoproxy = static_cast<const ProxyMTDTopology&>(det->topology());
    const RectangularMTDTopology& topol = static_cast<const RectangularMTDTopology&>(topoproxy.specificTopology());
    MeasurementPoint mp(row, col);
    LocalPoint lp_ctr = topol.localPosition(mp);
    LocalPoint lp(lp_ctr.x() + position + topol.pitch().first * 0.5f, lp_ctr.y(), lp_ctr.z());
    // local coordinates of BTL module locates RecHits on the left edge of the bar (-9.2, -3.067, 3.067)
    // (position + topol.pitch().first/2.0) is the distance from the left edge to the Hit point
    global_point = det->toGlobal(lp);
    BTLRecHitsErrorEstimatorIM btlError(det, lp);
    local_error = btlError.localError();
  } else if (mtdId.mtdSubDetector() == MTDDetId::ETL) {
    subDet = GeomDetEnumerators::endcap;
    ETLDetId id = itr->id();
    DetId geoId = id.geographicalId();
    const auto& det = geom->idToDet(geoId);
    const ProxyMTDTopology& topoproxy = static_cast<const ProxyMTDTopology&>(det->topology());
    const RectangularMTDTopology& topol = static_cast<const RectangularMTDTopology&>(topoproxy.specificTopology());

    MeasurementPoint mp(row, col);
    LocalPoint lp = topol.localPosition(mp);
    global_point = det->toGlobal(lp);
  }

  DEBUG("ROW " << row << " COL " << col << " ENERGY " << energy << " TIME " << time);
  if (energy > theHitThreshold) {
    theBuffer.set(row, col, subDet, energy, time, timeError, local_error, global_point);
    if (energy > theSeedThreshold)
      theSeeds.push_back(FTLCluster::FTLHitPos(row, col));
    //sort seeds?
  }
}

void MTDThresholdClusterizer::fillPSetDescription ( edm::ParameterSetDescription &  desc )

static

Definition at line 50 of file MTDThresholdClusterizer.cc.

References edm::ParameterSetDescription::add().

Referenced by MTDClusterProducer::fillDescriptions().

                                                                                  {
  desc.add<double>("HitThreshold", 0.);
  desc.add<double>("SeedThreshold", 0.);
  desc.add<double>("ClusterThreshold", 0.);
  desc.add<double>("TimeThreshold", 10.);
  desc.add<double>("PositionThreshold", -1.0);
}

FTLCluster MTDThresholdClusterizer::make_cluster ( const FTLCluster::FTLHitPos &  hit )

private

The actual clustering algorithm: group the neighboring hits around the seed.

Definition at line 251 of file MTDThresholdClusterizer.cc.

References funct::abs(), MTDClusterizerBase::AccretionCluster::add(), GeomDetEnumerators::barrel, c, MTDArrayBuffer::clear(), FTLCluster::FTLHitPos::col(), MTDArrayBuffer::columns(), MTDClusterizerBase::AccretionCluster::empty(), MTDArrayBuffer::energy(), MTDClusterizerBase::AccretionCluster::energy, MTDArrayBuffer::global_point(), MTDClusterizerBase::AccretionCluster::isize, MTDArrayBuffer::local_error(), mag2(), SiStripPI::max, min(), MTDClusterizerBase::AccretionCluster::pop(), alignCSCRings::r, FTLCluster::FTLHitPos::row(), MTDArrayBuffer::rows(), mathSSE::sqrt(), MTDArrayBuffer::subDet(), theBuffer, theCurrentId, theHitThreshold, thePositionThreshold, theTimeThreshold, MTDArrayBuffer::time(), MTDClusterizerBase::AccretionCluster::time, MTDArrayBuffer::time_error(), MTDClusterizerBase::AccretionCluster::timeError, MTDClusterizerBase::AccretionCluster::top(), MTDClusterizerBase::AccretionCluster::x, MTDClusterizerBase::AccretionCluster::xmin, LocalError::xx(), MTDClusterizerBase::AccretionCluster::y, MTDClusterizerBase::AccretionCluster::ymin, and LocalError::yy().

Referenced by clusterize().

                                                                               {
  //First we acquire the seeds for the clusters

  GeomDetEnumerators::Location seed_subdet = theBuffer.subDet(hit.row(), hit.col());
  float seed_energy = theBuffer.energy(hit.row(), hit.col());
  float seed_time = theBuffer.time(hit.row(), hit.col());
  float seed_time_error = theBuffer.time_error(hit.row(), hit.col());
  auto const seedPoint = theBuffer.global_point(hit.row(), hit.col());
  double seed_error_xx = theBuffer.local_error(hit.row(), hit.col()).xx();
  double seed_error_yy = theBuffer.local_error(hit.row(), hit.col()).yy();
  theBuffer.clear(hit);

  AccretionCluster acluster;
  acluster.add(hit, seed_energy, seed_time, seed_time_error);

  bool stopClus = false;
  //Here we search all hits adjacent to all hits in the cluster.
  while (!acluster.empty() && !stopClus) {
    //This is the standard algorithm to find and add a hit
    auto curInd = acluster.top();
    acluster.pop();
    for (auto c = std::max(0, int(acluster.y[curInd] - 1));
         c < std::min(int(acluster.y[curInd] + 2), int(theBuffer.columns())) && !stopClus;
         ++c) {
      for (auto r = std::max(0, int(acluster.x[curInd] - 1));
           r < std::min(int(acluster.x[curInd] + 2), int(theBuffer.rows())) && !stopClus;
           ++r) {
        if (theBuffer.energy(r, c) > theHitThreshold) {
          if (std::abs(theBuffer.time(r, c) - seed_time) >
              theTimeThreshold *
                  sqrt(theBuffer.time_error(r, c) * theBuffer.time_error(r, c) + seed_time_error * seed_time_error))
            continue;
          if ((seed_subdet == GeomDetEnumerators::barrel) && (theBuffer.subDet(r, c) == GeomDetEnumerators::barrel)) {
            double hit_error_xx = theBuffer.local_error(r, c).xx();
            double hit_error_yy = theBuffer.local_error(r, c).yy();
            if (thePositionThreshold > 0) {
              if (((theBuffer.global_point(r, c) - seedPoint).mag2()) >
                  thePositionThreshold * thePositionThreshold *
                      (hit_error_xx + seed_error_xx + hit_error_yy + seed_error_yy))
                continue;
            }
          }
          FTLCluster::FTLHitPos newhit(r, c);
          if (!acluster.add(newhit, theBuffer.energy(r, c), theBuffer.time(r, c), theBuffer.time_error(r, c))) {
            stopClus = true;
            break;
          }
          theBuffer.clear(newhit);
        }
      }
    }
  }  // while accretion

  FTLCluster cluster(theCurrentId,
                     acluster.isize,
                     acluster.energy.data(),
                     acluster.time.data(),
                     acluster.timeError.data(),
                     acluster.x.data(),
                     acluster.y.data(),
                     acluster.xmin,
                     acluster.ymin);
  return cluster;
}

bool MTDThresholdClusterizer::setup ( const MTDGeometry *  geom, const MTDTopology *  topo, const DetId &  id  )

private

Prepare the Clusterizer to work on a particular DetUnit. Re-init the size of the panel/plaquette (so update nrows and ncols),

Definition at line 62 of file MTDThresholdClusterizer.cc.

References bufferAlreadySet, MTDArrayBuffer::columns(), DEBUG, TauDecayModes::dec, Exception, gpuClustering::id, MTDGeometry::idToDet(), RectangularMTDTopology::ncolumns(), RectangularMTDTopology::nrows(), MTDArrayBuffer::rows(), MTDArrayBuffer::setSize(), ProxyMTDTopology::specificTopology(), theBuffer, theCurrentId, theNumOfCols, and theNumOfRows.

Referenced by clusterize().

                                                                                                     {
  theCurrentId = id;
  //using geopraphicalId here
  const auto& thedet = geom->idToDet(id);
  if (thedet == nullptr) {
    throw cms::Exception("MTDThresholdClusterizer")
        << "GeographicalID: " << std::hex << id.rawId() << " is invalid!" << std::dec << std::endl;
    return false;
  }
  const ProxyMTDTopology& topoproxy = static_cast<const ProxyMTDTopology&>(thedet->topology());
  const RectangularMTDTopology& topol = static_cast<const RectangularMTDTopology&>(topoproxy.specificTopology());

  // Get the new sizes.
  unsigned int nrows = topol.nrows();     // rows in x
  unsigned int ncols = topol.ncolumns();  // cols in y

  theNumOfRows = nrows;  // Set new sizes
  theNumOfCols = ncols;

  DEBUG("Buffer size [" << theNumOfRows + 1 << "," << theNumOfCols + 1 << "]");

  if (nrows > theBuffer.rows() || ncols > theBuffer.columns()) {  // change only when a larger is needed
    // Resize the buffer
    theBuffer.setSize(nrows + 1, ncols + 1);  // +1 needed for MTD
    bufferAlreadySet = true;
  }

  return true;
}

Member Data Documentation

bool MTDThresholdClusterizer::bufferAlreadySet

private

Definition at line 83 of file MTDThresholdClusterizer.h.

Referenced by setup().

MTDArrayBuffer MTDThresholdClusterizer::theBuffer

private

Data storage.

Definition at line 82 of file MTDThresholdClusterizer.h.

Referenced by clear_buffer(), clusterize(), copy_to_buffer(), make_cluster(), and setup().

std::vector<FTLCluster> MTDThresholdClusterizer::theClusters

private

Definition at line 66 of file MTDThresholdClusterizer.h.

const float MTDThresholdClusterizer::theClusterThreshold

private

Definition at line 71 of file MTDThresholdClusterizer.h.

Referenced by clusterize().

DetId MTDThresholdClusterizer::theCurrentId

private

Definition at line 79 of file MTDThresholdClusterizer.h.

Referenced by make_cluster(), and setup().

const float MTDThresholdClusterizer::theHitThreshold

private

Clustering-related quantities:

Definition at line 69 of file MTDThresholdClusterizer.h.

Referenced by copy_to_buffer(), and make_cluster().

int MTDThresholdClusterizer::theNumOfCols

private

Definition at line 77 of file MTDThresholdClusterizer.h.

Referenced by setup().

int MTDThresholdClusterizer::theNumOfRows

private

Geometry-related information.

Definition at line 76 of file MTDThresholdClusterizer.h.

Referenced by setup().

const float MTDThresholdClusterizer::thePositionThreshold

private

Definition at line 73 of file MTDThresholdClusterizer.h.

Referenced by make_cluster().

std::vector<FTLCluster::FTLHitPos> MTDThresholdClusterizer::theSeeds

private

Definition at line 65 of file MTDThresholdClusterizer.h.

Referenced by clusterize(), and copy_to_buffer().

const float MTDThresholdClusterizer::theSeedThreshold

private

Definition at line 70 of file MTDThresholdClusterizer.h.

Referenced by clusterize(), and copy_to_buffer().

const float MTDThresholdClusterizer::theTimeThreshold

private

Definition at line 72 of file MTDThresholdClusterizer.h.

Referenced by make_cluster().