Skip to content

Class astrea::trace::FieldOfView

ClassList > astrea > trace > FieldOfView

Base class for Field of View (FoV) representations. More...

  • #include <FieldOfView.hpp>

Inherited by the following classes: astrea::trace::CircularFieldOfView, astrea::trace::PolygonalFieldOfView

Public Functions

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 defines the interface for different types of fields of view.

Public Functions Documentation

function FieldOfView

Default constructor for FieldOfView . 

astrea::trace::FieldOfView::FieldOfView () = default

function contains

Checks if a target is within the field of view. 

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

Parameters:

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

Returns:

true If the target is within the field of view.

Returns:

false If the target is outside the field of view.

function ~FieldOfView

Virtual destructor for FieldOfView . 

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

Ensures proper cleanup of derived classes.

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