The Setup class serves as a base class for all known beamtime setup configurations. More...

#include <Setup.h>

Inheritance diagram for ant::expconfig::Setup:

Collaboration diagram for ant::expconfig::Setup:

Public Member Functions
virtual std::list< std::shared_ptr< Calibration::PhysicsModule > >	GetCalibrations () const override

virtual std::list< std::shared_ptr< ReconstructHook::Base > >	GetReconstructHooks () const override

virtual std::list< std::shared_ptr< Detector_t > >	GetDetectors () const override

virtual std::list< std::shared_ptr< Updateable_traits > >	GetUpdateables () const override

virtual std::string	GetPIDCutsDirectory () const override

virtual std::string	GetPhysicsFilesDirectory () const override

virtual std::shared_ptr< calibration::DataManager >	GetCalibrationDataManager () const override final

virtual std::string	GetName () const override final

virtual double	GetElectronBeamEnergy () const override

virtual bool	GetIncludeIgnoredElements () const override

virtual ant::PiecewiseInterval< double >	GetPromptWindows () const override

virtual ant::PiecewiseInterval< double >	GetRandomWindows () const override

virtual std::string	GetStartDate () const override final

virtual std::string	GetEndDate () const override final

virtual bool	Matches (const TID &tid) const override final

Public Member Functions inherited from ant::expconfig::Setup_traits
virtual candidatebuilder_config_t	GetCandidateBuilderConfig () const

virtual triggersimu_config_t	GetTriggerSimuConfig () const

virtual target_properties_t	GetTargetProperties () const

virtual	~Setup_traits ()=default

Public Member Functions inherited from ant::UnpackerA2GeantConfig
virtual promptrandom_config_t	GetPromptRandomConfig () const

Protected Member Functions
	Setup (const std::string &name, OptionsPtr opts)

void	AddDetector (const std::shared_ptr< Detector_t > &detector)

template<typename T , typename... Args>
void	AddDetector (Args &&... args)

void	AddHook (const std::shared_ptr< ReconstructHook::Base > &hook)

template<typename T , typename... Args>
void	AddHook (Args &&... args)

void	AddCalibration (const std::shared_ptr< Calibration::BaseModule > &calib)

template<typename T , typename... Args>
void	AddCalibration (Args &&... args)

void	BuildMappings (std::vector< hit_mapping_t > &hit_mappings, std::vector< scaler_mapping_t > &scaler_mappings) const override

void	AddPromptRange (const interval< double > &i)

void	AddRandomRange (const interval< double > &i)

void	SetTimeRange (const std::string &start, const std::string &end)

virtual void	ManualClusterCorrection (OptionsPtr opts)
	Check options for manual modifications of cluster energies searches for the string manualCluster<Correction><Detector>_<Type> and the corresponding double value, where <Correction is the type of correction which should be applied and could be Factor, Offset, or Smearing; <Type> is the data type this value should be applied to and can be MC, Data, or Both; and <Detector> can be CB or TAPS, or can be empty, in which case it will be applied to both CB and TAPS. The flags could look like e.g.: More...

Protected Member Functions inherited from ant::UnpackerAcquConfig
	~UnpackerAcquConfig ()=default

Protected Member Functions inherited from ant::UnpackerA2GeantConfig
	~UnpackerA2GeantConfig ()=default

Protected Attributes
std::list< std::shared_ptr< Detector_t > >	detectors

std::list< std::shared_ptr< ReconstructHook::Base > >	reconstruct_hooks

std::list< std::shared_ptr< Calibration::BaseModule > >	calibrations

std::shared_ptr< calibration::DataManager >	calibrationDataManager

Detailed Description

The Setup class serves as a base class for all known beamtime setup configurations.

The class provides useful routines and stores the instantiated calibrations and detectors, which are used to automatically construct the mappings for the unpacker, for example.

Constructor & Destructor Documentation

◆ Setup()

Setup::Setup	(	const std::string &	name,
		OptionsPtr	opts
	)

protected

Member Function Documentation

◆ AddCalibration() [1/2]

void ant::expconfig::Setup::AddCalibration ( const std::shared_ptr< Calibration::BaseModule > & calib )

inlineprotected

◆ AddCalibration() [2/2]

template<typename T , typename... Args>

void ant::expconfig::Setup::AddCalibration ( Args &&... args )

inlineprotected

◆ AddDetector() [1/2]

void ant::expconfig::Setup::AddDetector ( const std::shared_ptr< Detector_t > & detector )

inlineprotected

◆ AddDetector() [2/2]

template<typename T , typename... Args>

void ant::expconfig::Setup::AddDetector ( Args &&... args )

inlineprotected

◆ AddHook() [1/2]

void ant::expconfig::Setup::AddHook ( const std::shared_ptr< ReconstructHook::Base > & hook )

inlineprotected

◆ AddHook() [2/2]

template<typename T , typename... Args>

void ant::expconfig::Setup::AddHook ( Args &&... args )

inlineprotected

◆ AddPromptRange()

void ant::expconfig::Setup::AddPromptRange ( const interval< double > & i )

inlineprotected

◆ AddRandomRange()

void ant::expconfig::Setup::AddRandomRange ( const interval< double > & i )

inlineprotected

◆ BuildMappings()

void Setup::BuildMappings	(	std::vector< hit_mapping_t > &	hit_mappings,
		std::vector< scaler_mapping_t > &	scaler_mappings
	)		const

overrideprotectedvirtual

Todo:: check that the detectors do not add overlapping mappings

