REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Loading...
Searching...
No Matches
TRestDetectorElectronDiffusionProcess Class Reference

Detailed Description




         RESTSoft : Software for Rare Event Searches with TPCs

         TRestDetectorElectronDiffusionProcess.h

Definition at line 21 of file TRestDetectorElectronDiffusionProcess.h.

#include <TRestDetectorElectronDiffusionProcess.h>

Inheritance diagram for TRestDetectorElectronDiffusionProcess:
TRestEventProcess TRestMetadata

Public Member Functions

 ClassDefOverride (TRestDetectorElectronDiffusionProcess, 5)
void EndProcess () override
 To be executed at the end of the run (outside event loop).
Double_t GetAttachmentCoefficient () const
Double_t GetElectricField () const
Double_t GetGasPressure () const
RESTValue GetInputEvent () const override
 Get pointer to input event. Must be implemented in the derived class.
RESTValue GetOutputEvent () const override
 Get pointer to output event. Must be implemented in the derived class.
TRestMetadata * GetProcessMetadata () const
const char * GetProcessName () const override
void InitProcess () override
 To be executed at the beginning of the run (outside event loop).
void LoadConfig (const std::string &configFilename, const std::string &name="")
void PrintMetadata () override
 Implemented it in the derived metadata class to print out specific metadata information.
TRestEvent * ProcessEvent (TRestEvent *inputEvent) override
 Process one event.
 TRestDetectorElectronDiffusionProcess (const char *configFilename)
Public Member Functions inherited from TRestEventProcess
virtual Bool_t AddInputFile (const std::string &file)
bool ApplyCut ()
 Apply cut according to the cut conditions saved in fCut.
virtual void BeginOfEventProcess (TRestEvent *inputEvent=nullptr)
 Begin of event process, preparation work. Called right before ProcessEvent().
 ClassDefOverride (TRestEventProcess, 3)
virtual void EndOfEventProcess (TRestEvent *inputEvent=nullptr)
 End of event process. Nothing to do. Called directly after ProcessEvent().
TRestAnalysisTree * GetAnalysisTree () const
 Return the local analysis tree (dummy).
TCanvas * GetCanvas () const
 Get canvas.
TRestAnalysisTree * GetFullAnalysisTree ()
 Get the full analysis tree from TRestRun, with non-empty entries.
std::vector< std::string > GetListOfAddedObservables ()
 Get list of observables, convert map to vector.
TRestRun * GetRunInfo () const
 Return the pointer of the hosting TRestRun object.
virtual Long64_t GetTotalBytes () const
virtual Long64_t GetTotalBytesRead () const
 Interface to external file reading, get the read bytes. To be implemented in external processes.
Bool_t isExternal () const
 Return whether this process is external process.
Int_t LoadSectionMetadata () override
 Load extra section metadata: outputlevel after calling TRestMetadata::LoadSectionMetadata().
virtual void NotifyAnalysisTreeReset ()
 In case the analysis tree is reset(switched to new file), some process needs to have action.
virtual Bool_t OpenInputFiles (const std::vector< std::string > &files)
 Interface to external file reading, open input file. To be implemented in external processes.
std::vector< std::string > ReadObservables ()
void RegisterAllObservables (Bool_t value=true)
virtual Bool_t ResetEntry ()
void SetAnalysisTree (TRestAnalysisTree *tree)
 Set analysis tree of this process, then add observables to it.
void SetCanvasSize (Int_t x, Int_t y)
 Set canvas size.
void SetFriendProcess (TRestEventProcess *p)
 Add friendly process to this process.
void SetObservableValidation (bool validate)
void SetParallelProcess (TRestEventProcess *p)
 Add parallel process to this process.
void SetRunInfo (TRestRun *r)
 Set TRestRun for this process.
Bool_t singleThreadOnly () const
 Return whether this process is single std::thread only.
 TRestEventProcess ()
 ~TRestEventProcess ()

Protected Attributes

Double_t fAttachment
Bool_t fCheckIsInside = true
Double_t fElectricField
Double_t fFanoFactor
Double_t fGasPressure
Double_t fLongitudinalDiffusionCoefficient
UInt_t fMaxHits
Bool_t fPoissonElectronExcitation = false
UInt_t fSeed = 0
Double_t fTransversalDiffusionCoefficient
Bool_t fUnitElectronEnergy
Bool_t fUseFanoFactor = false
Double_t fWValue
Protected Attributes inherited from TRestEventProcess
TRestAnalysisTree * fAnalysisTree = nullptr
TCanvas * fCanvas = nullptr
 < Canvas for some viewer event
TVector2 fCanvasSize
 Canvas size.
std::vector< std::pair< std::string, TVector2 > > fCuts
 Stores cut definitions. Any listed observables should be in the range.
bool fDynamicObs = false
 It defines whether to use added observables only or all the observables appear in the code.
bool fIsExternal = false
 It defines if the process reads event data from an external source.
std::map< std::string, int > fObservablesDefined
 Stores the list of all the appeared process observables in the code.
std::map< std::string, int > fObservablesUpdated
 Stores the list of process observables updated when processing this event.
