larg4::IonizationAndScintillation Class Reference

#include "IonizationAndScintillation.h"

Public Member Functions
void	Reset (const G4Step *step)
double	EnergyDeposit () const
double	VisibleEnergyDeposit () const
double	NumberIonizationElectrons () const
double	NumberScintillationPhotons () const
double	StepSizeLimit () const

Static Public Member Functions
static IonizationAndScintillation *	CreateInstance (CLHEP::HepRandomEngine &engine)
static IonizationAndScintillation *	Instance ()

Private Member Functions
	IonizationAndScintillation (CLHEP::HepRandomEngine &engine)
	~IonizationAndScintillation ()

Private Attributes
larg4::ISCalculation *	fISCalc
std::string	fISCalculator
	name of calculator to use, NEST or Separate More...
G4Step const *	fStep
	pointer to the current G4 step More...
int	fStepNumber
	last StepNumber checked More...
int	fTrkID
	last TrkID checked More...
TH1F *	fElectronsPerStep
	histogram of electrons per step More...
TH1F *	fStepSize
	histogram of the step sizes More...
TH1F *	fPhotonsPerStep
	histogram of the photons per step More...
TH1F *	fEnergyPerStep
	histogram of the energy deposited per step More...
TH1F *	fElectronsPerLength
	histogram of electrons per cm More...
TH1F *	fPhotonsPerLength
	histogram of photons per cm More...
TH1F *	fElectronsPerEDep
	histogram of electrons per MeV deposited More...
TH1F *	fPhotonsPerEDep
	histogram of photons per MeV deposited More...
TH2F *	fElectronsVsPhotons
	histogram of electrons vs photons per step More...
CLHEP::HepRandomEngine &	fEngine
	random engine More...

Detailed Description

Definition at line 25 of file IonizationAndScintillation.h.

Constructor & Destructor Documentation

larg4::IonizationAndScintillation::IonizationAndScintillation ( CLHEP::HepRandomEngine &  engine )

private

Definition at line 48 of file IonizationAndScintillation.cxx.

References fElectronsPerEDep, fElectronsPerLength, fElectronsPerStep, fElectronsVsPhotons, fEnergyPerStep, fEngine, fISCalc, fISCalculator, fPhotonsPerEDep, fPhotonsPerLength, fPhotonsPerStep, fStepNumber, fStepSize, fTrkID, larg4::ISCalculation::Initialize(), sim::LArG4Parameters::IonAndScintCalculator(), art::TFileDirectory::make(), and larg4::ISCalculation::Reset().

Referenced by Instance().

    : fISCalc(0)
    , fStep(0)
    , fElectronsPerStep(0)
    , fStepSize(0)
    , fPhotonsPerStep(0)
    , fEnergyPerStep(0)
    , fElectronsVsPhotons(0)
    , fEngine(engine)
  {
    art::ServiceHandle<sim::LArG4Parameters> lgp;
    fISCalculator = lgp->IonAndScintCalculator();

    if(fISCalculator.compare("NEST") == 0)
      fISCalc = new larg4::ISCalculationNEST(fEngine);
    else if(fISCalculator.compare("Separate") == 0)
      fISCalc = new larg4::ISCalculationSeparate(fEngine);
    else
      mf::LogWarning("IonizationAndScintillation") << "No ISCalculation set, this can't be good.";

    // Reset the values for the electrons, photons, and energy to 0
    // in the calculator
    fISCalc->Reset();
    //set the current track and step number values to bogus so that it will run the first reset:
    fStepNumber=-1;
    fTrkID=-1;

    // initialize the calculator
    fISCalc->Initialize();

    // make the histograms
    art::ServiceHandle< art::TFileService> tfs;

    fElectronsPerStep   = tfs->make<TH1F>("electronsPerStep", ";Electrons;Steps", 
                                          500, 0., 5000.);                      
    fPhotonsPerStep     = tfs->make<TH1F>("photonsPerStep", ";Photons;Steps",   
                                          500, 0., 5000.);                      
    fEnergyPerStep      = tfs->make<TH1F>("energyPerStep", ";Energy (MeV);Steps", 
                                          100, 0., 0.5);                                
    fStepSize           = tfs->make<TH1F>("stepSize", ";Step Size (CLHEP::cm);Steps",   
                                          500, 0., 0.2);                          
    fElectronsPerLength = tfs->make<TH1F>("electronsPerLength", ";Electrons #times 10^{3}/CLHEP::cm;Steps",
                                          1000, 0., 1000.);
    fPhotonsPerLength   = tfs->make<TH1F>("photonsPerLength", ";Photons #times 10^{3}/CLHEP::cm;Steps",
                                          1000, 0., 1000.);
    fElectronsPerEDep   = tfs->make<TH1F>("electronsPerEDep", ";Electrons #times 10^{3}/MeV;Steps",
                                          1000, 0., 1000.);
    fPhotonsPerEDep     = tfs->make<TH1F>("photonsPerEDep", ";Photons #times 10^{3}/MeV;Steps",
                                          1000, 0., 1000.);
                                          
    fElectronsVsPhotons = tfs->make<TH2F>("electronsVsPhotons", ";Photons;Electrons",
                                          500, 0., 5000., 500, 0., 5000.);

    return;
  }

