antenna::Sinc Class Reference

Represents a sinc function-based antenna gain pattern. More...

#include "antenna_factory.h"

Inheritance diagram for antenna::Sinc:

Collaboration diagram for antenna::Sinc:

Public Member Functions
	Sinc (const std::string_view name, const RealType alpha, const RealType beta, const RealType gamma)
	Constructs a Sinc antenna with the given parameters.
	~Sinc () override=default
	Sinc (const Sinc &)=delete
Sinc &	operator= (const Sinc &)=delete
	Sinc (Sinc &&)=delete
Sinc &	operator= (Sinc &&)=delete
RealType	getAlpha () const noexcept
	Gets the alpha parameter of the sinc function.
RealType	getBeta () const noexcept
	Gets the beta parameter of the sinc function.
RealType	getGamma () const noexcept
	Gets the gamma parameter of the sinc function.
RealType	getGain (const math::SVec3 &angle, const math::SVec3 &refangle, RealType wavelength) const noexcept override
	Computes the gain of the sinc antenna based on the input parameters.
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 sinc function-based antenna gain pattern.

This antenna has a gain pattern defined by a sinc function, with customizable parameters.

Definition at line 159 of file antenna_factory.h.

Constructor & Destructor Documentation

Sinc() [1/3]

antenna::Sinc::Sinc	(	const std::string_view	name,
		const RealType	alpha,
		const RealType	beta,
		const RealType	gamma
	)

Constructs a Sinc antenna with the given parameters.

Parameters

name	The name of the antenna.
alpha	The alpha parameter.
beta	The beta parameter.
gamma	The gamma parameter.

Definition at line 170 of file antenna_factory.h.

                                                                                                         :
            Antenna(name.data()), _alpha(alpha), _beta(beta), _gamma(gamma)
        {
        }

~Sinc()

antenna::Sinc::~Sinc ( )

overridedefault

Sinc() [2/3]

antenna::Sinc::Sinc ( const Sinc &  )

delete

Sinc() [3/3]

antenna::Sinc::Sinc ( Sinc &&  )

delete

Member Function Documentation

getAlpha()

RealType antenna::Sinc::getAlpha ( ) const

noexcept

Gets the alpha parameter of the sinc function.

Definition at line 186 of file antenna_factory.h.

{ return _alpha; }

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.

getBeta()

RealType antenna::Sinc::getBeta ( ) const

noexcept

Gets the beta parameter of the sinc function.

Definition at line 189 of file antenna_factory.h.

{ return _beta; }

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:

getGain()

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

overridevirtualnoexcept

Computes the gain of the sinc antenna based on the input parameters.

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 106 of file antenna_factory.cpp.

    {
        const RealType theta = getAngle(angle, refangle);
        const RealType sinc_val = sinc(_beta * theta);
        const RealType gain_pattern = std::pow(std::abs(sinc_val), _gamma);
        return _alpha * gain_pattern * getEfficiencyFactor();
    }

getGamma()

RealType antenna::Sinc::getGamma ( ) const

noexcept

Gets the gamma parameter of the sinc function.

Definition at line 192 of file antenna_factory.h.

{ return _gamma; }

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]

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

delete

operator=() [2/2]

Sinc & antenna::Sinc::operator= ( Sinc &&  )

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