Skip to content

Class astrea::trace::AntennaParameters

ClassList > astrea > trace > AntennaParameters

Class for storing and managing antenna parameters.

  • #include <Antenna.hpp>

Inherits the following classes: astrea::trace::SensorParameters

Public Functions

Type Name
AntennaParameters (const FieldOfView * fov, const Length & diameter, const Unitless & efficiency, const Frequency & frequency, const Power & power, const astro::CartesianVector< Distance, astro::frames::dynamic::ric > & boresight=astro::NADIR_RIC, const astro::CartesianVector< Distance, astro::frames::dynamic::ric > & attachmentPoint=astro::CENTER, const Frequency & noiseBandwidth=0.0 *mp_units:🇸🇮:unit_symbols::GHz, const Gain & transmitLoss=1.0 *mp_units::one, const Gain & receiverLoss=1.0 *mp_units::one, const PatternApproximation & pattern=PatternApproximation::BESSEL)
Construct a new Antenna Parameters object.
Length get_diameter () const
Get the diameter of the antenna.
Unitless get_efficiency () const
Get the efficiency of the antenna.
Power get_eirp () const
Get the equivalent isotropic radiated power (EIRP) of the antenna.
Frequency get_frequency () const
Get the frequency of the antenna.
Gain get_gain () const
Get the gain of the antenna.
Frequency get_noise_bandwidth () const
Get the noise bandwidth of the antenna.
PatternApproximation get_pattern () const
Get the pattern approximation method of the antenna.
Power get_power () const
Get the power of the antenna.
Gain get_receiver_loss () const
Get the receiver loss of the antenna.
Temperature get_system_noise_temperature () const
Get the system noise temperature of the antenna.
Gain get_transmit_loss () const
Get the transmit loss of the antenna.
Length get_wavelength () const
Get the wavelength of the antenna.
void set_diameter (const Length & diameter)
Set the diameter of the antenna.
void set_efficiency (const Unitless & efficiency)
Set the efficiency of the antenna.
void set_frequency (const Frequency & frequency)
Set the frequency of the antenna.
void set_noise_bandwidth (const Frequency & noiseBandwidth)
Set the noise bandwidth of the antenna.
void set_pattern (const PatternApproximation & pattern)
Set the pattern approximation method of the antenna.
void set_power (const Power & power)
Set the power of the antenna.
void set_receiver_loss (const Gain & receiverLoss)
Set the receiver loss of the antenna.
void set_transmit_loss (const Gain & transmitLoss)
Set the transmit loss of the antenna.
~AntennaParameters () = default
Default constructor for AntennaParameters .

Public Functions inherited from astrea::trace::SensorParameters

See astrea::trace::SensorParameters

Type Name
SensorParameters (const FieldOfView * fov=nullptr, const astro::CartesianVector< Distance, astro::frames::dynamic::ric > & boresight=astro::NADIR_RIC, const astro::CartesianVector< Distance, astro::frames::dynamic::ric > & attachmentPoint=astro::CENTER)
Constructor for SensorParameters .
const FieldOfView * get_fov () const
Get the field of view of the sensor.
void set_fov (FieldOfView * fov)
Set the field of view of the sensor.
virtual ~SensorParameters () = default
Default destructor for SensorParameters .

Protected Attributes inherited from astrea::trace::SensorParameters

See astrea::trace::SensorParameters

Type Name
const FieldOfView * _fov
Field of view of the sensor, defining its coverage area.

Public Functions Documentation

function AntennaParameters

Construct a new Antenna Parameters object. 

inline astrea::trace::AntennaParameters::AntennaParameters (
    const FieldOfView * fov,
    const Length & diameter,
    const Unitless & efficiency,
    const Frequency & frequency,
    const Power & power,
    const astro::CartesianVector< Distance, astro::frames::dynamic::ric > & boresight=astro::NADIR_RIC,
    const astro::CartesianVector< Distance, astro::frames::dynamic::ric > & attachmentPoint=astro::CENTER,
    const Frequency & noiseBandwidth=0.0 *mp_units::si::unit_symbols::GHz,
    const Gain & transmitLoss=1.0 *mp_units::one,
    const Gain & receiverLoss=1.0 *mp_units::one,
    const PatternApproximation & pattern=PatternApproximation::BESSEL
)

