Skip to content

Class astrea::trace::CircularFieldOfView

ClassList > astrea > trace > CircularFieldOfView

Circular field of view implementation. More...

  • #include <CircularFieldOfView.hpp>

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

Public Functions

Type Name
CircularFieldOfView (const Angle & halfConeAngle=std::numbers::pi/4.0 *mp_units::angular::unit_symbols::rad)
Constructor for CircularFieldOfView .
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 circular field of view.
~CircularFieldOfView () = default
Default destructor for CircularFieldOfView .

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 circular field of view defined by a half-cone angle.

Public Functions Documentation

function CircularFieldOfView

Constructor for CircularFieldOfView . 

inline astrea::trace::CircularFieldOfView::CircularFieldOfView (
    const Angle & halfConeAngle=std::numbers::pi/4.0 *mp_units::angular::unit_symbols::rad
)

Parameters:

  • halfConeAngle The half-cone angle defining the field of view.

function contains

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

virtual bool astrea::trace::CircularFieldOfView::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 circular field of view.

Returns:

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

Implements astrea::trace::FieldOfView::contains

function ~CircularFieldOfView

Default destructor for CircularFieldOfView . 

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

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