larg4::IonizationAndScintillation::~IonizationAndScintillation ( )

private

Definition at line 105 of file IonizationAndScintillation.cxx.

References fISCalc.

  {
    if(fISCalc) delete fISCalc;
  }

Member Function Documentation

IonizationAndScintillation * larg4::IonizationAndScintillation::CreateInstance ( CLHEP::HepRandomEngine &  engine )

static

Definition at line 31 of file IonizationAndScintillation.cxx.

References larg4::gInstance.

Referenced by larg4::LArG4::beginJob().

  {
    if(!gInstance) gInstance = new IonizationAndScintillation(engine);
    return gInstance;
  }

double larg4::IonizationAndScintillation::EnergyDeposit ( ) const

inline

Definition at line 36 of file IonizationAndScintillation.h.

Referenced by larg4::LArVoxelReadout::DriftIonizationElectrons().

{ return fISCalc->EnergyDeposit();              }

IonizationAndScintillation * larg4::IonizationAndScintillation::Instance ( )

static

Definition at line 38 of file IonizationAndScintillation.cxx.

References larg4::gInstance, and IonizationAndScintillation().

Referenced by larg4::LArVoxelReadout::DriftIonizationElectrons(), larg4::LArVoxelReadoutGeometry::LArVoxelReadoutGeometry(), larg4::OpFastScintillation::PostStepDoIt(), larg4::LArVoxelReadout::ProcessHits(), larg4::OpFastScintillation::RecordPhotonsProduced(), and larg4::IonizationAndScintillationAction::SteppingAction().

  {
    // the instance must have been created already by CreateInstance()
    assert(gInstance);
    return gInstance;
  }

double larg4::IonizationAndScintillation::NumberIonizationElectrons ( ) const

inline

Definition at line 38 of file IonizationAndScintillation.h.

Referenced by larg4::LArVoxelReadout::DriftIonizationElectrons().

{ return fISCalc->NumberIonizationElectrons();  }

double larg4::IonizationAndScintillation::NumberScintillationPhotons ( ) const

inline

Definition at line 39 of file IonizationAndScintillation.h.

Referenced by larg4::OpFastScintillation::PostStepDoIt().

{ return fISCalc->NumberScintillationPhotons(); }

void larg4::IonizationAndScintillation::Reset

(

const G4Step *

step

)

Definition at line 112 of file IonizationAndScintillation.cxx.

References larg4::ISCalculation::CalculateIonizationAndScintillation(), larg4::ISCalculation::EnergyDeposit(), fElectronsPerEDep, fElectronsPerLength, fElectronsPerStep, fElectronsVsPhotons, fEnergyPerStep, fISCalc, fPhotonsPerEDep, fPhotonsPerLength, fPhotonsPerStep, fStep, fStepNumber, fStepSize, fTrkID, LOG_DEBUG, larg4::ISCalculation::NumberIonizationElectrons(), larg4::ISCalculation::NumberScintillationPhotons(), and larg4::ISCalculation::Reset().

