evt::SimRadioPulse Class Reference

Data structure for simulated Radio pulses. More...

#include "evt/SimRadioPulse.h"

Public Member Functions
std::string	GetAntennaName () const
	Get the name of simulated antenna related to pulse. More...

double	GetBinning () const
	Get the sampling time scale. More...

const utl::TraceV3D &	GetEfieldTimeSeries () const
	Get the Trace of the simulated electric field. More...

utl::TraceV3D &	GetEfieldTimeSeries ()
	Get the Trace of the simulated electric field. More...

utl::Point	GetLocation () const

double	GetStartTime () const
	Get the timestamp of the first sample. More...

void	SetAntennaName (const std::string antname)
	Set the name of simulated antenna. More...

void	SetBinning (const double samplingtime)

void	SetLocalCoordinateSystem (utl::CoordinateSystemPtr localCS) const

void	SetRelativeCoordinates (double northing, double easting, double height)

void	SetStartTime (const double starttime)

	SimRadioPulse ()

Private Attributes
utl::InitializedShadowPtr < utl::TraceV3D >	fEfieldTimeSeries
	the Trace holding the electric field time series More...

utl::CoordinateSystemPtr	fLocalCoordinateSystem

double	fRelativeEasting = 0

double	fRelativeHeight = 0

double	fRelativeNorthing = 0
	the location at which the pulse was simulated More...

std::string	fSimulatedAntennaName

double	fStartTime = 0
	absolute time of the first sample of the time-series More...

Friends
class	io::SimRadioPulse_ROOT

class	RadioSimulation

Detailed Description

Data structure for simulated Radio pulses.

Author: Tim Huege

Date: 11 Aug 2008

Todo:: a lot

Definition at line 29 of file SimRadioPulse.h.

Constructor & Destructor Documentation

SimRadioPulse::SimRadioPulse ( )

Definition at line 8 of file SimRadioPulse.cc.

Member Function Documentation

std::string evt::SimRadioPulse::GetAntennaName ( ) const

inline

Get the name of simulated antenna related to pulse.

Definition at line 68 of file SimRadioPulse.h.

References fSimulatedAntennaName.

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

double evt::SimRadioPulse::GetBinning ( ) const

inline

Get the sampling time scale.

Definition at line 34 of file SimRadioPulse.h.

References fEfieldTimeSeries.

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

const utl::TraceV3D& evt::SimRadioPulse::GetEfieldTimeSeries ( ) const

inline

Get the Trace of the simulated electric field.

Definition at line 44 of file SimRadioPulse.h.

References fEfieldTimeSeries.

Referenced by io::REASH5File::AddObserver(), RdStationInterpolator::RdStationInterpolator::PadTimeSeries(), RdStationInterpolatorStarShape::RdStationInterpolatorStarShape::PadTimeSeries(), io::ZHAireSFile::Read(), io::REASFile::Read(), io::EVAFile::ReadRadioSimData(), RdStationAssociator::RdStationAssociator::Run(), testEVAFile::testRead(), testZHAireSFile::testRead(), and testREASFile::testRead().

utl::TraceV3D& evt::SimRadioPulse::GetEfieldTimeSeries ( )

inline

Get the Trace of the simulated electric field.

Definition at line 45 of file SimRadioPulse.h.

References fEfieldTimeSeries.

utl::Point evt::SimRadioPulse::GetLocation ( ) const

inline

Definition at line 51 of file SimRadioPulse.h.

References fLocalCoordinateSystem, fRelativeEasting, fRelativeHeight, and fRelativeNorthing.

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

double evt::SimRadioPulse::GetStartTime ( ) const

inline

Get the timestamp of the first sample.

Definition at line 39 of file SimRadioPulse.h.

References fStartTime.

Referenced by io::REASH5File::AddObserver(), io::ZHAireSFile::Read(), io::REASFile::Read(), RdStationAssociator::RdStationAssociator::Run(), testEVAFile::testRead(), testZHAireSFile::testRead(), and testREASFile::testRead().

void evt::SimRadioPulse::SetAntennaName ( const std::string antname )

inline

Set the name of simulated antenna.

Definition at line 64 of file SimRadioPulse.h.

References fSimulatedAntennaName.

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

void evt::SimRadioPulse::SetBinning ( const double samplingtime )

inline

Parameters

samplingtime Set the sampling time scale

Definition at line 36 of file SimRadioPulse.h.

References fEfieldTimeSeries.

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

void evt::SimRadioPulse::SetLocalCoordinateSystem ( utl::CoordinateSystemPtr localCS ) const

inline

Definition at line 70 of file SimRadioPulse.h.

References fLocalCoordinateSystem.

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

void evt::SimRadioPulse::SetRelativeCoordinates	(	double	northing,
		double	easting,
		double	height
	)

inline

Definition at line 56 of file SimRadioPulse.h.

References fRelativeEasting, fRelativeHeight, and fRelativeNorthing.

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

void evt::SimRadioPulse::SetStartTime ( const double starttime )

inline

Parameters

starttime Set the timestamp of the first sample

Definition at line 41 of file SimRadioPulse.h.

References fStartTime.

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

Friends And Related Function Documentation

friend class io::SimRadioPulse_ROOT

friend

Definition at line 84 of file SimRadioPulse.h.

friend class RadioSimulation

friend

Definition at line 83 of file SimRadioPulse.h.

Member Data Documentation

utl::InitializedShadowPtr<utl::TraceV3D> evt::SimRadioPulse::fEfieldTimeSeries

private

the Trace holding the electric field time series

Definition at line 75 of file SimRadioPulse.h.

Referenced by GetBinning(), GetEfieldTimeSeries(), io::SimRadioPulse_ROOT::operator>>(), and SetBinning().

utl::CoordinateSystemPtr evt::SimRadioPulse::fLocalCoordinateSystem

mutableprivate

Definition at line 79 of file SimRadioPulse.h.

Referenced by GetLocation(), io::SimRadioPulse_ROOT::operator>>(), SetLocalCoordinateSystem(), and io::SimRadioPulse_ROOT::SimRadioPulse_ROOT().

double evt::SimRadioPulse::fRelativeEasting = 0

private

Definition at line 77 of file SimRadioPulse.h.

Referenced by GetLocation(), and SetRelativeCoordinates().

double evt::SimRadioPulse::fRelativeHeight = 0

private

Definition at line 78 of file SimRadioPulse.h.

Referenced by GetLocation(), and SetRelativeCoordinates().

double evt::SimRadioPulse::fRelativeNorthing = 0

private

the location at which the pulse was simulated

Definition at line 76 of file SimRadioPulse.h.

Referenced by GetLocation(), and SetRelativeCoordinates().

std::string evt::SimRadioPulse::fSimulatedAntennaName

private

Definition at line 81 of file SimRadioPulse.h.

Referenced by GetAntennaName(), and SetAntennaName().

double evt::SimRadioPulse::fStartTime = 0

private

absolute time of the first sample of the time-series

Definition at line 74 of file SimRadioPulse.h.

Referenced by GetStartTime(), and SetStartTime().

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

, generated on Tue Sep 26 2023.