gar::rosim::IonizationAndScintillation Class Reference

#include <IonizationAndScintillation.h>

Public Member Functions
void	Reset (const gar::sdp::EnergyDeposit *dep)
void	reconfigure (fhicl::ParameterSet const &pset)
double	EnergyDeposit () const
int	NumberIonizationElectrons () const
int	NumberScintillationPhotons () const
double	StepSizeLimit () const

Static Public Member Functions
static IonizationAndScintillation *	CreateInstance (CLHEP::HepRandomEngine &engine, fhicl::ParameterSet const &pset)
static IonizationAndScintillation *	Instance ()

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

Private Attributes
rosim::ISCalculation *	fISCalc
	produced by an energy deposition More...
std::string	fISCalculator
	name of calculator to use, NEST or Separate More...
const gar::sdp::EnergyDeposit *	fEnergyDeposit
	reference to the current energy deposit More...
int	fStepNumber
	last StepNumber checked More...
int	fTrkID
	last TrkID checked More...
TH1F *	fStepSize
	histogram of the step sizes More...
TH1F *	fElectronsPerStep
	histogram of electrons per step More...
TH1F *	fPhotonsPerStep
	histogram of the photons per step More...
TH1F *	fElectronsPerLength
	histogram of electrons per dX More...
TH1F *	fPhotonsPerLength
	histogram of the photons per dX More...
TH1F *	fEnergyPerStep
	histogram of the energy deposited per step 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 28 of file IonizationAndScintillation.h.

Constructor & Destructor Documentation

gar::rosim::IonizationAndScintillation::IonizationAndScintillation ( CLHEP::HepRandomEngine &  engine )

private

Definition at line 52 of file IonizationAndScintillation.cxx.

      : fISCalc            (nullptr)
      , fEnergyDeposit     (nullptr)
      , fStepSize          (nullptr)
      , fElectronsPerStep  (nullptr)
      , fPhotonsPerStep    (nullptr)
      , fEnergyPerStep     (nullptr)
      , fElectronsVsPhotons(nullptr)
      , fEngine            (engine)
      {

        //set the current track and step number values to bogus so that it will run the first reset:
        fStepNumber = -1;
        fTrkID      = -1;

        // 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;
      }

gar::rosim::IonizationAndScintillation::~IonizationAndScintillation ( )

private

Definition at line 94 of file IonizationAndScintillation.cxx.

      {
      }

Member Function Documentation

IonizationAndScintillation * gar::rosim::IonizationAndScintillation::CreateInstance ( CLHEP::HepRandomEngine &  engine, fhicl::ParameterSet const &  pset  )

static

Definition at line 29 of file IonizationAndScintillation.cxx.

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

        gInstance->reconfigure(pset);

        return gInstance;
      }

double gar::rosim::IonizationAndScintillation::EnergyDeposit ( ) const

inline

Definition at line 41 of file IonizationAndScintillation.h.

{ return fISCalc->EnergyDeposit();              }

IonizationAndScintillation * gar::rosim::IonizationAndScintillation::Instance ( )

static

Definition at line 40 of file IonizationAndScintillation.cxx.

      {
        // the instance must have been created already by CreateInstance()
        if(!gInstance)
        throw cet::exception("IonizationAndScintillation")
        << "instance pointer is null, that is bad";

        return gInstance;
      }

int gar::rosim::IonizationAndScintillation::NumberIonizationElectrons ( ) const

inline

Definition at line 42 of file IonizationAndScintillation.h.

{ return fISCalc->NumberIonizationElectrons();  }

int gar::rosim::IonizationAndScintillation::NumberScintillationPhotons ( ) const

inline

Definition at line 43 of file IonizationAndScintillation.h.

{ return fISCalc->NumberScintillationPhotons(); }

void gar::rosim::IonizationAndScintillation::reconfigure

(

fhicl::ParameterSet const &

pset

)

Definition at line 99 of file IonizationAndScintillation.cxx.

      {
        if(fISCalc){
          delete fISCalc;
          fISCalc = nullptr;
        }

        auto calcName = pset.get<std::string>("ISCalcName");

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

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

        return;
      }

void gar::rosim::IonizationAndScintillation::Reset

(

const gar::sdp::EnergyDeposit *

dep

)

