Par02Output Class Reference

Handling the saving to the file. More...

#include <Doxymodules_parameterisations.h>

Public Types
enum	SaveType {   eNoSave , eSaveMC , eSaveTracker , eSaveEMCal ,   eSaveHCal }
	Indicates to which ntuple to save the information. More...

Public Member Functions
void	SetFileName (G4String name)
	Sets the file name of the output root file.
G4String	GetFileName ()
	Gets the file name of the output root file.
void	AppendName (G4bool app)
	Sets fFileNameWithRunNo that indicates whether to add the run number to the file name.
void	StartAnalysis (G4int runID)
	Calls the G4AnalysisManager::Instance().
void	EndAnalysis ()
	Calls the G4AnalysisManager::Instance().
void	CreateNtuples ()
	Creates Ntuples used to store information about particle (its ID, PDG code, energy deposits, etc.).
void	CreateHistograms ()
	Creates histograms to combine information from all the events in the run.
void	SaveTrack (SaveType aWhatToSave, G4int aPartID, G4int aPDG, G4ThreeVector aVector, G4double aResolution=0, G4double aEfficiency=1, G4double aEnergy=0)
	Saves the information about the particle (track).
void	FillHistogram (G4int HNo, G4double value) const
	Fills the histogram.
	~Par02Output ()

Static Public Member Functions
static Par02Output *	Instance ()
	Allows the access to the unique Par02Output object.

Protected Member Functions
	Par02Output ()
	A default, protected constructor (due to singleton pattern).

Private Attributes
G4String	fFileName
	A name of the output root file.
G4bool	fFileNameWithRunNo
	If true, a run number should be added to the file. Default: false.

Static Private Attributes
static Par02Output *	fPar02Output = nullptr
	The pointer to the only Par02Output class object.
static G4ThreadLocal G4int	fCurrentNtupleId = 0
	Current ntuple Id.
static G4ThreadLocal G4int	fCurrentID = 0
	A control value of particle ID to ensure that data saved to various ntuples match the same particle.

Detailed Description

Handling the saving to the file.

A singleton class that manages creation, writing to and closing of the Root output file.

Author

Anna Zaborowska

Definition at line 44 of file Doxymodules_parameterisations.h.

Member Enumeration Documentation

SaveType

enum Par02Output::SaveType

Indicates to which ntuple to save the information.

Enumerator
eNoSave
eSaveMC
eSaveTracker
eSaveEMCal
eSaveHCal

Definition at line 46 of file Par02Output.hh.

{ eNoSave, eSaveMC, eSaveTracker, eSaveEMCal, eSaveHCal };

Constructor & Destructor Documentation

~Par02Output()

Par02Output::~Par02Output ( )

default

Par02Output()

Par02Output::Par02Output ( )

protected

A default, protected constructor (due to singleton pattern).

Definition at line 47 of file Par02Output.cc.

                         : fFileNameWithRunNo( false ) {
  fFileName = "DefaultOutput.root";
}

Member Function Documentation

Instance()

Par02Output * Par02Output::Instance ( )

static

Allows the access to the unique Par02Output object.

Returns

A pointer to the Par02Output class.

Definition at line 57 of file Par02Output.cc.

                                   {
  if ( ! fPar02Output ) {
    fPar02Output = new Par02Output();
  }
  return fPar02Output;
}

SetFileName()

void Par02Output::SetFileName

(

G4String

name

)

Sets the file name of the output root file.

Parameters

name	The name of the file.

Definition at line 66 of file Par02Output.cc.

                                              {
  fFileName = aName;
}

GetFileName()

G4String Par02Output::GetFileName

(

)

Gets the file name of the output root file.

Returns

The name of the file.

Definition at line 78 of file Par02Output.cc.

                                  {
  return fFileName;
}

AppendName()

void Par02Output::AppendName

(

G4bool

app

)

Sets fFileNameWithRunNo that indicates whether to add the run number to the file name.

Parameters

app	If add the run number.

Definition at line 72 of file Par02Output.cc.

                                          {
  fFileNameWithRunNo = aApp;
}

StartAnalysis()

void Par02Output::StartAnalysis

(

G4int

runID

)

Calls the G4AnalysisManager::Instance().

It sets the file name of the output file based on fFileName and fFileNameWithRunNo and opens the file.

Parameters

runID

A run number (to be added to file name if fFileNameWithRunNo is true).

