evt::RadioSimulation Class Reference

Data structure for a radio simulation (including several SimRadioPulses) More...

#include "evt/RadioSimulation.h"

Public Types
typedef std::vector < SimRadioPulse > ::const_iterator	PulseIterator

Public Member Functions
void	AddSimRadioPulse (const SimRadioPulse &rp)
	Add a radio pulse to the RadioSimulation. More...

void	ClearSimRadioPulses ()
	Erase all radio pulses from the RadioSimulation. More...

utl::Point	GetCorePosition () const
	Get the core position of the RadioSimulation as a utl::Point. More...

int	GetEventNumber () const
	Get the event number of the RadioSimulation. More...

const utl::TimeStamp &	GetEventTime () const
	Get the event time of the RadioSimulation. More...

utl::CoordinateSystemPtr	GetLocalCoordinateSystem () const
	get local coordinate system anchored at the core position More...

const SimRadioPulse &	GetNextSimRadioPulse (bool &ok)

long	GetNumPulses () const
	Get the number of radio pulses contained in the RadioSimulation. More...

double	GetRadiationEnergy () const

double	GetRefractiveIndexAtSeaLevel () const

int	GetRunNumber () const
	Get the run number of the RadioSimulation. More...

const SimRadioPulse &	GetSimPulseByIndex (const int index)

bool	GoToFirstSimRadioPulse ()
	Jump to the first SimRadioPulse, returns false if the vector is empty. More...

bool	HasCorePosition () const

bool	HasSimPulseByIndex (const int index)

void	SetCoreCoordinates (const double x, const double y, const double z)
	Set the core position coordinates of the RadioSimulation. More...

void	SetCorePosition (const utl::Point &core)
	Set the core position of the RadioSimulation using an utl::Point. More...

void	SetEventNumber (const int eventnum)
	Set the event number of the RadioSimulation. More...

void	SetEventTime (const utl::TimeStamp &t)
	Set the event time of the RadioSimulation. More...

void	SetRadiationEnergy (const double radiationEnergy)

void	SetRefractiveIndexAtSeaLevel (const double n)

void	SetRunNumber (const int runnum)
	Set the run number of the RadioSimulation. More...

Private Member Functions
	RadioSimulation ()

	~RadioSimulation ()

Private Attributes
utl::Validated< utl::Point >	fCorePosition

int	fEventNumber = -1

utl::TimeStamp	fEventTime

utl::Validated < utl::CoordinateSystemPtr >	fLocalCoordinateSystem

utl::Validated< PulseIterator >	fPulseIter

double	fRadiationEnergy = 0

double	fRefractiveIndexAtSeaLevel = 0

int	fRunNumber = -1

std::vector< SimRadioPulse >	fSimRadioPulseVector
	stl-vector holding the radio pulses contained in the RadioSimulation More...

Friends
class	evt::ShowerSimData

class	io::RadioSimulation_ROOT

class	utl::LameShadowPtr< RadioSimulation >

Detailed Description

Data structure for a radio simulation (including several SimRadioPulses)

Author: Tim Huege

Date: 11 Aug 2008

Todo:: a lot

Definition at line 36 of file RadioSimulation.h.

Member Typedef Documentation

typedef std::vector<SimRadioPulse>::const_iterator evt::RadioSimulation::PulseIterator

Definition at line 39 of file RadioSimulation.h.

Constructor & Destructor Documentation

evt::RadioSimulation::RadioSimulation ( )

inlineprivate

Definition at line 106 of file RadioSimulation.h.

evt::RadioSimulation::~RadioSimulation ( )

inlineprivate

Definition at line 107 of file RadioSimulation.h.

Member Function Documentation

void evt::RadioSimulation::AddSimRadioPulse ( const SimRadioPulse & rp )

inline

Add a radio pulse to the RadioSimulation.

Definition at line 87 of file RadioSimulation.h.

References fSimRadioPulseVector.

Referenced by io::REASH5File::AddObserver(), io::RadioSimulation_ROOT::operator>>(), io::ZHAireSFile::Read(), io::REASFile::Read(), io::SELFASFile::Read(), and io::EVAFile::ReadRadioSimData().

void evt::RadioSimulation::ClearSimRadioPulses ( )

inline

Erase all radio pulses from the RadioSimulation.

Definition at line 90 of file RadioSimulation.h.

References fSimRadioPulseVector.

utl::Point RadioSimulation::GetCorePosition ( ) const

Get the core position of the RadioSimulation as a utl::Point.

Definition at line 42 of file RadioSimulation.cc.

Referenced by io::ZHAireSFile::Read().

int evt::RadioSimulation::GetEventNumber ( ) const

inline

Get the event number of the RadioSimulation.

Definition at line 75 of file RadioSimulation.h.

