Implementation of the VShowerFileParticleIterator for an Corsika generated shower file. More...

#include <CorsikaShowerFileParticleIterator.h>

Inheritance diagram for io::CorsikaShowerFileParticleIterator:

Public Types
typedef io::Corsika::RawFile::PositionType	PositionType

Public Member Functions
	CorsikaShowerFileParticleIterator (Corsika::RawFile &rawFile, const io::Corsika::EventHeader &header, const Corsika::AtmosphereParameters &params, const double timeOffset, const PositionType &startPosition, const unsigned int observationLevel, const bool isThinned, const double wmaxEM, const bool CERFIL=false, const double CERwlMin=0, const double CERwlMax=0)

virtual utl::Particle *	GetOneParticle (const utl::CoordinateSystemPtr &cs)
	Member function to fetch the next particle. More...

virtual void	Rewind ()
	Rewind the particle list in the shower file to the beginning. More...

virtual	~CorsikaShowerFileParticleIterator ()

Private Member Functions
double	GetDepthAtHeight (const double h) const
	Return vertical atmospheric depth at the height, according to the parameters stored in the file. Uses Auger units. More...

utl::Particle::Source	GetEMParticleSource (const float wt, const short int gen) const

double	GetHeightAtDepth (const double depth) const
	Return height at the vertical atmospheric depth, according to the parameters stored in the file. Uses Auger units. More...

const io::Corsika::ParticleData *	GetOneParticleRecord ()
	Low level reader of individual Corsika particles. More...

const io::Corsika::ParticleDataUnthinned *	GetOneParticleRecordUnthinned ()

Private Attributes
const Corsika::AtmosphereParameters	fAtmPars

bool	fBlockBufferValid = false

const bool	fCERFIL

io::Corsika::Block	fCurrentBlock

io::Corsika::BlockUnthinned	fCurrentBlockUnthinned

utl::Particle	fCurrentParticle

PositionType	fCurrentPosition

const bool	fCurved

const bool	fCurvedObsLevel

utl::Validated< utl::Particle >	fGrandParent

const bool	fIsThinned

bool	fIteratorValid = false

const double	fMCERFI

const unsigned int	fObservationLevel

const double	fObsLevelHeight

utl::Validated< utl::Particle >	fParent

unsigned int	fParticleInBlock = 0

utl::Validated< utl::Point >	fProductionPoint

Corsika::RawFile &	fRawFile

const PositionType	fStartPosition

const double	fTimeOffset

const double	fVersion

const double	fWlLowerLimit

const double	fWlUpperLimit

const double	fWMaxEM

Detailed Description

Implementation of the VShowerFileParticleIterator for an Corsika generated shower file.

Author: Troy Porter; Lukas Nellen

Date: 22 May 2003

Definition at line 45 of file CorsikaShowerFileParticleIterator.h.

Member Typedef Documentation

typedef io::Corsika::RawFile::PositionType io::CorsikaShowerFileParticleIterator::PositionType

Definition at line 48 of file CorsikaShowerFileParticleIterator.h.

Constructor & Destructor Documentation

CorsikaShowerFileParticleIterator::CorsikaShowerFileParticleIterator	(	Corsika::RawFile &	rawFile,
		const io::Corsika::EventHeader &	header,
		const Corsika::AtmosphereParameters &	params,
		const double	timeOffset,
		const PositionType &	startPosition,
		const unsigned int	observationLevel,
		const bool	isThinned,
		const double	wmaxEM,
		const bool	CERFIL = `false`,
		const double	CERwlMin = `0`,
		const double	CERwlMax = `0`
	)

Definition at line 52 of file CorsikaShowerFileParticleIterator.cc.

References fGrandParent, fParent, and utl::Validated< T >::SetValid().

virtual io::CorsikaShowerFileParticleIterator::~CorsikaShowerFileParticleIterator ( )

inlinevirtual

Definition at line 65 of file CorsikaShowerFileParticleIterator.h.

Member Function Documentation

double CorsikaShowerFileParticleIterator::GetDepthAtHeight ( const double h ) const

private

Return vertical atmospheric depth at the height, according to the parameters stored in the file. Uses Auger units.

Definition at line 656 of file CorsikaShowerFileParticleIterator.cc.

References io::Corsika::AtmosphereParameters::fAATM, fAtmPars, io::Corsika::AtmosphereParameters::fBATM, io::Corsika::AtmosphereParameters::fCATM, and io::Corsika::AtmosphereParameters::fHLAY.

Referenced by GetOneParticle().

Particle::Source CorsikaShowerFileParticleIterator::GetEMParticleSource	(	const float	wt,
		const short int	gen
	)		const

private

Definition at line 114 of file CorsikaShowerFileParticleIterator.cc.

References fIsThinned, fVersion, and fWMaxEM.

Referenced by GetOneParticle().

double CorsikaShowerFileParticleIterator::GetHeightAtDepth ( const double depth ) const

private

Return height at the vertical atmospheric depth, according to the parameters stored in the file. Uses Auger units.

Definition at line 638 of file CorsikaShowerFileParticleIterator.cc.

References io::Corsika::AtmosphereParameters::fAATM, fAtmPars, io::Corsika::AtmosphereParameters::fBATM, io::Corsika::AtmosphereParameters::fCATM, and io::Corsika::AtmosphereParameters::fZLAY.

Referenced by GetOneParticle().

Particle * CorsikaShowerFileParticleIterator::GetOneParticle ( const utl::CoordinateSystemPtr & cs )

virtual

Member function to fetch the next particle.

This method has to return a pointer to the current particle in the shower file. Then it steps the cursor in the shower file forward. This corresponds to the way a typical interface library for Aires or CORSIKA provides access to the particles on the ground.

If no more particles are available, return a null pointer.

Call Rewind() before calling this function. This puts the underlying library into a defined state.

It is the responsibility of the concrete implementation to react appropriately to illegal calls to GetOneParticle()

utl::kSpeedOfLight

Implements utl::VShowerFileParticleIterator.

Definition at line 135 of file CorsikaShowerFileParticleIterator.cc.

const Corsika::ParticleData * CorsikaShowerFileParticleIterator::GetOneParticleRecord ( )

private

Low level reader of individual Corsika particles.

Get one Corsika particle record from current event.

Returns a pointer to the current corsika particle data sub-block. It doesn't check for the type of sub-block. It is the responsibility of the caller to ignore unwanted records, e.g. particle unkown to the client.

Returns null pointer when reading beyond the end of the particle records. This should only happen when the event-trailer is reached.

Note: This is coded for the ground particle information only.; The current implementation cannot deal with logitudinal particle records in the data stream.

Definition at line 563 of file CorsikaShowerFileParticleIterator.cc.

References io::Corsika::BasicBlock< ParticleType, CherenkovType, nParticles, padding >::AsParticleBlock(), ERROR, fBlockBufferValid, fCurrentBlock, fCurrentPosition, fIteratorValid, fParticleInBlock, fRawFile, io::Corsika::RawFile::GetNextBlock(), io::Corsika::BasicBlock< ParticleType, CherenkovType, nParticles, padding >::IsControl(), io::Corsika::kParticlesInBlock, and io::Corsika::RawFile::SeekTo().