PlotTAP_Energy Class Reference

#include <PlotTAP_Energy.h>

Inheritance diagram for PlotTAP_Energy:

List of all members.

Public Member Functions
	PlotTAP_Energy (modules::options *opts)
	~PlotTAP_Energy ()
int	ProcessGenericEntry (TGlobalData *gData, const TSetupData *gSetup)
int	Preprocess (TGlobalData *gData, const TSetupData *gSetup)
	Method called by the main pre-process loop.
int	Postprocess (TGlobalData *gData, const TSetupData *gSetup)
	Method called by the main pre-process loop.
void	SetAlias (const std::string &alias)
std::string	GetAlias () const
const char *	GetName () const
	Get the name of this module as given to the constructor of the base class.
Protected Member Functions
bool	Debug () const
TDirectory *	GetDirectory () const
	Get the TDirectory for this module.
TDirectory *	GetDirectory (const std::string &name="")
Protected Attributes
TDirectory *	dir
Private Member Functions
virtual int	BeforeFirstEntry (TGlobalData *gData, const TSetupData *gSetup)
virtual int	AfterLastEntry (TGlobalData *gData, const TSetupData *setup)
virtual int	ProcessEntry (TGlobalData *gData, const TSetupData *gSetup)
	The big kahuna. Overload this in the derived class and it will be called for each event.
Private Attributes
std::map< std::string, TH1F * >	fEnergyPlots

---

Detailed Description

Definition at line 9 of file PlotTAP_Energy.h.

---

Constructor & Destructor Documentation

PlotTAP_Energy::PlotTAP_Energy

(

modules::options *

opts

)

Definition at line 26 of file PlotTAP_Energy.cpp.

                                                   : 
    BaseModule("PlotTAP_Energy",opts) {
    }

PlotTAP_Energy::~PlotTAP_Energy

(

)

Definition at line 30 of file PlotTAP_Energy.cpp.

                               {  
}

---

Member Function Documentation

virtual int PlotTAP_Energy::AfterLastEntry	(	TGlobalData *	gData,
		const TSetupData *	setup
	)			[inline, private, virtual]

Optional method which is called once after the main event loop Can be used to dump a summary or finalise a histogram

Returns:

0 on sucess and non-zero if a problem occurred

Implements BaseModule.

Definition at line 16 of file PlotTAP_Energy.h.

{return 0;};

int PlotTAP_Energy::BeforeFirstEntry	(	TGlobalData *	gData,
		const TSetupData *	setup
	)			[private, virtual]

Optional method which is called once before the main event loop Can be used to parse options and setup histograms.

Returns:

0 on sucess and non-zero if a problem occurred

Implements BaseModule.

Definition at line 33 of file PlotTAP_Energy.cpp.

                                                                                {
    return 0;
}

bool BaseModule::Debug

(

)

const [inline, protected, inherited]

Check whether this module was asked to print extra debug information

Returns:

true if 'debug' was given in the modules file, false if not

Definition at line 71 of file BaseModule.h.

References BaseModule::fDebug.

Referenced by MakeAnalysedPulses::AddGenerator(), ExportPulse::AddToExportList(), PulseCandidateFinder_InvestigateParameters::AfterLastEntry(), PlotTPI_PedestalAndNoise::AfterLastEntry(), PlotTDPs::AfterLastEntry(), PlotTDP_TDiff::AfterLastEntry(), IslandLength::AfterLastEntry(), IslandAmplitude::AfterLastEntry(), MakeDetectorPulses::BeforeFirstEntry(), TemplateCreator::BeforeFirstEntry(), PulseCandidateFinder_InvestigateParameters::BeforeFirstEntry(), PlotTPI_PedestalAndNoise::BeforeFirstEntry(), PlotTDPs::BeforeFirstEntry(), PlotTDP_TDiff::BeforeFirstEntry(), IslandLength::BeforeFirstEntry(), IslandAmplitude::BeforeFirstEntry(), PulseViewer::ConsiderDrawing(), MakeAnalysedPulses::MakeAnalysedPulses(), MakeDetectorPulses::MakeGenerator(), ExportPulse::PlotTPI(), MakeDetectorPulses::ProcessEntry(), TemplateCreator::ProcessEntry(), PulseCandidateFinder_InvestigateParameters::ProcessEntry(), MakeAnalysedPulses::ProcessEntry(), PulseViewer::ProcessEntry(), PlotTDP_TDiff::ProcessEntry(), and TemplateCreator::StartTemplate().