References fEventNumber.

Referenced by io::ZHAireSFile::Read(), RdStationInterpolator::RdStationInterpolator::Run(), and RdStationInterpolatorStarShape::RdStationInterpolatorStarShape::Run().

const utl::TimeStamp& evt::RadioSimulation::GetEventTime ( ) const

inline

Get the event time of the RadioSimulation.

Definition at line 81 of file RadioSimulation.h.

References fEventTime.

Referenced by io::ZHAireSFile::Read(), EventGeneratorOG::EventGenerator::Run(), RdStationInterpolator::RdStationInterpolator::Run(), and RdStationInterpolatorStarShape::RdStationInterpolatorStarShape::Run().

utl::CoordinateSystemPtr RadioSimulation::GetLocalCoordinateSystem ( ) const

get local coordinate system anchored at the core position

Definition at line 14 of file RadioSimulation.cc.

Referenced by EventGeneratorOG::EventGenerator::GetCoreShiftForRadioSimulation(), io::ZHAireSFile::Read(), RdStationAssociator::RdStationAssociator::Run(), EventGeneratorOG::EventGenerator::Run(), RdStationInterpolator::RdStationInterpolator::Run(), and RdStationInterpolatorStarShape::RdStationInterpolatorStarShape::Run().

const SimRadioPulse & RadioSimulation::GetNextSimRadioPulse ( bool & ok )

Definition at line 65 of file RadioSimulation.cc.

Referenced by EventGeneratorOG::EventGenerator::GetCoreShiftForRadioSimulation(), RdStationInterpolator::RdStationInterpolator::Run(), RdStationInterpolatorStarShape::RdStationInterpolatorStarShape::Run(), testEVAFile::testRead(), testZHAireSFile::testRead(), and testREASFile::testRead().

long evt::RadioSimulation::GetNumPulses ( ) const

inline

Get the number of radio pulses contained in the RadioSimulation.

Definition at line 51 of file RadioSimulation.h.

References fSimRadioPulseVector.

Referenced by RdStationAssociator::RdStationAssociator::AddVirtualStations(), io::ZHAireSFile::Read(), RdStationSimulationRejector::RdStationSimulationRejector::Run(), RdVirtualStationNoiseImporter::RdVirtualStationNoiseImporter::Run(), testEVAFile::testRead(), testZHAireSFile::testRead(), and testREASFile::testRead().

double evt::RadioSimulation::GetRadiationEnergy ( ) const

inline

Definition at line 103 of file RadioSimulation.h.

References fRadiationEnergy.

double evt::RadioSimulation::GetRefractiveIndexAtSeaLevel ( ) const

inline

Definition at line 99 of file RadioSimulation.h.

References fRefractiveIndexAtSeaLevel.

Referenced by atm::SimShowerProfileModel::LazyInit().

int evt::RadioSimulation::GetRunNumber ( ) const

inline

Get the run number of the RadioSimulation.

Definition at line 69 of file RadioSimulation.h.

References fRunNumber.

Referenced by io::ZHAireSFile::Read(), RdStationInterpolator::RdStationInterpolator::Run(), and RdStationInterpolatorStarShape::RdStationInterpolatorStarShape::Run().

const SimRadioPulse & RadioSimulation::GetSimPulseByIndex ( const int index )

Definition at line 95 of file RadioSimulation.cc.

Referenced by RdStationAssociator::RdStationAssociator::AddVirtualStations(), and io::ZHAireSFile::Read().

bool RadioSimulation::GoToFirstSimRadioPulse ( )

Jump to the first SimRadioPulse, returns false if the vector is empty.

Definition at line 53 of file RadioSimulation.cc.

Referenced by RdStationInterpolator::RdStationInterpolator::Run(), and RdStationInterpolatorStarShape::RdStationInterpolatorStarShape::Run().

bool evt::RadioSimulation::HasCorePosition ( ) const

inline

Definition at line 53 of file RadioSimulation.h.

References fCorePosition, and utl::Validated< T >::IsValid().

Referenced by io::ZHAireSFile::Read(), testEVAFile::testRead(), testZHAireSFile::testRead(), and testREASFile::testRead().

bool evt::RadioSimulation::HasSimPulseByIndex ( const int index )

inline

Definition at line 48 of file RadioSimulation.h.

References fSimRadioPulseVector.

Referenced by RdStationAssociator::RdStationAssociator::AddVirtualStations().

void RadioSimulation::SetCoreCoordinates	(	const double	x,
		const double	y,
		const double	z
	)

Set the core position coordinates of the RadioSimulation.

Definition at line 25 of file RadioSimulation.cc.

References fwk::LocalCoordinateSystemConstructor< Policy >::Create().

Referenced by io::ZHAireSFile::Read(), io::SELFASFile::Read(), and io::EVAFile::ReadRadioSimData().

