Class astrea::trace::PolygonalFieldOfView¶

ClassList > astrea > trace > PolygonalFieldOfView

Polygonal field of view implementation. More...

#include <PolygonalFieldOfView.hpp>

Inherits the following classes: astrea::trace::FieldOfView

Public Functions¶

Type	Name
	PolygonalFieldOfView (const Angle & halfConeAngle=std::numbers::pi/4.0 mp_units::angular::unit_symbols::rad, const int & nPoints=72) Constructor for* PolygonalFieldOfView .
	PolygonalFieldOfView (const Angle & halfConeWidth, const Angle & halfConeHeight, const int & nPoints=72) Constructor for PolygonalFieldOfView with specified half-cone width and height.
	PolygonalFieldOfView (const gtl::btree_map< Angle, Angle > & points) Constructor for PolygonalFieldOfView with a set of points.
virtual bool	contains (const astro::CartesianVector< Distance, astro::frames::earth::icrf > & boresight, const astro::CartesianVector< Distance, astro::frames::earth::icrf > & target) const Checks if a target is within the polygonal field of view.
	~PolygonalFieldOfView () = default Default destructor for PolygonalFieldOfView .

Public Functions inherited from astrea::trace::FieldOfView¶

See astrea::trace::FieldOfView

Type	Name
	FieldOfView () = default Default constructor for FieldOfView .
virtual bool	contains (const astro::CartesianVector< Distance, astro::frames::earth::icrf > & boresight, const astro::CartesianVector< Distance, astro::frames::earth::icrf > & target) const = 0 Checks if a target is within the field of view.
	~FieldOfView () = default Virtual destructor for FieldOfView .

Detailed Description¶

This class represents a polygonal field of view defined by a set of points.

Public Functions Documentation¶

function PolygonalFieldOfView [1/3]¶

Constructor for PolygonalFieldOfView .

astrea::trace::PolygonalFieldOfView::PolygonalFieldOfView (
    const Angle & halfConeAngle=std::numbers::pi/4.0 *mp_units::angular::unit_symbols::rad,
    const int & nPoints=72
)

Parameters:

halfConeAngle The half-cone angle defining the field of view.
nPoints The number of points defining the polygon.

function PolygonalFieldOfView [2/3]¶

Constructor for PolygonalFieldOfView with specified half-cone width and height.

astrea::trace::PolygonalFieldOfView::PolygonalFieldOfView (
    const Angle & halfConeWidth,
    const Angle & halfConeHeight,
    const int & nPoints=72
)

Parameters:

halfConeWidth The half-cone width angle.
halfConeHeight The half-cone height angle.
nPoints The number of points defining the polygon.

function PolygonalFieldOfView [3/3]¶

Constructor for PolygonalFieldOfView with a set of points.

inline astrea::trace::PolygonalFieldOfView::PolygonalFieldOfView (
    const gtl::btree_map< Angle, Angle > & points
)

Parameters:

points A map of angles defining the polygonal field of view.

function contains¶

Checks if a target is within the polygonal field of view.

virtual bool astrea::trace::PolygonalFieldOfView::contains (
    const astro::CartesianVector< Distance, astro::frames::earth::icrf > & boresight,
    const astro::CartesianVector< Distance, astro::frames::earth::icrf > & target
) const

Parameters:

boresight The boresight vector of the sensor.
target The target vector to check.

Returns:

true If the target is within the polygonal field of view.

Returns:

false If the target is outside the polygonal field of view.

Implements astrea::trace::FieldOfView::contains

function ~PolygonalFieldOfView¶

Default destructor for PolygonalFieldOfView .

astrea::trace::PolygonalFieldOfView::~PolygonalFieldOfView () = default

The documentation for this class was generated from the following file astrea/trace/trace/platforms/sensors/fov/instances/PolygonalFieldOfView.hpp