{return fDebug;};

std::string BaseModule::GetAlias

(

)

const [inline, inherited]

Returns a string for the alias of this module. May be empty if no alias was given in the modules file.

Definition at line 63 of file BaseModule.h.

References BaseModule::fAlias.

Referenced by BaseModule::BaseModule().

{return fAlias;};

TDirectory * BaseModule::GetDirectory

(

const std::string &

name = ""

)

[protected, inherited]

Definition at line 77 of file BaseModule.cpp.

References BaseModule::dir, and BaseModule::fDirectory.

                                                         {
  if(name.empty()) return fDirectory;
  TDirectory* dir=fDirectory->GetDirectory(name.c_str());
  if(dir) return dir;
  return fDirectory->mkdir(name.c_str());
}

TDirectory* BaseModule::GetDirectory

(

)

const [inline, protected, inherited]

Get the TDirectory for this module.

Definition at line 74 of file BaseModule.h.

References BaseModule::fDirectory.

Referenced by TemplateCreator::AfterLastEntry(), SavePulses::AfterLastEntry(), TemplateCreator::BeforeFirstEntry(), PlotTDPs::BeforeFirstEntry(), ExportPulse::ExportPulse(), and TemplateCreator::ProcessEntry().

{return fDirectory;}

const char* BaseModule::GetName

(

)

const [inline, inherited]

Get the name of this module as given to the constructor of the base class.

Definition at line 66 of file BaseModule.h.

References BaseModule::fName.

Referenced by SavePulses::BeforeFirstEntry(), PlotTDPs::BeforeFirstEntry(), PlotTDP_TDiff::BeforeFirstEntry(), PlotTAP_Time::ProcessEntry(), ProcessEntry(), PlotTAP_Amplitude::ProcessEntry(), and LoopSequence::Run().

{return fName.c_str();};

int BaseModule::Postprocess	(	TGlobalData *	gData,
		const TSetupData *	gSetup
	)			[inherited]

Method called by the main pre-process loop.

Does some simple work, then hooks into the derived class through AfterLastEntry.

Returns:

0 on sucess and non-zero if a problem occurred

Definition at line 66 of file BaseModule.cpp.

References BaseModule::AfterLastEntry(), and BaseModule::fDirectory.

Referenced by LoopSequence::Postprocess().

                                                                       {
  // This is called by our main routine and would allow later to split into different 
  // process routines if we have more than one Tree and hence different tpyes of data input.

  if(fDirectory) fDirectory->cd();
  int ret = AfterLastEntry(gData, gSetup);
  gDirectory->cd("/");

  return ret;
}

int BaseModule::Preprocess	(	TGlobalData *	gData,
		const TSetupData *	gSetup
	)			[inherited]

Method called by the main pre-process loop.

Does some simple work, then hooks into the derived class through BeforeFirstEntry.

Returns:

0 on sucess and non-zero if a problem occurred

Definition at line 55 of file BaseModule.cpp.

References BaseModule::BeforeFirstEntry(), and BaseModule::fDirectory.

Referenced by LoopSequence::Preprocess().

                                                                      {
  // This is called by our main routine and would allow later to split into different 
  // process routines if we have more than one Tree and hence different tpyes of data input.

  if(fDirectory) fDirectory->cd();
  int ret = BeforeFirstEntry(gData, gSetup);
  gDirectory->cd("/");

  return ret;
}

int PlotTAP_Energy::ProcessEntry	(	TGlobalData *	gData,
		const TSetupData *	gSetup
	)			[private, virtual]

The big kahuna. Overload this in the derived class and it will be called for each event.

Parameters:

	gData	Pointer to current map of all TPIs [ WILL CHANGE SHORTLY ]
	gSetup	Pointer to TSetupData for this run [ WILL CHANGE SHORTLY ]

Returns:

0 on success and non-zero on failure

Implements BaseModule.

Definition at line 37 of file PlotTAP_Energy.cpp.