void RadioSimulation::SetCorePosition ( const utl::Point & core )

Set the core position of the RadioSimulation using an utl::Point.

Definition at line 34 of file RadioSimulation.cc.

References fwk::LocalCoordinateSystemConstructor< Policy >::Create().

Referenced by io::REASFile::Read(), io::REASH5File::Read(), and EventGeneratorOG::EventGenerator::Run().

void evt::RadioSimulation::SetEventNumber ( const int eventnum )

inline

Set the event number of the RadioSimulation.

Definition at line 78 of file RadioSimulation.h.

References fEventNumber.

Referenced by io::RadioSimulation_ROOT::operator>>(), io::ZHAireSFile::Read(), io::REASFile::Read(), io::SELFASFile::Read(), io::REASH5File::Read(), and io::EVAFile::ReadRadioSimData().

void evt::RadioSimulation::SetEventTime ( const utl::TimeStamp & t )

inline

Set the event time of the RadioSimulation.

Definition at line 84 of file RadioSimulation.h.

References fEventTime.

Referenced by io::RadioSimulation_ROOT::operator>>(), io::ZHAireSFile::Read(), io::REASFile::Read(), io::SELFASFile::Read(), io::REASH5File::Read(), and io::EVAFile::ReadRadioSimData().

void evt::RadioSimulation::SetRadiationEnergy ( const double radiationEnergy )

inline

Definition at line 101 of file RadioSimulation.h.

References fRadiationEnergy.

Referenced by io::RadioSimulation_ROOT::operator>>().

void evt::RadioSimulation::SetRefractiveIndexAtSeaLevel ( const double n )

inline

Definition at line 96 of file RadioSimulation.h.

References fRefractiveIndexAtSeaLevel.

Referenced by io::RadioSimulation_ROOT::operator>>(), and io::REASFile::Read().

void evt::RadioSimulation::SetRunNumber ( const int runnum )

inline

Set the run number of the RadioSimulation.

Definition at line 72 of file RadioSimulation.h.

References fRunNumber.

Referenced by io::RadioSimulation_ROOT::operator>>(), io::ZHAireSFile::Read(), io::REASFile::Read(), io::SELFASFile::Read(), and io::REASH5File::Read().

Friends And Related Function Documentation

friend class evt::ShowerSimData

friend

Definition at line 123 of file RadioSimulation.h.

friend class io::RadioSimulation_ROOT

friend

Definition at line 125 of file RadioSimulation.h.

friend class utl::LameShadowPtr< RadioSimulation >

friend

Definition at line 124 of file RadioSimulation.h.

Member Data Documentation

utl::Validated<utl::Point> evt::RadioSimulation::fCorePosition

private

Definition at line 109 of file RadioSimulation.h.

Referenced by HasCorePosition(), and io::RadioSimulation_ROOT::operator>>().

int evt::RadioSimulation::fEventNumber = -1

private

Definition at line 111 of file RadioSimulation.h.

Referenced by GetEventNumber(), and SetEventNumber().

utl::TimeStamp evt::RadioSimulation::fEventTime

private

Definition at line 112 of file RadioSimulation.h.

Referenced by GetEventTime(), and SetEventTime().

utl::Validated<utl::CoordinateSystemPtr> evt::RadioSimulation::fLocalCoordinateSystem

private

Definition at line 117 of file RadioSimulation.h.

Referenced by io::RadioSimulation_ROOT::operator>>(), and io::RadioSimulation_ROOT::RadioSimulation_ROOT().

utl::Validated<PulseIterator> evt::RadioSimulation::fPulseIter

private

Definition at line 121 of file RadioSimulation.h.

double evt::RadioSimulation::fRadiationEnergy = 0

private

Definition at line 115 of file RadioSimulation.h.

Referenced by GetRadiationEnergy(), and SetRadiationEnergy().

double evt::RadioSimulation::fRefractiveIndexAtSeaLevel = 0

private

Definition at line 114 of file RadioSimulation.h.

Referenced by GetRefractiveIndexAtSeaLevel(), and SetRefractiveIndexAtSeaLevel().

int evt::RadioSimulation::fRunNumber = -1

private

Definition at line 110 of file RadioSimulation.h.

Referenced by GetRunNumber(), and SetRunNumber().

std::vector<SimRadioPulse> evt::RadioSimulation::fSimRadioPulseVector

private

stl-vector holding the radio pulses contained in the RadioSimulation

Definition at line 120 of file RadioSimulation.h.

Referenced by AddSimRadioPulse(), ClearSimRadioPulses(), GetNumPulses(), HasSimPulseByIndex(), and io::RadioSimulation_ROOT::RadioSimulation_ROOT().

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

, generated on Tue Sep 26 2023.