StEEmcClusterMaker Class Reference

A cluster maker for the EEMC. More...

Inheritance diagram for StEEmcClusterMaker:

StMaker StMaker

List of all members.

Public Member Functions

 StEEmcClusterMaker (const Char_t *name="mEEclusters")
virtual Int_t Init ()
 Initialize.
virtual Int_t Make ()
 Make clusters for this event.
virtual void Clear (Option_t *opts="")
 Clear clusters for next event.
void analysis (const Char_t *name)
 Set the name of the ADC-->E maker.
void seedEnergy (Float_t energy, Int_t layer=0)
void setMaxExtent (Int_t m)
 Maximum distance around seed strip to cluster smd strips.
void setMinStrips (Int_t m)
 Minimum number of strips to form a cluster.
void setSeedFloor (Float_t f=2.0)
Int_t numberOfClusters (Int_t sec, Int_t layer) const
 Return number of clusters for a given sector, layer.
Int_t numberOfSmdClusters (Int_t sec, Int_t plane) const
 Return number of smd clusters for a given sector, plane.
StEEmcClustercluster (Int_t sec, Int_t layer, Int_t index)
 Return a specific cluster from a given sector, layer.
const StEEmcClustercluster (Int_t sec, Int_t layer, Int_t index) const
StEEmcSmdClustersmdcluster (Int_t sec, Int_t plane, Int_t index)
 return a specific cluster from a given sector, plane
const StEEmcSmdClustersmdcluster (Int_t sec, Int_t plane, Int_t index) const
StEEmcClustercluster (const StEmcCluster *cl)
 Given a StEmcCluster, return the StEEmcCluster where it came from.
const StEEmcClustercluster (const StEmcCluster *cl) const
StEEmcSmdClustersmdcluster (const StEmcCluster *cl)
 Given a StEmcCluster, return the StEEmcSmdCluster where it came from.
const StEEmcSmdClustersmdcluster (const StEmcCluster *cl) const
StEEmcClusterVec_t & clusters (Int_t sec, Int_t layer)
 Return a vector of tower clusters.
const StEEmcClusterVec_t & clusters (Int_t sec, Int_t layer) const
StEEmcSmdClusterVec_t & smdclusters (Int_t sec, Int_t plane)
 Return a vector of smd clusters.
const StEEmcSmdClusterVec_t & smdclusters (Int_t sec, Int_t plane) const
void setFillStEvent ()
void suppress (Int_t n=2)
void skip (Bool_t s=true)
 Skips over strips with "fail" bits set, if true.
void loose (Bool_t l=true)
 Loose cuts (see code).
void print () const
 Event summary.
 StEEmcClusterMaker (const Char_t *name="mEEclusters")
Int_t Init ()
Int_t Make ()
void Clear (Option_t *opts="")
 User defined functions.
void analysis (const Char_t *name)
 Set the name of the ADC-->E maker.
void seedEnergy (Float_t energy, Int_t layer=0)
void setMaxExtent (Int_t m)
 Maximum distance around seed strip to cluster smd strips.
void setSeedFloor (Float_t f=2.0)
Int_t numberOfClusters (Int_t sec, Int_t layer)
 Return number of clusters for a given sector, layer.
Int_t numberOfSmdClusters (Int_t sec, Int_t plane)
 Return number of smd clusters for a given sector, plane.
StEEmcCluster cluster (Int_t sec, Int_t layer, Int_t index)
 Return a specific cluster from a given sector, layer.
StEEmcSmdCluster smdcluster (Int_t sec, Int_t plane, Int_t index)
 return a specific cluster from a given sector, plane
StEEmcCluster cluster (StEmcCluster *cl)
StEEmcSmdCluster smdcluster (StEmcCluster *cl)
StEEmcClusterVec_t clusters (Int_t sec, Int_t layer)
 Return a vector of tower clusters.
StEEmcSmdClusterVec_t smdclusters (Int_t sec, Int_t plane)
 Return a vector of smd clusters.
void setFillStEvent ()
void suppress ()
 Suppress cluster splitting.
void print ()

Protected Member Functions

virtual Bool_t buildTowerClusters ()
 Constructs tower clusters.
