StRoot  1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
StEpdEpFinder Class Reference

Public Member Functions

 StEpdEpFinder (int nEventTypeBins=10, char const *OutFileName="StEpdEpFinderCorrectionHistograms_OUTPUT.root", char const *CorrectionFileName="StEpdEpFinderCorrectionHistograms_INPUT.root")
 
void SetEtaWeights (int order, TH2D EtaWeight)
 
void SetRingWeights (int order, double *RingWeights)
 
void SetnMipThreshold (double thresh)
 
void SetMaxTileWeight (double MAX)
 
void SetEpdHitFormat (int format)
 
void Finish ()
 
StEpdEpInfo Results (TClonesArray *EpdHits, TVector3 primVertex, int EventTypeID)
 
TString Report ()
 

Detailed Description

Definition at line 100 of file StEpdEpFinder.h.

Constructor & Destructor Documentation

StEpdEpFinder::StEpdEpFinder ( int  nEventTypeBins = 10,
char const *  OutFileName = "StEpdEpFinderCorrectionHistograms_OUTPUT.root",
char const *  CorrectionFileName = "StEpdEpFinderCorrectionHistograms_INPUT.root" 
)

Constructor. Initializes values and reads correction file, if it exists. This file is actually PRODUCED by the code in an earlier run. The user must rename the file StEpdEpFinderCorrectionHistograms_OUTPUT.root if he wants to use it.

Parameters
CorrectionFileNameFull name of the .root file with correction histograms.
nEventTypeBinsNumber of EventType bins that the user is using. Up to the user to have a consistent usage, here and in analysis.

Definition at line 18 of file StEpdEpFinder.cxx.

Member Function Documentation

void StEpdEpFinder::Finish ( )

call this method at the end of your run to output correction histograms to a file (you can choose to use these or not) and to calculate EP resolutions

Definition at line 130 of file StEpdEpFinder.cxx.

TString StEpdEpFinder::Report ( )

Returns a big string that tells in text what the settings were. This is for your convenience and is of course optional. I like to put a concatenation of such Reports into a text file, so I "autodocument" what were the settings for a given run

Definition at line 418 of file StEpdEpFinder.cxx.

StEpdEpInfo StEpdEpFinder::Results ( TClonesArray *  EpdHits,
TVector3  primVertex,
int  EventTypeID 
)

returns all information about the EP. A large object of type StEpdEpInfo is returned, so you don't have to call the StEpdEpFinder over and over again for various information

Parameters
EpdHitsEpd Hits in a TClones array. Will be decoded as StEpdHit, StMuEpdHit, or StPicoEpdHit as dictated by mFormatUsed
primVertexprimary vertex position for this event
EventTypeIDuser-defined integer specifying EventType of the event. User must use same convention in correction histograms and weights

note the "+1" since EventTypeId begins at zero

note the "+1" since EventTypeId begins at zero

Definition at line 148 of file StEpdEpFinder.cxx.

References StPicoEpdHit::adc(), StPicoEpdHit::id(), StPicoEpdHit::nMIP(), StPicoEpdHit::position(), StPicoEpdHit::row(), and StPicoEpdHit::tile().

void StEpdEpFinder::SetEpdHitFormat ( int  format)
inline

sets the EpdHit format 0=StEvent, 1=StMuDst; 2=StPicoDst. Default is 2

Definition at line 198 of file StEpdEpFinder.h.

void StEpdEpFinder::SetEtaWeights ( int  order,
TH2D  EtaWeight 
)

sets eta-based weights and sets the flag indicating that eta-based weights will be used The x-axis of the TH2D is abs(eta). The y-axis is EventTypeID (according to whatever convention/definition the user is using)

Parameters
orderorder of the EP Begins at UNITY! i.e. order=1 means first-order plane, order=2 means 2nd-order plane, ...
EtaWeighthistogram with the weights as a function of |eta| and EventType

Definition at line 101 of file StEpdEpFinder.cxx.

void StEpdEpFinder::SetMaxTileWeight ( double  MAX)
inline

sets the maximum weight, in units of nMIP, for determining tile weights TileWeight = (EpdHit->nMIP()>thresh)?((EpdHit->nMIP()>MAX)?MAX:EpdHit->nMIP()):0;

Parameters
MAXmaximum tile weight. If epdHit->nMIP()>MAX then weight=MAX

Definition at line 197 of file StEpdEpFinder.h.

void StEpdEpFinder::SetnMipThreshold ( double  thresh)
inline

sets the threshold, in units of nMIP, for determining tile weights TileWeight = (EpdHit->nMIP()>thresh)?((EpdHit->nMIP()>MAX)?MAX:EpdHit->nMIP()):0;

Parameters
threshthreshold. If epdHit->nMIP() is less than thresh, then weight is zero

Definition at line 196 of file StEpdEpFinder.h.

void StEpdEpFinder::SetRingWeights ( int  order,
double *  RingWeights 
)

sets ring-based weights and sets the flag indicating that the ring-based weights will be used

Parameters
orderorder of the EP Begins at UNITY! i.e. order=1 means first-order plane, order=2 means 2nd-order plane, ...
RingWeights1D array of length 16, containing the RingWeights

Definition at line 115 of file StEpdEpFinder.cxx.


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