Store the photon signal path between two points. More...

Inheritance diagram for corsika::SignalPath:

Public Member Functions
	SignalPath (TimeType const propagation_time, double const average_refractive_index, double const refractive_index_source, double const refractive_index_destination, Vector< dimensionless_d > const &emit, Vector< dimensionless_d > const &receive, LengthType const R_distance, std::deque< Point > const &points)
	Create a new SignalPath instance.

Public Member Functions inherited from corsika::Path
	Path (Point const &point)
	Create a Path with a given starting Point.

	Path (std::deque< Point > const &points)
	Initialize a Path from an existing collection of Points.

void	addToEnd (Point const &point)
	Add a new Point to the end of the path.

void	removeFromEnd ()
	Remove a point from the end of the path.

LengthType	getLength () const
	Get the total length of the path.

Point const &	getStart () const
	Get the starting point of the path.

Point const &	getEnd () const
	Get the end point of the path.

Point const &	getPoint (std::size_t const index) const
	Get a specific point of the path.

const_iterator	begin () const
	Return an iterator to the start of the Path.

const_iterator	end () const
	Return an iterator to the end of the Path.

iterator	begin ()
	Return an iterator to the start of the Path.

iterator	end ()
	Return an iterator to the end of the Path.

int	getNSegments () const
	Get the number of steps in the path. More...

Public Attributes
TimeType const	propagation_time_
	The total propagation time.

double const	average_refractive_index_
	The average refractive index.

double const	refractive_index_source_
	The refractive index at the source.

double const	refractive_index_destination_
	The refractive index at the destination point.

Vector< dimensionless_d > const	emit_
	The (unit-length) emission vector.

Vector< dimensionless_d > const	receive_
	The (unit-length) receive vector.

LengthType const	R_distance_
	The distance from the point of emission to an observer. TODO: optical path, not geometrical! (probably)

Additional Inherited Members
Protected Types inherited from corsika::Path
using	iterator = std::deque< Point >::iterator

using	const_iterator = std::deque< Point >::const_iterator

Protected Attributes inherited from corsika::Path
std::deque< Point >	points_
	The points that make up this path.

LengthType	length_ = LengthType::zero()
	The length of the path.

Detailed Description

Store the photon signal path between two points.

This is basically a container class

Definition at line 21 of file SignalPath.hpp.

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

Public Member Functions