bool fReadOnly = false
 not used, keep for compatibility
TRestRun * fRunInfo = nullptr
 < Pointer to TRestRun object where to find metadata.
bool fSingleThreadOnly = false
bool fValidateObservables = false
 It defines if observable names should be added to the validation list.

Private Member Functions

void InitFromConfigFile () override
 To make settings from rml file. This method must be implemented in the derived class.
void Initialize () override
 Making default settings.
void LoadDefaultConfig ()

Private Attributes

TRestDetectorGas * fGas
TRestDetectorHitsEvent * fInputHitsEvent
TRestDetectorHitsEvent * fOutputHitsEvent
TRandom3 * fRandom
TRestDetectorReadout * fReadout

Additional Inherited Members

Protected Types inherited from TRestEventProcess
enum  REST_Process_Output { No_Output , Observable , Internal_Var , Full_Output }
Protected Member Functions inherited from TRestEventProcess
void BeginPrintProcess ()
 [name, cut range]
void CreateCanvas ()
 Create the canvas.
void EndPrintProcess ()
 Pre-defined printer, can be used at the ending in the implementation of PrintMetadata().
TRestEventProcess * GetFriend (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
TRestEventProcess * GetFriendLive (const std::string &nameOrType)
 Get friendly TRestEventProcess object.
template<class T>
T * GetMetadata ()
 Get a metadata object from the host TRestRun.
TRestMetadata * GetMetadata (const std::string &nameOrType)
 Get a metadata object from the host TRestRun.
size_t GetNumberOfParallelProcesses () const
template<class T>
T GetObservableValue (const std::string &name)
TRestEventProcess * GetParallel (int i)
 Get a list of parallel processes from this process.
template<class T>
std::vector< T > GetParallelDataMembers (T *member_of_process)
 Get a list of data members from parallel processes which is same to this process's certain data member.
template<class T>
void SetObservableValue (const std::string &name, const T &value)
 Set observable value for AnalysisTree.

Constructor & Destructor Documentation

◆ TRestDetectorElectronDiffusionProcess() [1/2]

TRestDetectorElectronDiffusionProcess::TRestDetectorElectronDiffusionProcess ( )

Definition at line 22 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ TRestDetectorElectronDiffusionProcess() [2/2]

TRestDetectorElectronDiffusionProcess::TRestDetectorElectronDiffusionProcess ( const char * configFilename)

Definition at line 24 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ ~TRestDetectorElectronDiffusionProcess()

TRestDetectorElectronDiffusionProcess::~TRestDetectorElectronDiffusionProcess ( )

Definition at line 31 of file TRestDetectorElectronDiffusionProcess.cxx.

Member Function Documentation

◆ EndProcess()

void TRestDetectorElectronDiffusionProcess::EndProcess ( )
overridevirtual

To be executed at the end of the run (outside event loop).

Reimplemented from TRestEventProcess.

Definition at line 293 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ GetAttachmentCoefficient()

Double_t TRestDetectorElectronDiffusionProcess::GetAttachmentCoefficient ( ) const
inline

Definition at line 86 of file TRestDetectorElectronDiffusionProcess.h.

◆ GetElectricField()

Double_t TRestDetectorElectronDiffusionProcess::GetElectricField ( ) const
inline

Definition at line 85 of file TRestDetectorElectronDiffusionProcess.h.

◆ GetGasPressure()

Double_t TRestDetectorElectronDiffusionProcess::GetGasPressure ( ) const
inline

Definition at line 87 of file TRestDetectorElectronDiffusionProcess.h.

◆ GetInputEvent()

RESTValue TRestDetectorElectronDiffusionProcess::GetInputEvent ( ) const
inlineoverridevirtual

Get pointer to input event. Must be implemented in the derived class.

Implements TRestEventProcess.

Definition at line 53 of file TRestDetectorElectronDiffusionProcess.h.

◆ GetOutputEvent()

RESTValue TRestDetectorElectronDiffusionProcess::GetOutputEvent ( ) const
inlineoverridevirtual

Get pointer to output event. Must be implemented in the derived class.

Implements TRestEventProcess.

Definition at line 54 of file TRestDetectorElectronDiffusionProcess.h.

◆ GetProcessMetadata()

TRestMetadata * TRestDetectorElectronDiffusionProcess::GetProcessMetadata ( ) const
inline

Definition at line 81 of file TRestDetectorElectronDiffusionProcess.h.

◆ GetProcessName()

const char * TRestDetectorElectronDiffusionProcess::GetProcessName ( ) const
inlineoverridevirtual

Implements TRestEventProcess.

Definition at line 83 of file TRestDetectorElectronDiffusionProcess.h.

◆ InitFromConfigFile()

void TRestDetectorElectronDiffusionProcess::InitFromConfigFile ( )
overrideprivatevirtual

To make settings from rml file. This method must be implemented in the derived class.

Reimplemented from TRestEventProcess.

Definition at line 295 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ Initialize()

void TRestDetectorElectronDiffusionProcess::Initialize ( )
overrideprivatevirtual

Making default settings.

Reimplemented from TRestMetadata.

Definition at line 41 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ InitProcess()

void TRestDetectorElectronDiffusionProcess::InitProcess ( )
overridevirtual

To be executed at the beginning of the run (outside event loop).

Reimplemented from TRestEventProcess.

Definition at line 69 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ LoadConfig()

void TRestDetectorElectronDiffusionProcess::LoadConfig ( const std::string & configFilename,
const std::string & name = "" )

Definition at line 63 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ LoadDefaultConfig()

void TRestDetectorElectronDiffusionProcess::LoadDefaultConfig ( )
private

Definition at line 33 of file TRestDetectorElectronDiffusionProcess.cxx.

◆ PrintMetadata()

void TRestDetectorElectronDiffusionProcess::PrintMetadata ( )
inlineoverridevirtual

Implemented it in the derived metadata class to print out specific metadata information.

Prints metadata content on screen. Usually overloaded by the derived metadata class.

Reimplemented from TRestMetadata.

Definition at line 62 of file TRestDetectorElectronDiffusionProcess.h.

◆ ProcessEvent()

TRestEvent * TRestDetectorElectronDiffusionProcess::ProcessEvent ( TRestEvent * inputEvent)
overridevirtual

Process one event.

Implements TRestEventProcess.

Definition at line 135 of file TRestDetectorElectronDiffusionProcess.cxx.

Field Documentation

◆ fAttachment

Double_t TRestDetectorElectronDiffusionProcess::fAttachment
protected

Definition at line 39 of file TRestDetectorElectronDiffusionProcess.h.

◆ fCheckIsInside

Bool_t TRestDetectorElectronDiffusionProcess::fCheckIsInside = true
protected

Definition at line 48 of file TRestDetectorElectronDiffusionProcess.h.

◆ fElectricField

Double_t TRestDetectorElectronDiffusionProcess::fElectricField
protected

Definition at line 38 of file TRestDetectorElectronDiffusionProcess.h.

◆ fFanoFactor

Double_t TRestDetectorElectronDiffusionProcess::fFanoFactor
protected

Definition at line 42 of file TRestDetectorElectronDiffusionProcess.h.

◆ fGas

TRestDetectorGas* TRestDetectorElectronDiffusionProcess::fGas
private

Definition at line 26 of file TRestDetectorElectronDiffusionProcess.h.

◆ fGasPressure

Double_t TRestDetectorElectronDiffusionProcess::fGasPressure
protected

Definition at line 40 of file TRestDetectorElectronDiffusionProcess.h.

◆ fInputHitsEvent

TRestDetectorHitsEvent* TRestDetectorElectronDiffusionProcess::fInputHitsEvent
private

Definition at line 23 of file TRestDetectorElectronDiffusionProcess.h.

◆ fLongitudinalDiffusionCoefficient

Double_t TRestDetectorElectronDiffusionProcess::fLongitudinalDiffusionCoefficient
protected

Definition at line 43 of file TRestDetectorElectronDiffusionProcess.h.

◆ fMaxHits

UInt_t TRestDetectorElectronDiffusionProcess::fMaxHits
protected

Definition at line 46 of file TRestDetectorElectronDiffusionProcess.h.

◆ fOutputHitsEvent

TRestDetectorHitsEvent* TRestDetectorElectronDiffusionProcess::fOutputHitsEvent
private

Definition at line 24 of file TRestDetectorElectronDiffusionProcess.h.

◆ fPoissonElectronExcitation

Bool_t TRestDetectorElectronDiffusionProcess::fPoissonElectronExcitation = false
protected

Definition at line 50 of file TRestDetectorElectronDiffusionProcess.h.

◆ fRandom

TRandom3* TRestDetectorElectronDiffusionProcess::fRandom
private

Definition at line 29 of file TRestDetectorElectronDiffusionProcess.h.

◆ fReadout

TRestDetectorReadout* TRestDetectorElectronDiffusionProcess::fReadout
private

Definition at line 27 of file TRestDetectorElectronDiffusionProcess.h.

◆ fSeed

UInt_t TRestDetectorElectronDiffusionProcess::fSeed = 0
protected

Definition at line 47 of file TRestDetectorElectronDiffusionProcess.h.

◆ fTransversalDiffusionCoefficient

Double_t TRestDetectorElectronDiffusionProcess::fTransversalDiffusionCoefficient
protected

Definition at line 44 of file TRestDetectorElectronDiffusionProcess.h.

◆ fUnitElectronEnergy

Bool_t TRestDetectorElectronDiffusionProcess::fUnitElectronEnergy
protected

Definition at line 45 of file TRestDetectorElectronDiffusionProcess.h.

◆ fUseFanoFactor

Bool_t TRestDetectorElectronDiffusionProcess::fUseFanoFactor = false
protected

Definition at line 49 of file TRestDetectorElectronDiffusionProcess.h.

◆ fWValue

Double_t TRestDetectorElectronDiffusionProcess::fWValue
protected

Definition at line 41 of file TRestDetectorElectronDiffusionProcess.h.


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