The base interface for radio emission processes. More...

#include <RadioProcess.hpp>

Inheritance diagram for corsika::RadioProcess< TAntennaCollection, TRadioImpl, TPropagator >:

[legend]

Public Types
using	axistype = std::vector< long double >

Public Types inherited from corsika::BaseProcess< RadioProcess< TAntennaCollection, TRadioImpl, TPropagator > >
using	process_type = RadioProcess< TAntennaCollection, TRadioImpl, TPropagator >
	Base processor type for use in other template classes.

Public Member Functions
	RadioProcess (TAntennaCollection &antennas, TPropagator &propagator)
	Construct a new RadioProcess.

template<typename Particle >
ProcessReturn	doContinuous (Step< Particle > const &step, bool const)
	Perform the continuous process (radio emission). More...

template<typename Particle , typename Track >
LengthType	getMaxStepLength (Particle const &vParticle, Track const &vTrack) const
	Return the maximum step length for this particle and track. More...

void	startOfLibrary (boost::filesystem::path const &directory) final override
	Called at the start of each library.

virtual void	endOfShower (unsigned int const) final override
	Called at the end of each shower.

void	endOfLibrary () final override
	Called at the end of each library.

YAML::Node	getConfig () const final
	Get the configuration of this output.

Public Member Functions inherited from corsika::BaseOutput
virtual void	startOfShower (unsigned int const)
	Called at the start of each event/shower. More...

bool	isInit () const
	Flag to indicate readiness.

virtual YAML::Node	getSummary () const
	Provide YAML Summary for this BaseOutput.

Protected Attributes
TAntennaCollection &	antennas_
	The radio antennas we store into.

TPropagator	propagator_
	The propagator implementation.

unsigned int	showerId_ {0}
	The current event ID.

ParquetStreamer	output_
	The parquet streamer for this process.

Protected Attributes inherited from corsika::BaseProcess< RadioProcess< TAntennaCollection, TRadioImpl, TPropagator > >
friend	TDerived

Additional Inherited Members
Static Public Attributes inherited from corsika::BaseProcess< RadioProcess< TAntennaCollection, TRadioImpl, TPropagator > >
static bool const	is_process_sequence

static bool const	is_switch_process_sequence

Protected Member Functions inherited from corsika::BaseProcess< RadioProcess< TAntennaCollection, TRadioImpl, TPropagator > >
RadioProcess< TAntennaCollection, TRadioImpl, TPropagator > &	getRef ()

const RadioProcess< TAntennaCollection, TRadioImpl, TPropagator > &	getRef () const

Protected Member Functions inherited from corsika::BaseOutput
void	setInit (bool const v)
	Set init flag.

Detailed Description

template<typename TAntennaCollection, typename TRadioImpl, typename TPropagator>
class corsika::RadioProcess< TAntennaCollection, TRadioImpl, TPropagator >

The base interface for radio emission processes.

TRadioImpl is the concrete implementation of the radio algorithm. TAntennaCollection is the detector instance that stores antennas and is responsible for managing the output writing.

Definition at line 27 of file RadioProcess.hpp.

Member Function Documentation

◆ doContinuous()

template<typename TAntennaCollection, typename TRadioImpl, typename TPropagator>

template<typename Particle >

ProcessReturn corsika::RadioProcess< TAntennaCollection, TRadioImpl, TPropagator >::doContinuous	(	Step< Particle > const &	step,
		bool	const
	)

Perform the continuous process (radio emission).

This handles filtering individual particle tracks before passing them to Simulate.`

Parameters

particle	The current particle.
track	The current track.

◆ getMaxStepLength()

template<typename TAntennaCollection, typename TRadioImpl, typename TPropagator>

template<typename Particle , typename Track >

LengthType corsika::RadioProcess< TAntennaCollection, TRadioImpl, TPropagator >::getMaxStepLength	(	Particle const &	vParticle,
		Track const &	vTrack
	)		const

Return the maximum step length for this particle and track.

This must be provided by the TRadioImpl.

Parameters

particle	The current particle.
track	The current track.

Returns: The maximum length of this track.

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

corsika/modules/radio/RadioProcess.hpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename TAntennaCollection, typename TRadioImpl, typename TPropagator> class corsika::RadioProcess< TAntennaCollection, TRadioImpl, TPropagator >

Member Function Documentation

◆ doContinuous()

◆ getMaxStepLength()

template<typename TAntennaCollection, typename TRadioImpl, typename TPropagator>
class corsika::RadioProcess< TAntennaCollection, TRadioImpl, TPropagator >