Referenced by larg4::OpFastScintillation::PostStepDoIt(), larg4::LArVoxelReadout::ProcessHits(), and larg4::IonizationAndScintillationAction::SteppingAction().

  {

    if(fStepNumber==step->GetTrack()->GetCurrentStepNumber() && fTrkID==step->GetTrack()->GetTrackID())
      return;
    
    fStepNumber=step->GetTrack()->GetCurrentStepNumber(); 
    fTrkID=step->GetTrack()->GetTrackID();

    fStep = step;

    // reset the calculator
    fISCalc->Reset();

    // check the material for this step and be sure it is LAr
    if(step->GetTrack()->GetMaterial()->GetName() != "LAr") return;

    // double check that the energy deposit is non-zero
    // then do the calculation if it is
    if( step->GetTotalEnergyDeposit() > 0 ){
 
      fISCalc->CalculateIonizationAndScintillation(fStep);
    
      LOG_DEBUG("IonizationAndScintillation") << "Step Size: "   << fStep->GetStepLength()/CLHEP::cm
                                              << "\nEnergy: "    << fISCalc->EnergyDeposit()
                                              << "\nElectrons: " << fISCalc->NumberIonizationElectrons()
                                              << "\nPhotons: "   << fISCalc->NumberScintillationPhotons();

      G4ThreeVector totstep = fStep->GetPostStepPoint()->GetPosition();
      totstep -= fStep->GetPreStepPoint()->GetPosition();
      
      // Fill the histograms
      fStepSize          ->Fill(totstep.mag()/CLHEP::cm);
      fEnergyPerStep     ->Fill(fISCalc->EnergyDeposit());
      fElectronsPerStep  ->Fill(fISCalc->NumberIonizationElectrons());
      fPhotonsPerStep    ->Fill(fISCalc->NumberScintillationPhotons());
      fElectronsVsPhotons->Fill(fISCalc->NumberScintillationPhotons(), 
                                fISCalc->NumberIonizationElectrons());
      double const stepSize = totstep.mag()/CLHEP::cm;
      if (stepSize > 0.0) {
        fElectronsPerLength->Fill(fISCalc->NumberIonizationElectrons()*1.e-3/stepSize);
        fPhotonsPerLength  ->Fill(fISCalc->NumberScintillationPhotons()*1.e-3/stepSize);
      }
      double const energyDep = fISCalc->EnergyDeposit();
      if (energyDep) {
        fElectronsPerEDep  ->Fill(fISCalc->NumberIonizationElectrons()*1.e-3/energyDep);
        fPhotonsPerEDep    ->Fill(fISCalc->NumberScintillationPhotons()*1.e-3/energyDep);
      }

    } // end if the energy deposition is non-zero

    return;
  }

double larg4::IonizationAndScintillation::StepSizeLimit ( ) const

inline

Definition at line 40 of file IonizationAndScintillation.h.

Referenced by larg4::LArVoxelReadoutGeometry::LArVoxelReadoutGeometry().

{ return fISCalc->StepSizeLimit();              }

double larg4::IonizationAndScintillation::VisibleEnergyDeposit ( ) const

inline

Definition at line 37 of file IonizationAndScintillation.h.

Referenced by larg4::OpFastScintillation::RecordPhotonsProduced().

{ return fISCalc->VisibleEnergyDeposit();       }

Member Data Documentation

TH1F* larg4::IonizationAndScintillation::fElectronsPerEDep

private

histogram of electrons per MeV deposited

Definition at line 60 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

TH1F* larg4::IonizationAndScintillation::fElectronsPerLength

private

histogram of electrons per cm

Definition at line 58 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

TH1F* larg4::IonizationAndScintillation::fElectronsPerStep

private

histogram of electrons per step

Definition at line 54 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

TH2F* larg4::IonizationAndScintillation::fElectronsVsPhotons

private

histogram of electrons vs photons per step

Definition at line 62 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

TH1F* larg4::IonizationAndScintillation::fEnergyPerStep

private

histogram of the energy deposited per step

Definition at line 57 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

CLHEP::HepRandomEngine& larg4::IonizationAndScintillation::fEngine

private

random engine

Definition at line 63 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation().

larg4::ISCalculation* larg4::IonizationAndScintillation::fISCalc

private

object to calculate ionization and scintillation produced by an energy deposition

Definition at line 47 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), Reset(), and ~IonizationAndScintillation().

std::string larg4::IonizationAndScintillation::fISCalculator

private

name of calculator to use, NEST or Separate

Definition at line 49 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation().

TH1F* larg4::IonizationAndScintillation::fPhotonsPerEDep

private

histogram of photons per MeV deposited

Definition at line 61 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

TH1F* larg4::IonizationAndScintillation::fPhotonsPerLength

private

histogram of photons per cm

Definition at line 59 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

TH1F* larg4::IonizationAndScintillation::fPhotonsPerStep

private

histogram of the photons per step

Definition at line 56 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

G4Step const* larg4::IonizationAndScintillation::fStep

private

pointer to the current G4 step

Definition at line 50 of file IonizationAndScintillation.h.

Referenced by Reset().

int larg4::IonizationAndScintillation::fStepNumber

private

last StepNumber checked

Definition at line 51 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

TH1F* larg4::IonizationAndScintillation::fStepSize

private

histogram of the step sizes

Definition at line 55 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

int larg4::IonizationAndScintillation::fTrkID

private

last TrkID checked

Definition at line 52 of file IonizationAndScintillation.h.

Referenced by IonizationAndScintillation(), and Reset().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/LArG4/IonizationAndScintillation.h
• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/LArG4/IonizationAndScintillation.cxx