Definition at line 84 of file Par02Output.cc.

                                              {
  G4AnalysisManager* analysisManager = G4AnalysisManager::Instance();
  if ( fFileNameWithRunNo ) {
    fFileName +=  "_run";
    fFileName += G4UIcommand::ConvertToString( aRunID );
  }
  analysisManager->SetDefaultFileType("root");
  analysisManager->SetVerboseLevel( 1 );
  analysisManager->SetFileName( fFileName );
  analysisManager->OpenFile( fFileName );
}

EndAnalysis()

void Par02Output::EndAnalysis

(

)

Calls the G4AnalysisManager::Instance().

It writes to the output file and close it.

Definition at line 98 of file Par02Output.cc.

                              {
  G4AnalysisManager* analysisManager = G4AnalysisManager::Instance();
  analysisManager->Write();
  analysisManager->CloseFile();
}

CreateNtuples()

void Par02Output::CreateNtuples

(

)

Creates Ntuples used to store information about particle (its ID, PDG code, energy deposits, etc.).

To be called for each event in Par02EventAction.

Definition at line 106 of file Par02Output.cc.

                                {
  const G4Event* event = G4RunManager::GetRunManager()->GetCurrentEvent();
  G4String evName = "Event_";
  evName += G4UIcommand::ConvertToString( event->GetEventID() );
  G4AnalysisManager* analysisManager = G4AnalysisManager::Instance();
  fCurrentNtupleId = analysisManager->CreateNtuple( evName, evName );
 
  analysisManager->CreateNtupleIColumn( "particleID" );  // column Id = 0
  analysisManager->CreateNtupleIColumn( "PID" );  // column Id = 1
  analysisManager->CreateNtupleDColumn( "MC_pX" );  // column Id = 2
  analysisManager->CreateNtupleDColumn( "MC_pY" ); // column Id = 3
  analysisManager->CreateNtupleDColumn( "MC_pZ" ); // column Id = 4
 
  analysisManager->CreateNtupleDColumn( "tracker_res" ); // column Id = 5
  analysisManager->CreateNtupleDColumn( "tracker_eff" ); // column Id = 6
  analysisManager->CreateNtupleDColumn( "tracker_pX" );  // column Id = 7
  analysisManager->CreateNtupleDColumn( "tracker_pY" ); // column Id = 8
  analysisManager->CreateNtupleDColumn( "tracker_pZ" ); // column Id = 9
 
  analysisManager->CreateNtupleDColumn( "emcal_res" ); // column Id = 10
  analysisManager->CreateNtupleDColumn( "emcal_eff" );  // column Id = 11
  analysisManager->CreateNtupleDColumn( "emcal_X" );  // column Id = 12
  analysisManager->CreateNtupleDColumn( "emcal_Y" ); // column Id = 13
  analysisManager->CreateNtupleDColumn( "emcal_Z" ); // column Id = 14
  analysisManager->CreateNtupleDColumn( "emcal_E" ); // column Id = 15
 
  analysisManager->CreateNtupleDColumn( "hcal_res" ); // column Id = 16
  analysisManager->CreateNtupleDColumn( "hcal_eff" ); // column Id = 17
  analysisManager->CreateNtupleDColumn( "hcal_X" );  // column Id = 18
  analysisManager->CreateNtupleDColumn( "hcal_Y" ); // column Id = 19
  analysisManager->CreateNtupleDColumn( "hcal_Z" ); // column Id = 20
  analysisManager->CreateNtupleDColumn( "hcal_E" );  // column Id = 21
 
  analysisManager->FinishNtuple( fCurrentNtupleId );
}

CreateHistograms()

void Par02Output::CreateHistograms

(

)

Creates histograms to combine information from all the events in the run.

To be called for each run in Par02RunAction.

Definition at line 144 of file Par02Output.cc.

{
  G4AnalysisManager* analysisManager = G4AnalysisManager::Instance();
  analysisManager->CreateH1( "Pdiff", "momentum smeared in tracker", 100, 0.8, 1.2 );
  analysisManager->SetH1XAxisTitle( 0, "p_{smeared}/p_{true}" );
  analysisManager->SetH1YAxisTitle( 0, "Entries" );
  analysisManager->CreateH1( "EMCalEdiff", "energy smeared in EMCal", 100, 0.8, 1.2 );
  analysisManager->SetH1XAxisTitle( 1, "E_{smeared}/E_{true}" );
  analysisManager->SetH1YAxisTitle( 1, "Entries" );
  analysisManager->CreateH1( "HCalEdiff", "energy smeared in HCal", 100, 0.0, 2.0 );
  analysisManager->SetH1XAxisTitle( 2, "E_{smeared}/E_{true}" );
  analysisManager->SetH1YAxisTitle( 2, "Entries" );
}

