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)
	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.
RealType	getEfficiencyFactor () const noexcept
	Retrieves the efficiency factor of the antenna.
std::string	getName () const noexcept
	Retrieves the name 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.

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 217 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
	)

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 227 of file antenna_factory.h.

                                                                                            :
            Antenna(name.data()), _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 93 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 254 of file antenna_factory.h.

{ return _azscale; }

getEfficiencyFactor()

RealType antenna::Antenna::getEfficiencyFactor ( ) const

noexceptinherited

Retrieves the efficiency factor of the antenna.

Returns

The efficiency factor of the antenna.

Definition at line 73 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 257 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 100 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.

getName()

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

noexceptinherited

Retrieves the name of the antenna.

Returns

The name of the antenna.

Definition at line 80 of file antenna_factory.h.

{ return _name; }

Referenced by antenna::to_json(), radar::to_json(), and radar::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 89 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

setEfficiencyFactor()

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

noexceptinherited

Sets the efficiency factor of the antenna.

Parameters

loss	The new efficiency factor.

Definition at line 84 of file antenna_factory.cpp.

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

References LOG.

---

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