Implements ant::UnpackerAcquConfig.

Reimplemented in ant::expconfig::setup::Setup_CBSourceCalib, ant::expconfig::setup::Setup_2017_03, ant::expconfig::setup::Setup_2017_05, ant::expconfig::setup::Setup_2018_11, ant::expconfig::setup::Setup_2019_01, ant::expconfig::setup::Setup_2019_06, ant::expconfig::setup::Setup_2019_07, ant::expconfig::setup::Setup_2019_09, ant::expconfig::setup::Setup_2014_EPT, and ant::expconfig::setup::Setup_2017Plus_NewTagger_Base.

◆ GetCalibrationDataManager()

virtual std::shared_ptr<calibration::DataManager> ant::expconfig::Setup::GetCalibrationDataManager ( ) const

inlinefinaloverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetCalibrations()

std::list< std::shared_ptr< ant::Calibration::PhysicsModule > > Setup::GetCalibrations ( ) const

overridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetDetectors()

virtual std::list< std::shared_ptr< Detector_t > > ant::expconfig::Setup::GetDetectors ( ) const

inlineoverridevirtual

Implements ant::expconfig::Setup_traits.

Reimplemented in FakeSetup.

◆ GetElectronBeamEnergy()

virtual double ant::expconfig::Setup::GetElectronBeamEnergy ( ) const

inlineoverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetEndDate()

virtual std::string ant::expconfig::Setup::GetEndDate ( ) const

inlinefinaloverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetIncludeIgnoredElements()

virtual bool ant::expconfig::Setup::GetIncludeIgnoredElements ( ) const

inlineoverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetName()

virtual std::string ant::expconfig::Setup::GetName ( ) const

inlinefinaloverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetPhysicsFilesDirectory()

std::string Setup::GetPhysicsFilesDirectory ( ) const

overridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetPIDCutsDirectory()

std::string Setup::GetPIDCutsDirectory ( ) const

overridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetPromptWindows()

virtual ant::PiecewiseInterval<double> ant::expconfig::Setup::GetPromptWindows ( ) const

inlineoverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetRandomWindows()

virtual ant::PiecewiseInterval<double> ant::expconfig::Setup::GetRandomWindows ( ) const

inlineoverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetReconstructHooks()

std::list< std::shared_ptr< ant::ReconstructHook::Base > > Setup::GetReconstructHooks ( ) const

overridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetStartDate()

virtual std::string ant::expconfig::Setup::GetStartDate ( ) const

inlinefinaloverridevirtual

Implements ant::expconfig::Setup_traits.

◆ GetUpdateables()

std::list< std::shared_ptr< ant::Updateable_traits > > Setup::GetUpdateables ( ) const

overridevirtual

Implements ant::expconfig::Setup_traits.

◆ ManualClusterCorrection()

void Setup::ManualClusterCorrection ( OptionsPtr opts )

protectedvirtual

Check options for manual modifications of cluster energies searches for the string manualCluster<Correction><Detector>_<Type> and the corresponding double value, where <Correction is the type of correction which should be applied and could be Factor, Offset, or Smearing; <Type> is the data type this value should be applied to and can be MC, Data, or Both; and <Detector> can be CB or TAPS, or can be empty, in which case it will be applied to both CB and TAPS. The flags could look like e.g.:

manualClusterFactorCB_MC=1.1
manualClusterOffsetTAPS_Both=5
manualClusterSmearing_Data=12.5

Parameters

OptionsPtr

See also: ClusterCorrFactor, ClusterCorrOffset, and ClusterCorrSmearing

◆ Matches()

bool Setup::Matches ( const TID & tid ) const

finaloverridevirtual

Implements ant::expconfig::Setup_traits.

◆ SetTimeRange()

void ant::expconfig::Setup::SetTimeRange	(	const std::string &	start,
		const std::string &	end
	)

inlineprotected

Member Data Documentation

◆ calibrationDataManager

std::shared_ptr<calibration::DataManager> ant::expconfig::Setup::calibrationDataManager

protected

◆ calibrations

std::list< std::shared_ptr<Calibration::BaseModule> > ant::expconfig::Setup::calibrations

protected

◆ detectors

std::list< std::shared_ptr<Detector_t> > ant::expconfig::Setup::detectors

protected

◆ reconstruct_hooks

std::list< std::shared_ptr<ReconstructHook::Base> > ant::expconfig::Setup::reconstruct_hooks

protected

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

src/expconfig/setups/Setup.h
src/expconfig/setups/Setup.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Setup()

Member Function Documentation

◆ AddCalibration() [1/2]

◆ AddCalibration() [2/2]

◆ AddDetector() [1/2]

◆ AddDetector() [2/2]

◆ AddHook() [1/2]

◆ AddHook() [2/2]

◆ AddPromptRange()

◆ AddRandomRange()

◆ BuildMappings()

◆ GetCalibrationDataManager()

◆ GetCalibrations()

◆ GetDetectors()

◆ GetElectronBeamEnergy()

◆ GetEndDate()

◆ GetIncludeIgnoredElements()

◆ GetName()

◆ GetPhysicsFilesDirectory()

◆ GetPIDCutsDirectory()

◆ GetPromptWindows()

◆ GetRandomWindows()

◆ GetReconstructHooks()

◆ GetStartDate()

◆ GetUpdateables()

◆ ManualClusterCorrection()

◆ Matches()

◆ SetTimeRange()

Member Data Documentation

◆ calibrationDataManager

◆ calibrations

◆ detectors

◆ reconstruct_hooks