Parameters:

  • fov Field of View for the antenna.
  • diameter Reflector diameter.
  • efficiency Aperture illumination efficiency.
  • frequency Carrier frequency.
  • power Transmit power.
  • boresight Boresight direction in RIC coordinates (default is Nadir).
  • attachmentPoint Attachment point in RIC coordinates (default is Center).
  • noiseBandwidth Equivalent noise bandwidth (default is 0.0, ideal).
  • transmitLoss Transmit loss (default is 1.0, ideal).
  • receiverLoss Receiver loss (default is 1.0, ideal).
  • pattern Pattern approximation method (default is Bessel).

function get_diameter

Get the diameter of the antenna. 

inline Length astrea::trace::AntennaParameters::get_diameter () const

Returns:

Length Diameter of the antenna.

function get_efficiency

Get the efficiency of the antenna. 

inline Unitless astrea::trace::AntennaParameters::get_efficiency () const

Returns:

Unitless Efficiency of the antenna.

function get_eirp

Get the equivalent isotropic radiated power (EIRP) of the antenna. 

inline Power astrea::trace::AntennaParameters::get_eirp () const

Returns:

Power EIRP of the antenna.

function get_frequency

Get the frequency of the antenna. 

inline Frequency astrea::trace::AntennaParameters::get_frequency () const

Returns:

Frequency Frequency of the antenna.

function get_gain

Get the gain of the antenna. 

inline Gain astrea::trace::AntennaParameters::get_gain () const

Returns:

Gain Gain of the antenna.

function get_noise_bandwidth

Get the noise bandwidth of the antenna. 

inline Frequency astrea::trace::AntennaParameters::get_noise_bandwidth () const

Returns:

Frequency Noise bandwidth of the antenna.

function get_pattern

Get the pattern approximation method of the antenna. 

inline PatternApproximation astrea::trace::AntennaParameters::get_pattern () const

Returns:

PatternApproximation Pattern approximation method of the antenna.

function get_power

Get the power of the antenna. 

inline Power astrea::trace::AntennaParameters::get_power () const

Returns:

Power Power of the antenna.

function get_receiver_loss

Get the receiver loss of the antenna. 

inline Gain astrea::trace::AntennaParameters::get_receiver_loss () const

Returns:

Gain Receiver loss of the antenna.

function get_system_noise_temperature

Get the system noise temperature of the antenna. 

inline Temperature astrea::trace::AntennaParameters::get_system_noise_temperature () const

Returns:

Temperature System noise temperature of the antenna.

function get_transmit_loss

Get the transmit loss of the antenna. 

inline Gain astrea::trace::AntennaParameters::get_transmit_loss () const

Returns:

Gain Transmit loss of the antenna.

function get_wavelength

Get the wavelength of the antenna. 

inline Length astrea::trace::AntennaParameters::get_wavelength () const

Returns:

Length Wavelength of the antenna.

function set_diameter

Set the diameter of the antenna. 

inline void astrea::trace::AntennaParameters::set_diameter (
    const Length & diameter
)

Parameters:

  • diameter Length Diameter of the antenna.

function set_efficiency

Set the efficiency of the antenna. 

inline void astrea::trace::AntennaParameters::set_efficiency (
    const Unitless & efficiency
)

Parameters:

  • efficiency Unitless Efficiency of the antenna.

function set_frequency

Set the frequency of the antenna. 

inline void astrea::trace::AntennaParameters::set_frequency (
    const Frequency & frequency
)

Parameters:

  • frequency Frequency Frequency of the antenna.

function set_noise_bandwidth

Set the noise bandwidth of the antenna. 

inline void astrea::trace::AntennaParameters::set_noise_bandwidth (
    const Frequency & noiseBandwidth
)

Parameters:

  • noiseBandwidth Frequency Noise bandwidth of the antenna.

function set_pattern

Set the pattern approximation method of the antenna. 

inline void astrea::trace::AntennaParameters::set_pattern (
    const PatternApproximation & pattern
)

Parameters:

  • pattern PatternApproximation Pattern approximation method of the antenna.

function set_power

Set the power of the antenna. 

inline void astrea::trace::AntennaParameters::set_power (
    const Power & power
)

Parameters:

  • power Power Power of the antenna.

function set_receiver_loss

Set the receiver loss of the antenna. 

inline void astrea::trace::AntennaParameters::set_receiver_loss (
    const Gain & receiverLoss
)

Parameters:

  • receiverLoss Gain Receiver loss of the antenna.

function set_transmit_loss

Set the transmit loss of the antenna. 

inline void astrea::trace::AntennaParameters::set_transmit_loss (
    const Gain & transmitLoss
)

Parameters:

  • transmitLoss Gain Transmit loss of the antenna.

function ~AntennaParameters

Default constructor for AntennaParameters . 

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

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