SaveTrack()

void Par02Output::SaveTrack	(	SaveType	aWhatToSave,
		G4int	aPartID,
		G4int	aPDG,
		G4ThreeVector	aVector,
		G4double	aResolution = 0,
		G4double	aEfficiency = 1,
		G4double	aEnergy = 0
	)

Saves the information about the particle (track).

Parameters

aWhatToSave	enum indicating what kind of information to store (in which ntuple).
aPartID	A unique ID within event (taken Geant TrackID).
aPDG	A PDG code of a particle.
aVector	A vector to be stored (particle momentum in tracker or position of energy deposit in calorimeter).
aResolution	A resolution of the detector that was used.
aEfficiency	An efficiency of the detector that was used.
aEnergy	An energy deposit (for calorimeters only: Par02Output::SaveType::eEMCal or Par02Output::SaveType::eHCal).

Definition at line 160 of file Par02Output.cc.

                                                                      {
  G4AnalysisManager* analysisManager = G4AnalysisManager::Instance();
  switch( aWhatToSave ) {
    case Par02Output::eNoSave :
      break;
    case Par02Output::eSaveMC : {
      analysisManager->FillNtupleIColumn( fCurrentNtupleId, 0, aPartID );
      analysisManager->FillNtupleIColumn( fCurrentNtupleId, 1, aPDG );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 2, aVector.x() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 3, aVector.y() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 4, aVector.z() );
      fCurrentID = aPartID;
      break;
    }
    case Par02Output::eSaveTracker : {
      if ( aPartID != fCurrentID ) G4cout << 
        " Wrong particle - trying to save Tracker information of different particle"
        << G4endl;
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 5, aResolution );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 6, aEfficiency );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 7, aVector.x() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 8, aVector.y() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 9, aVector.z() );
      break;
    }
    case Par02Output::eSaveEMCal : {
      if ( aPartID != fCurrentID ) G4cout <<
        " Wrong particle - trying to save EMCal information of different particle"
        << G4endl;
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 10, aResolution );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 11, aEfficiency );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 12, aVector.x() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 13, aVector.y() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 14, aVector.z() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 15, aEnergy );
      break;
    }
    case Par02Output::eSaveHCal : {
      if ( aPartID != fCurrentID ) G4cout <<
        " Wrong particle - trying to save HCal information of different particle"
        << G4endl;
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 16, aResolution );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 17, aEfficiency );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 18, aVector.x() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 19, aVector.y() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 20, aVector.z() );
      analysisManager->FillNtupleDColumn( fCurrentNtupleId, 21, aEnergy );
      analysisManager->AddNtupleRow( fCurrentNtupleId );
      break;
    }
  }
}

FillHistogram()

void Par02Output::FillHistogram	(	G4int	HNo,
		G4double	value
	)		const

Fills the histogram.

Parameters

HNo	Number of a histogram (decided by the order of creation in CreateHistograms(), the first one is 0).
value	A value to be filled into the histogram.

Definition at line 217 of file Par02Output.cc.

                                                                      {
  G4AnalysisManager* analysisManager = G4AnalysisManager::Instance();
  analysisManager->FillH1( aHistNo, aValue );
}

Member Data Documentation

fPar02Output

Par02Output * Par02Output::fPar02Output = nullptr

staticprivate

The pointer to the only Par02Output class object.

Definition at line 114 of file Par02Output.hh.

fCurrentNtupleId

G4ThreadLocal G4int Par02Output::fCurrentNtupleId = 0

staticprivate

Current ntuple Id.

Definition at line 117 of file Par02Output.hh.

fFileName

G4String Par02Output::fFileName

private

A name of the output root file.

Definition at line 120 of file Par02Output.hh.

fFileNameWithRunNo

G4bool Par02Output::fFileNameWithRunNo

private

If true, a run number should be added to the file. Default: false.

Definition at line 123 of file Par02Output.hh.

fCurrentID

G4ThreadLocal G4int Par02Output::fCurrentID = 0

staticprivate

A control value of particle ID to ensure that data saved to various ntuples match the same particle.

It is set when Monte Carlo information is saved and checked for all the detectors.

Definition at line 128 of file Par02Output.hh.

---

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

• .doxygen/Doxymodules_parameterisations.h
• extended/parameterisations/Par02/include/Par02Output.hh
• extended/parameterisations/Par02/src/Par02Output.cc