antenna::Gaussian Class Reference

Represents a Gaussian-shaped antenna gain pattern. More...

#include "antenna_factory.h"

Inheritance diagram for antenna::Gaussian:

Collaboration diagram for antenna::Gaussian:

Public Member Functions
	Gaussian (const std::string_view name, const RealType azscale, const RealType elscale, const SimId id=0)
	Constructs a Gaussian antenna with the given parameters.
	~Gaussian () override=default
	Gaussian (const Gaussian &)=delete
Gaussian &	operator= (const Gaussian &)=delete
	Gaussian (Gaussian &&)=delete
Gaussian &	operator= (Gaussian &&)=delete
RealType	getGain (const math::SVec3 &angle, const math::SVec3 &refangle, RealType wavelength) const noexcept override
	Computes the gain of the Gaussian antenna.
RealType	getAzimuthScale () const noexcept
	Gets the azimuth scale factor.
RealType	getElevationScale () const noexcept
	Gets the elevation scale factor.
void	setAzimuthScale (RealType azscale) noexcept
	Sets the azimuth scale factor of the Gaussian function.
void	setElevationScale (RealType elscale) noexcept
	Sets the elevation scale factor of the Gaussian function.
RealType	getEfficiencyFactor () const noexcept
	Retrieves the efficiency factor of the antenna.
std::string	getName () const noexcept
	Retrieves the name of the antenna.
SimId	getId () const noexcept
	Retrieves the unique ID of the antenna.
virtual RealType	getNoiseTemperature (const math::SVec3 &) const noexcept
	Computes the noise temperature of the antenna based on the angle.
void	setEfficiencyFactor (RealType loss) noexcept
	Sets the efficiency factor of the antenna.
void	setName (std::string name) noexcept
	Sets the name of the antenna.

Static Protected Member Functions
static RealType	getAngle (const math::SVec3 &angle, const math::SVec3 &refangle) noexcept
	Computes the angle between the input and reference angles.

Detailed Description

Represents a Gaussian-shaped antenna gain pattern.

This antenna has a gain pattern that follows a Gaussian distribution.

Definition at line 259 of file antenna_factory.h.

Constructor & Destructor Documentation

Gaussian() [1/3]

antenna::Gaussian::Gaussian	(	const std::string_view	name,
		const RealType	azscale,
		const RealType	elscale,
		const SimId	id = 0
	)

Constructs a Gaussian antenna with the given parameters.

Parameters

name	The name of the antenna.
azscale	The azimuth scale factor.
elscale	The elevation scale factor.

Definition at line 269 of file antenna_factory.h.

                                                                                                                :
            Antenna(name.data(), id), _azscale(azscale), _elscale(elscale)
        {
        }

~Gaussian()

antenna::Gaussian::~Gaussian ( )

overridedefault

Gaussian() [2/3]

antenna::Gaussian::Gaussian ( const Gaussian &  )

delete

Gaussian() [3/3]

antenna::Gaussian::Gaussian ( Gaussian &&  )

delete

Member Function Documentation

getAngle()

RealType antenna::Antenna::getAngle ( const math::SVec3 &  angle, const math::SVec3 &  refangle  )

staticprotectednoexceptinherited

Computes the angle between the input and reference angles.

Parameters

angle	The input angle.
refangle	The reference angle.

Returns

The computed angle.

Definition at line 325 of file antenna_factory.cpp.

    {
        SVec3 normangle(angle);
        normangle.length = 1;
        return std::acos(dotProduct(Vec3(normangle), Vec3(refangle)));
    }

References math::SVec3::length.

getAzimuthScale()

RealType antenna::Gaussian::getAzimuthScale ( ) const

noexcept

Gets the azimuth scale factor.

Definition at line 296 of file antenna_factory.h.

{ return _azscale; }

Referenced by serial::kml_generator_utils::findGaussian3DbDropAngle().

Here is the caller graph for this function:

getEfficiencyFactor()

RealType antenna::Antenna::getEfficiencyFactor ( ) const

noexceptinherited

Retrieves the efficiency factor of the antenna.

Returns

The efficiency factor of the antenna.

Definition at line 79 of file antenna_factory.h.

{ return _loss_factor; }