Definition at line 123 of file IonizationAndScintillation.cxx.

      {

        // TODO fix these lines, ie figure out how to do this with EDeps
        // ===
        //if(fStepNumber == step->GetTrack()->GetCurrentStepNumber() &&
        //fTrkID      == step->GetTrack()->GetTrackID())
        //return;

        //fStepNumber = step->GetTrack()->GetCurrentStepNumber();
        //fTrkID      = step->GetTrack()->GetTrackID();
        // ===

        fEnergyDeposit = dep;

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

        // double check that the energy deposit is non-zero
        // then do the calculation if it is
        if( fEnergyDeposit->Energy() > 0 ){

          fISCalc->CalculateIonizationAndScintillation(fEnergyDeposit);

          MF_LOG_DEBUG("IonizationAndScintillation")
          << "\nEnergy: "    << fISCalc->EnergyDeposit()
          << "\nElectrons: " << fISCalc->NumberIonizationElectrons()
          << "\nPhotons: "   << fISCalc->NumberScintillationPhotons();

          // Fill the histograms
          fEnergyPerStep     ->Fill(fISCalc->EnergyDeposit());
          fElectronsPerStep  ->Fill(fISCalc->NumberIonizationElectrons());
          fPhotonsPerStep    ->Fill(fISCalc->NumberScintillationPhotons());
          fElectronsVsPhotons->Fill(fISCalc->NumberScintillationPhotons(),
          fISCalc->NumberIonizationElectrons());
          fElectronsPerEDep  ->Fill(fISCalc->NumberIonizationElectrons()  * 1.e-3 / fISCalc->EnergyDeposit()   );
          fPhotonsPerEDep    ->Fill(fISCalc->NumberScintillationPhotons() * 1.e-3 / fISCalc->EnergyDeposit()   );

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

        return;
      }

double gar::rosim::IonizationAndScintillation::StepSizeLimit ( ) const

inline

Definition at line 44 of file IonizationAndScintillation.h.

{ return fISCalc->StepSizeLimit();              }

Member Data Documentation

TH1F* gar::rosim::IonizationAndScintillation::fElectronsPerEDep

private

histogram of electrons per MeV deposited

Definition at line 64 of file IonizationAndScintillation.h.

TH1F* gar::rosim::IonizationAndScintillation::fElectronsPerLength

private

histogram of electrons per dX

Definition at line 61 of file IonizationAndScintillation.h.

TH1F* gar::rosim::IonizationAndScintillation::fElectronsPerStep

private

histogram of electrons per step

Definition at line 59 of file IonizationAndScintillation.h.

TH2F* gar::rosim::IonizationAndScintillation::fElectronsVsPhotons

private

histogram of electrons vs photons per step

Definition at line 66 of file IonizationAndScintillation.h.

const gar::sdp::EnergyDeposit* gar::rosim::IonizationAndScintillation::fEnergyDeposit

private

reference to the current energy deposit

Definition at line 54 of file IonizationAndScintillation.h.

TH1F* gar::rosim::IonizationAndScintillation::fEnergyPerStep

private

histogram of the energy deposited per step

Definition at line 63 of file IonizationAndScintillation.h.

CLHEP::HepRandomEngine& gar::rosim::IonizationAndScintillation::fEngine

private

random engine

Definition at line 67 of file IonizationAndScintillation.h.

rosim::ISCalculation* gar::rosim::IonizationAndScintillation::fISCalc

private

produced by an energy deposition

object to calculate ionization and scintillation

Definition at line 51 of file IonizationAndScintillation.h.

std::string gar::rosim::IonizationAndScintillation::fISCalculator

private

name of calculator to use, NEST or Separate

Definition at line 53 of file IonizationAndScintillation.h.

TH1F* gar::rosim::IonizationAndScintillation::fPhotonsPerEDep

private

histogram of photons per MeV deposited

Definition at line 65 of file IonizationAndScintillation.h.

TH1F* gar::rosim::IonizationAndScintillation::fPhotonsPerLength

private

histogram of the photons per dX

Definition at line 62 of file IonizationAndScintillation.h.

TH1F* gar::rosim::IonizationAndScintillation::fPhotonsPerStep

private

histogram of the photons per step

Definition at line 60 of file IonizationAndScintillation.h.

int gar::rosim::IonizationAndScintillation::fStepNumber

private

last StepNumber checked

Definition at line 55 of file IonizationAndScintillation.h.

TH1F* gar::rosim::IonizationAndScintillation::fStepSize

private

histogram of the step sizes

Definition at line 58 of file IonizationAndScintillation.h.

int gar::rosim::IonizationAndScintillation::fTrkID

private

last TrkID checked

Definition at line 56 of file IonizationAndScintillation.h.

---

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

• garsoft/ReadoutSimulation/IonizationAndScintillation.h
• garsoft/ReadoutSimulation/IonizationAndScintillation.cxx