References fEnergyPlots, gAnalysedPulseMap, SetupNavigator::GetAdcToEnergyConstant(), SetupNavigator::GetAdcToEnergyGain(), TSetupData::GetBankName(), BaseModule::GetName(), TSetupData::GetNBits(), SetupNavigator::GetRunNumber(), and SetupNavigator::Instance().

                                                                            {

    // Loop over each TAP list
    for (SourceAnalPulseMap::const_iterator i_det = gAnalysedPulseMap.begin();
            i_det != gAnalysedPulseMap.end();
            i_det++) {

        const std::string& detname = i_det->first.str();
        std::string keyname = i_det->first.str() + GetName();

        // Create the histogram if it's not been created yet
        if ( fEnergyPlots.find(keyname) == fEnergyPlots.end() ) {

            // hEnergy
            std::string histname = "h" + detname + "_Energy";
            std::stringstream histtitle;
            histtitle<<"Energy of pulses from source " << i_det->first;
            histtitle<<" for run "<<SetupNavigator::Instance()->GetRunNumber();
            int n_bits = gSetup->GetNBits(gSetup->GetBankName(i_det->first.Channel().str()));
            const double max_adc_value = std::pow(2, n_bits);
            double gain  = 1;
            double offset= 0;
            try{
               gain  = SetupNavigator::Instance()->GetAdcToEnergyGain(    i_det->first.Channel());
               offset= SetupNavigator::Instance()->GetAdcToEnergyConstant(i_det->first.Channel());
            }catch( Except::InvalidDetector& e){};
            TH1F* hEnergy = new TH1F(histname.c_str(), histtitle.str().c_str(), max_adc_value,0,gain*max_adc_value + offset);
            hEnergy->GetXaxis()->SetTitle("Energy (KeV)");
            hEnergy->GetYaxis()->SetTitle("Arbitrary Units");
            fEnergyPlots[keyname] = hEnergy;
        }

        const AnalysedPulseList *pulses = &i_det->second;
        //if(Debug() && pulses->empty()) DEBUG_PREFIX<<" no pulses to fill for "<<i_det->first<<std::endl;

        for (AnalysedPulseList::const_iterator pulseIter = pulses->begin(); pulseIter != pulses->end(); ++pulseIter) {
            double Energy = (*pulseIter)->GetEnergy();
            fEnergyPlots[keyname]->Fill(Energy);

        } // end loop through pulses

    } // end loop through detectors
    return 0;
}

int BaseModule::ProcessGenericEntry	(	TGlobalData *	gData,
		const TSetupData *	gSetup
	)			[inherited]

Method called by the main event loop for each entry in the input root tree. Does some simple work, then hooks into the derived class through ProcessEntry.

Returns:

0 on sucess and non-zero if a problem occurred

Definition at line 44 of file BaseModule.cpp.

References BaseModule::fDirectory, and BaseModule::ProcessEntry().

Referenced by LoopSequence::Process().

                                                                               {
  // This is called by our main routine and would allow later to split into different 
  // process routines if we have more than one Tree and hence different tpyes of data input.

  if(fDirectory) fDirectory->cd();
  int ret = ProcessEntry(gData, gSetup);
  gDirectory->cd("/");

  return ret;
}

void BaseModule::SetAlias

(

const std::string &

alias

)

[inline, inherited]

Sets the alias for this module, which should be provided in the modules file

Definition at line 59 of file BaseModule.h.

References BaseModule::fAlias.

Referenced by BaseModule::BaseModule().

{fAlias=alias;};

---

Member Data Documentation

TDirectory* BaseModule::dir [protected, inherited]

Many modules use 'dir' still which was the old protected pointer to the modules directory. To prevent things being broken so soon, we keep this pointer available, but be warned that it will be removed shortly...

Definition at line 98 of file BaseModule.h.

Referenced by BaseModule::BaseModule(), FastSlowCompare::FastSlowCompare(), GeSpectrum::GeSpectrum(), BaseModule::GetDirectory(), MakeMuonEvents::MakeMuonEvents(), and PlotAmpVsTDiff::PlotAmpVsTDiff().

std::map<std::string, TH1F*> PlotTAP_Energy::fEnergyPlots [private]

Definition at line 19 of file PlotTAP_Energy.h.

Referenced by ProcessEntry().

---

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

• rootana/src/plotters/PlotTAP_Energy.h
• rootana/src/plotters/PlotTAP_Energy.cpp