CORSIKA8  0.0.0
The framework to simulate particle cascades for astroparticle physics
corsika::ObservationPlane< TTracking, TOutputWriter > Class Template Reference

The ObservationPlane writes PDG codes, energies, and distances of particles to the central point of the plane into its output file. More...

#include <ObservationPlane.hpp>

Inheritance diagram for corsika::ObservationPlane< TTracking, TOutputWriter >:

Public Member Functions

 ObservationPlane (Plane const &, DirectionVector const &, bool=true)
 
template<typename TParticle , typename TTrajectory >
ProcessReturn doContinuous (TParticle &vParticle, TTrajectory &vTrajectory, bool const stepLimit)
 
template<typename TParticle , typename TTrajectory >
LengthType getMaxStepLength (TParticle const &, TTrajectory const &vTrajectory)
 
void showResults () const
 
void reset ()
 
HEPEnergyType getEnergyGround () const
 
YAML::Node getConfig () const
 

Additional Inherited Members

- Public Types inherited from corsika::BaseProcess< ObservationPlane< TTracking, TOutputWriter > >
using process_type = ObservationPlane< TTracking, TOutputWriter >
 Base processor type for use in other template classes.
 
- Static Public Attributes inherited from corsika::BaseProcess< ObservationPlane< TTracking, TOutputWriter > >
static bool const is_process_sequence
 
static bool const is_switch_process_sequence
 
- Protected Member Functions inherited from corsika::BaseProcess< ObservationPlane< TTracking, TOutputWriter > >
ObservationPlane< TTracking, TOutputWriter > & ref ()
 
const ObservationPlane< TTracking, TOutputWriter > & ref () const
 
- Protected Attributes inherited from corsika::BaseProcess< ObservationPlane< TTracking, TOutputWriter > >
friend TDerived
 

Detailed Description

template<typename TTracking, typename TOutputWriter = ObservationPlaneWriterParquet>
class corsika::ObservationPlane< TTracking, TOutputWriter >

The ObservationPlane writes PDG codes, energies, and distances of particles to the central point of the plane into its output file.

The particles are considered "absorbed" afterwards.

Note/Limitation:** as discussed in https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/-/issues/397 you cannot put two ObservationPlanes exactly on top of each other. Even if one of them is "permeable". You have to put a small gap in between the two plane in such a scenario, or develop another more specialized output class.

Definition at line 34 of file ObservationPlane.hpp.


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