virtual Bool_t buildSmdClusters ()
 Constructs smd clusters.
void fillStEvent ()
 Fills StEvent cluster collections if the option is selected.
Bool_t verifyStEvent () const
 ClassDef (StEEmcClusterMaker, 1)
Bool_t buildTowerClusters ()
 Constructs tower clusters.
Bool_t buildSmdClusters ()
 Constructs smd clusters.
void fillStEvent ()
 Fills StEvent cluster collections if the option is selected.
Bool_t verifyStEvent ()
 ClassDef (StEEmcClusterMaker, 1)

Protected Attributes

Int_t mClusterId
 Keep track of clusters.
Int_t mSuppress
 Supress seeds adjacent to clusters.
Bool_t mSkip
 Skip strips if failbit set.
Bool_t mLoose
 Loose cuts option.
std::vector< std::vector
< StEEmcTowerVec_t > > 
mSeedTowers
std::vector< std::vector
< StEEmcClusterVec_t > > 
mTowerClusters
std::vector< std::vector
< StEEmcSmdClusterVec_t > > 
mSmdClusters
Int_t mNumberOfClusters [6]
 Counts clusters for full eemc, 0=T, 1=P, 2=Q, 3=R, 4=U, 5=V.
Float_t mSeedEnergy [6]
 Seed energy for 0=T, 1=P, 2=Q, 3=R, 4=U, 5=V.
Int_t mMaxExtent
 Maximum distance from SMD seed strips.
Int_t mMinStrips
 Minimum number of smd strips to form seed.
Float_t mSeedFloor
 blah...
const EEmcGeomSimplemEEtow
const EEmcSmdGeommEEsmd
const EEmcSmdMap * mEEmap
TString mAnalysisName
 ADC-->E maker name.
const StEEmcA2EMakermEEanalysis
 ADC-->E maker.
Bool_t mFillStEvent
 Option to fill StEvent.
std::map< const StEmcCluster
*, StEEmcCluster
mEtoEE
 Map StEEmcClusters to StEmcClusters.
std::map< const StEmcCluster
*, StEEmcSmdCluster
mEtoEEsmd
 ... and for smd clusters
Bool_t mSuppress
EEmcGeomSimplemEEtow
 Geometry classes.
EEmcSmdGeommEEsmd
EEmcSmdMap * mEEmap
StEEmcA2EMakermEEanalysis
 ADC-->E maker.
std::map< StEmcCluster
*, StEEmcCluster
mEtoEE
 Map StEEmcClusters to StEmcClusters.
std::map< StEmcCluster
*, StEEmcSmdCluster
mEtoEEsmd


Detailed Description

A cluster maker for the EEMC.

This class produces clusters of EEMC towers, pre- and postshower elements and smd strips.

Author:
Jason C. Webb
Date
2010/08/26 22:49:25
Revision
1.8

Tower, pre- and postshower algorithm

The clustering-algorithm used for tower clusters (as well as preshower and postshower clusters) is the Minesweeper algorithm originally developed by Jan Balewski.

The SMD Algorithm

The SMD clustering algorithm starts by finding all strips which exceed a user-specified seed threshold. These strips are sorted by energy, and we work from the most energetic seed to the least energetic seed.

Strips adjacent to the smd seed are added to the cluster and removed from the pool of seed strips. The number of adjacent strips added is specified by the user in the setMaxExtent(max) method.

Once a cluster is identified, the seed threshold is raised in the vicinity of that cluster. For details, see buildSmdClusters().

SMD Cluster Cuts

In order to form a cluster, we require a minimum of three smd strips. Fewer strips suggests a MIP, although low-energy EM showers (<~ 1 GeV) can deposit energy in only two consecutive smd strips.

The user may also specify the suppress() option for the cluster maker. When this option is used, the two smd strips adjacent to the cluster are removed from the pool of smd seed strips. This reduces the effects of false cluster splitting, i.e. where a fluctuation in the size of the EM shower combined with the fixed size of the cluster leads to the formation of a false smd cluster.

Definition at line 17 of file StEEmcClusterMaker.h.


Constructor & Destructor Documentation

StEEmcClusterMaker::StEEmcClusterMaker ( const Char_t *  name = "mEEclusters"  ) 

