Class astrea::trace::Antenna¶

ClassList > astrea > trace > Antenna

Represents an antenna with properties such as diameter, efficiency, frequency, and power. More...

#include <Antenna.hpp>

Inherits the following classes: astrea::trace::Sensor

Public Attributes inherited from astrea::trace::Sensor¶

Type	Name
const SensorParameters &	parameters

Public Functions¶

Type	Name
	Antenna (const T & parent, const AntennaParameters & antennaParameters) Construct a new Antenna object.
Gain	atmospheric_loss () const Calculate the atmospheric loss for the antenna.
CNR	carrier_to_noise_density (const Antenna & receiver, const Distance & range, const Angle & offsetAngle) const Calculate the carrier-to-noise density (CND) for the antenna.
CNR	carrier_to_noise_ratio (const Antenna & receiver, const Distance & range, const Angle & offsetAngle) const Calculate the carrier-to-noise ratio (CNR) for the antenna.
Gain	free_space_loss (const Distance & range) const Calculate the free space loss for the antenna.
Gain	gain () const Get antenna gain.
Gain	mispointing_loss (const Antenna & receiver, const Angle & offsetAngle) const Calculate the mispointing loss for the antenna.
Gain	polarization_loss (const Antenna & receiver) const Calculate the polarization loss for the antenna.
Gain	receiver_loss () const Get the receiver loss.
Power	recieved_power (const Antenna & receiver, const Distance & range, const Angle & offsetAngle) const Calculate the received power at the receiver.
void	set_pattern_approximation (const PatternApproximation & pattern) Set the pattern approximation method.
Gain	system_loss (const Antenna & receiver, const Angle & offsetAngle) const Calculate the system loss for the antenna.
Temperature	system_noise_temperature () const Get the system noise temperature.
Gain	transmit_loss () const Get the transmit loss.

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

See astrea::trace::Sensor

Type	Name
const SensorParameters	Payload (parent, parameters)
bool	contains (const astro::RadiusVector< astro::frames::earth::icrf > & sensor2target, const astro::Date & date) const Check if the sensor can see a target given the boresight vector.
virtual std::size_t	get_id () const Get the ID of the sensor.
	requires (std::is_base_of_v< astro::FrameReference, Parent_T >) const Constructs a Sensor from aFieldOfView object.
virtual	~Sensor () = default Default destructor for Sensor .

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

See astrea::trace::AccessObject

Type	Name
void	add_access (const std::size_t & receiverId, const RiseSetArray & access) Adds access times for a specific receiver.
void	drop_access (const std::size_t & receiverId, const RiseSetArray & access) Drops access times for a specific receiver.
AccessArray &	get_accesses () Gets the access times for this object.
const AccessArray &	get_accesses () const Gets the access times for this object (const version).
virtual std::size_t	get_id () const = 0 Pure virtual function to get the ID of the object.

Protected Functions inherited from astrea::trace::AccessObject¶

See astrea::trace::AccessObject

Type	Name
	AccessObject () = default Default constructor.
virtual	~AccessObject () = default Default destructor.

Detailed Description¶

The Antenna class provides methods to calculate signal strength, losses, and other antenna-related properties.

Public Functions Documentation¶

function Antenna¶

Construct a new Antenna object.

template<typename T>
inline astrea::trace::Antenna::Antenna (
    const T & parent,
    const AntennaParameters & antennaParameters
)

function atmospheric_loss¶

Calculate the atmospheric loss for the antenna.

Gain astrea::trace::Antenna::atmospheric_loss () const

Returns:

Gain The calculated atmospheric loss.

function carrier_to_noise_density¶

Calculate the carrier-to-noise density (CND) for the antenna.

CNR astrea::trace::Antenna::carrier_to_noise_density (
    const Antenna & receiver,
    const Distance & range,
    const Angle & offsetAngle
) const

Parameters:

receiver Antenna object representing the receiver.
range Distance to the receiver.
offsetAngle Angle offset from the boresight.

Returns:

CNR The calculated carrier-to-noise density.

function carrier_to_noise_ratio¶

Calculate the carrier-to-noise ratio (CNR) for the antenna.

CNR astrea::trace::Antenna::carrier_to_noise_ratio (
    const Antenna & receiver,
    const Distance & range,
    const Angle & offsetAngle
) const

Parameters:

receiver Antenna object representing the receiver.
range Distance to the receiver.
offsetAngle Angle offset from the boresight.

Returns:

CNR The calculated carrier-to-noise ratio.

function free_space_loss¶

Calculate the free space loss for the antenna.

Gain astrea::trace::Antenna::free_space_loss (
    const Distance & range
) const

Parameters:

range Distance to the receiver.

Returns:

Gain The calculated free space loss.

function gain¶

Get antenna gain.

Gain astrea::trace::Antenna::gain () const

Returns:

Gain The gain of the antenna.

function mispointing_loss¶

Calculate the mispointing loss for the antenna.

Gain astrea::trace::Antenna::mispointing_loss (
    const Antenna & receiver,
    const Angle & offsetAngle
) const

Parameters:

receiver Antenna object representing the receiver.
offsetAngle Angle offset from the boresight.

Returns:

Gain The calculated mispointing loss.

function polarization_loss¶

Calculate the polarization loss for the antenna.

Gain astrea::trace::Antenna::polarization_loss (
    const Antenna & receiver
) const

Parameters:

receiver Antenna object representing the receiver.

Returns:

Gain The calculated polarization loss.

function receiver_loss¶

Get the receiver loss.

Gain astrea::trace::Antenna::receiver_loss () const

Returns:

Gain The receiver loss.

function recieved_power¶

Calculate the received power at the receiver.

Power astrea::trace::Antenna::recieved_power (
    const Antenna & receiver,
    const Distance & range,
    const Angle & offsetAngle
) const

Parameters:

receiver Antenna object representing the receiver.
range Distance to the receiver.
offsetAngle Angle offset from the boresight.

Returns:

Power The calculated received power.

function set_pattern_approximation¶

Set the pattern approximation method.

void astrea::trace::Antenna::set_pattern_approximation (
    const PatternApproximation & pattern
)

Parameters:

pattern Pattern approximation method to set.

function system_loss¶

Calculate the system loss for the antenna.

Gain astrea::trace::Antenna::system_loss (
    const Antenna & receiver,
    const Angle & offsetAngle
) const

Parameters:

receiver Antenna object representing the receiver.
offsetAngle Angle offset from the boresight.

Returns:

Gain The calculated system loss.

function system_noise_temperature¶

Get the system noise temperature.

Temperature astrea::trace::Antenna::system_noise_temperature () const

Returns:

Temperature The system noise temperature.

function transmit_loss¶

Get the transmit loss.

Gain astrea::trace::Antenna::transmit_loss () const

Returns:

Gain The transmit loss.

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