Referenced by antenna::Isotropic::getGain(), antenna::XmlAntenna::getGain(), antenna::H5Antenna::getGain(), and antenna::to_json().

Here is the caller graph for this function:

getElevationScale()

RealType antenna::Gaussian::getElevationScale ( ) const

noexcept

Gets the elevation scale factor.

Definition at line 299 of file antenna_factory.h.

{ return _elscale; }

getGain()

RealType antenna::Gaussian::getGain ( const math::SVec3 &  angle, const math::SVec3 &  refangle, RealType  wavelength  ) const

overridevirtualnoexcept

Computes the gain of the Gaussian antenna.

Parameters

angle	The angle at which the gain is to be computed.
refangle	The reference angle.
wavelength	The wavelength of the signal.

Returns

The computed gain of the antenna.

Implements antenna::Antenna.

Definition at line 332 of file antenna_factory.cpp.

    {
        const SVec3 a = angle - refangle;
        return std::exp(-a.azimuth * a.azimuth * _azscale) * std::exp(-a.elevation * a.elevation * _elscale);
    }

References math::SVec3::azimuth, and math::SVec3::elevation.

getId()

SimId antenna::Antenna::getId ( ) const

noexceptinherited

Retrieves the unique ID of the antenna.

Returns

The antenna SimId.

Definition at line 93 of file antenna_factory.h.

{ return _id; }

Referenced by antenna::to_json(), radar::to_json(), and radar::to_json().

Here is the caller graph for this function:

getName()

std::string antenna::Antenna::getName ( ) const

noexceptinherited

Retrieves the name of the antenna.

Returns

The name of the antenna.

Definition at line 86 of file antenna_factory.h.

{ return _name; }

Referenced by serial::kml_generator_utils::findGaussian3DbDropAngle(), serial::kml_generator_utils::findParabolic3DbDropAngle(), serial::kml_generator_utils::findSquareHorn3DbDropAngle(), serial::kml_generator_utils::generateAntennaKml(), serial::xml_serializer_utils::serializeMonostatic(), serial::xml_serializer_utils::serializeReceiver(), serial::xml_serializer_utils::serializeTransmitter(), and antenna::to_json().

Here is the caller graph for this function:

getNoiseTemperature()

virtual RealType antenna::Antenna::getNoiseTemperature ( const math::SVec3 &  ) const

virtualnoexceptinherited

Computes the noise temperature of the antenna based on the angle.

Parameters

angle

The angle at which the noise temperature is to be computed.

Returns

The noise temperature of the antenna.

Definition at line 102 of file antenna_factory.h.

{ return 0; }

operator=() [1/2]

Gaussian & antenna::Gaussian::operator= ( const Gaussian &  )

delete

operator=() [2/2]

Gaussian & antenna::Gaussian::operator= ( Gaussian &&  )

delete

setAzimuthScale()

void antenna::Gaussian::setAzimuthScale ( RealType  azscale )

noexcept

Sets the azimuth scale factor of the Gaussian function.

Parameters

azscale

The new azimuth scale factor.

Definition at line 306 of file antenna_factory.h.

{ _azscale = azscale; }

setEfficiencyFactor()

void antenna::Antenna::setEfficiencyFactor ( RealType  loss )

noexceptinherited

Sets the efficiency factor of the antenna.

Parameters

loss	The new efficiency factor.

Definition at line 316 of file antenna_factory.cpp.

    {
        if (loss > 1)
        {
            LOG(Level::INFO, "Using greater than unity antenna efficiency.");
        }
        _loss_factor = loss;
    }

References LOG.

Referenced by serial::update_antenna_from_json().

Here is the caller graph for this function:

setElevationScale()

void antenna::Gaussian::setElevationScale ( RealType  elscale )

noexcept

Sets the elevation scale factor of the Gaussian function.

Parameters

elscale

The new elevation scale factor.

Definition at line 313 of file antenna_factory.h.

{ _elscale = elscale; }

setName()

void antenna::Antenna::setName ( std::string  name )

noexceptinherited

Sets the name of the antenna.

Parameters

name	The new name of the antenna.

Definition at line 116 of file antenna_factory.h.

{ _name = std::move(name); }

Referenced by serial::update_antenna_from_json().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• packages/libfers/src/antenna/antenna_factory.h
• packages/libfers/src/antenna/antenna_factory.cpp