by default, do not populate the StEmcClusterCollection

default, do not supress seeds adjacent to clusters

each cluster (tower, pre/post, smd) are assigned a unique id in the order in which they are collected

Set default seed energies

Initialize storage banks for tower and SMD clusters. Both will be stored sector-wise and layer-wise.

Tower clusters are stored according to the sector in which we find their seed tower.

Layers: T=0, P=1, Q=2, R=3 / Planes: U=0, V=1

mTowerClusters[sector][layer] returns vector of tower clusters mSmdClusters[sector][plane] returns vector of SMD clusters

Definition at line 68 of file StEEmcClusterMaker.cxx.

References mClusterId, mEEmap, mEEsmd, mEEtow, mFillStEvent, mLoose, mMaxExtent, mMinStrips, mSeedFloor, mSeedTowers, mSkip, mSmdClusters, mSuppress, mTowerClusters, and seedEnergy().


Member Function Documentation

Bool_t StEEmcClusterMaker::buildSmdClusters (  )  [protected, virtual]

Constructs smd clusters.

Loop over all sectors

Loop over all planes

Try to cut down on noice around identified gammas

Energy of all strips in plane

Get list of strips

Sort by energy

Order in descending energy

Copy energy of all hit strips into an array

We'll flag each seed strip

Iterate over strips and find seeds

We always ignore the corners of the planes

Verify that this is a good strip

Verify that this strip exceeds the floor by the specified seed threshold. If not, punt

Flag this as a seed strip

LOOSE_CUTS is an adhoc shower shape, where we try to suppress clusters if they are likely a fluctuation in the shower profile of an EM shower

Set a "floor" around this strip

Within +/- 2 strips, find no other seeds

Within +/- 4 strips, Floor is 20% of seed

Within +/- 10 strips, Floor i 10% of seed

Within +/- 20 strips, floor is 5% of seed

Now for each seed strip, add all contiguous, adjacent SMD strips out to +/- 3 strips on either side. Continuity is broken if strip falls below Nsigma threshold and is not marked as dead.

Verify that this seed is not owned by another cluster

This seed is now the property of a cluster

Create our cluster

And give it the strip

Now go +/- 3 strips on either side and add them to the cluster, respecting continuity etc...

Get the strip

Break if not continuous (and not dead)

Mark this strip as owned

Add to cluster

Get the strip

Break if not continuous (and not dead)

Mark this strip as owned

Add to cluster

Push the cluster into our storage vector

Definition at line 326 of file StEEmcClusterMaker.cxx.

References mEEanalysis, mMaxExtent, mSeedEnergy, mSeedFloor, mSkip, and StEEmcA2EMaker::strips().

Referenced by Make().

Bool_t StEEmcClusterMaker::buildTowerClusters (  )  [protected, virtual]

Constructs tower clusters.

Current algo only populates tower clusters, using Jan's "minesweeper" algorithm (apologies to Bill Gates).

Loop over layers to go here... maybe above init of weights

Weights for dividing energy of towers among the tower-only clusters, like Jan's algorithm.

Temp storage for clusters

Get list of towers

Order according to energy (STL sort is fast, N log(N))

Order descending in energy

Find the last tower which exceeds see threshold (actually, "last" will be the first tower below the seed threshold).

store seed towers by layer, sector <<< this breaks, gives an "abort", which I assume means that we're trying to push a tower into a nonexistant vector... did I maybe get the order wrong???

We have run out of seeds here

This seed tower is adjacent to another seed tower and will be clustered with that one. No incrementation for now. (Future, we may allow this to be a seed if there's an SMD response beneath it, then use tower-sharing shape to divide...)

loop over neighboring towers and increment weight for this tower with the energy of the seed tower

Loop over towers again

We've run out of seeds

If the weight for this tower has been incremented, then it's adjacent to a more energetic tower and already is clustered with it.

set momentum and a unique key

Definition at line 178 of file StEEmcClusterMaker.cxx.

References StEEmcCluster::add(), cluster(), StEEmcElement::energy(), StEEmcTower::etabin(), EEmcGeomSimple::getTowerCenter(), StEEmcTower::index(), mClusterId, mEEanalysis, mEEtow, mNumberOfClusters, StEEmcCluster::momentum(), mSeedEnergy, mTowerClusters, StEEmcElement::name(), StEEmcTower::neighbor(), StEEmcTower::numberOfNeighbors(), StEEmcCluster::print(), StEEmcTower::print(), StEEmcTower::sector(), and StEEmcTower::subsector().

Referenced by Make().

void StEEmcClusterMaker::Clear ( Option_t *  opts = ""  )  [virtual]

Clear clusters for next event.

Clear cluster storage

Reimplemented from StMaker.

Definition at line 158 of file StEEmcClusterMaker.cxx.

References mClusterId, mNumberOfClusters, mSmdClusters, and mTowerClusters.

StEEmcCluster StEEmcClusterMaker::cluster ( StEmcCluster cl  )  [inline]

Given a StEmcCluster, return the StEEmcCluster from whence it came.

Definition at line 53 of file StEEmcClusterMaker.h.

References mEtoEE.

void StEEmcClusterMaker::fillStEvent (  )  [protected]

Fills StEvent cluster collections if the option is selected.

First the eemc tower clusters

If we found clusters, create a cluster collection for this detector. Otherwise, nullify the cluster collection, otherwise we run into an assert somewhere out in "STAR" land... or maybe not,... no comments in barrel virtual finder...

Obtain the cluster collection from the detector, and prepare to fill it. If it doesn't exist, create it.

Loop over all EEMC sectors and fill collection

Loop over all clusters in this sector

for some reason, this code doesn't work when I call StEEmcCluster::stemc(), but works just fine here....

association between StEmcCluster and my class

now set the collection in the detector

Next the pre and postshower clusters

Loop over all EEMC sectors and fill collection

Loop over PQR

Loop over all clusters in this sector

for some reason, this code doesn't work when I call StEEmcCluster::stemc(), but works just fine here....

Finally the U&V smd clusters

Definition at line 552 of file StEEmcClusterMaker.cxx.

References cluster(), StEEmcCluster::energy(), StEEmcSmdCluster::key(), mEtoEE, mEtoEEsmd, mNumberOfClusters, StEEmcCluster::momentum(), mSmdClusters, mTowerClusters, StEEmcCluster::numberOfTowers(), StEEmcSmdCluster::stemc(), StEEmcCluster::stemc(), StEEmcElement::stemc(), StEEmcSmdCluster::strip(), and StEEmcCluster::tower().

Referenced by Make().

Int_t StEEmcClusterMaker::Make (  )  [virtual]

The Make() method is the one responsible for calling the maker's InitRun(). Note that that InitRun() is called for real data and if both of the following are true

  • a header exists
  • the run number changes

This is the ONLY place calling the InitRun() routine.

check privilege to skip event

Reimplemented from StMaker.

Int_t StEEmcClusterMaker::Make (  )  [virtual]

Make clusters for this event.

Warn if we couldn't build tower clusters

Warn if we couldn't build SMD clusters

If the option to fill StEvent is selected, do it

Verify that StEvent is a valid copy

Reimplemented from StMaker.

Definition at line 138 of file StEEmcClusterMaker.cxx.

References buildSmdClusters(), buildTowerClusters(), fillStEvent(), kStOK, kStWarn, mFillStEvent, and verifyStEvent().

void StEEmcClusterMaker::seedEnergy ( Float_t  energy,
Int_t  layer = 0 
)

Set the seed energy for the specified layer where 0=T, 1=P, 2=Q, 3=R, 4=U, 5=V

void StEEmcClusterMaker::seedEnergy ( Float_t  energy,
Int_t  layer = 0 
) [inline]

Set the seed energy for the specified layer where 0=T, 1=P, 2=Q, 3=R, 4=U, 5=V

Definition at line 35 of file StEEmcClusterMaker.h.

References mSeedEnergy.

Referenced by StEEmcClusterMaker().

void StEEmcClusterMaker::setFillStEvent (  )  [inline]

If called, will look for the presence of StEvent and fill the StEmcCollection.

Definition at line 65 of file StEEmcClusterMaker.h.

References mFillStEvent.

void StEEmcClusterMaker::setFillStEvent (  )  [inline]

If called, will look for the presence of StEvent and fill the StEmcCollection.

Definition at line 75 of file StEEmcClusterMaker.h.

References mFillStEvent.

void StEEmcClusterMaker::setSeedFloor ( Float_t  f = 2.0  ) 

Factor above which an smd strip must exceed the minimum "floor" energy in order to be considered a seed...

void StEEmcClusterMaker::setSeedFloor ( Float_t  f = 2.0  )  [inline]

Factor above which an smd strip must exceed the minimum "floor" energy in order to be considered a seed...

Definition at line 45 of file StEEmcClusterMaker.h.

References mSeedFloor.

StEEmcSmdCluster StEEmcClusterMaker::smdcluster ( StEmcCluster cl  )  [inline]

Given a StEmcCluster, return the StEEmcSmdCluster from whence it came.

Definition at line 56 of file StEEmcClusterMaker.h.

References mEtoEEsmd.

void StEEmcClusterMaker::suppress ( Int_t  n = 2  )  [inline]

Suppress seeds in the n strips on either side of an already identified smd cluster. Default = 0.

Definition at line 79 of file StEEmcClusterMaker.h.

References mSuppress.

Bool_t StEEmcClusterMaker::verifyStEvent (  )  [protected]

Verify that StEEmcCluster/StEEmcSmdCluster and StEmcCluster are equivalent

verify tower clusters

------------------------------------------------------------------------

Tower-cluster checksum

------------------------------------------------------------------------

SMD-cluster checksum

-----------------------

Definition at line 894 of file StEEmcClusterMaker.cxx.

References cluster(), StEEmcCluster::energy(), mNumberOfClusters, numberOfClusters(), numberOfSmdClusters(), and smdcluster().

Bool_t StEEmcClusterMaker::verifyStEvent (  )  const [protected]

Verify that StEEmcCluster/StEEmcSmdCluster and StEmcCluster are equivalent

verify tower clusters

------------------------------------------------------------------------

Tower-cluster checksum

------------------------------------------------------------------------

SMD-cluster checksum

-----------------------

Definition at line 810 of file StEEmcClusterMaker.cxx.

References cluster(), StEEmcCluster::energy(), mNumberOfClusters, numberOfClusters(), numberOfSmdClusters(), and smdcluster().

Referenced by Make().


Member Data Documentation

const EEmcSmdMap* StEEmcClusterMaker::mEEmap [protected]

  • pointer to tower to smd map

Definition at line 142 of file StEEmcClusterMaker.h.

Referenced by StEEmcClusterMaker().

  • pointer to smd geometry

Definition at line 141 of file StEEmcClusterMaker.h.

Referenced by StEEmcClusterMaker().

  • pointer to tower geometry

Definition at line 140 of file StEEmcClusterMaker.h.

Referenced by buildTowerClusters(), and StEEmcClusterMaker().

std::vector< std::vector< StEEmcTowerVec_t > > StEEmcClusterMaker::mSeedTowers [protected]

mSeedTowers[sec][layer] provides a list of tower elements which exceeded the user-specified seed.

Definition at line 104 of file StEEmcClusterMaker.h.

Referenced by StEEmcClusterMaker().

std::vector< std::vector< StEEmcSmdClusterVec_t > > StEEmcClusterMaker::mSmdClusters [protected]

mSmdClusters[sec][plane] provides a list of SMD clusters in the given sector for the given plane

Definition at line 112 of file StEEmcClusterMaker.h.

Referenced by Clear(), fillStEvent(), numberOfSmdClusters(), smdcluster(), smdclusters(), and StEEmcClusterMaker().

std::vector< std::vector< StEEmcClusterVec_t > > StEEmcClusterMaker::mTowerClusters [protected]

mTowerClusters[sec][layer] provides list of tower clusters at specified layer in the given sector, where the sector is determined by the seed tower.

Definition at line 109 of file StEEmcClusterMaker.h.

Referenced by buildTowerClusters(), Clear(), cluster(), clusters(), fillStEvent(), numberOfClusters(), and StEEmcClusterMaker().


The documentation for this class was generated from the following files:

Generated on Fri Feb 10 04:28:00 2012 for StRoot by  doxygen 1.5.9