MCAntenna

class pyarts3.arts.MCAntenna(*args, **kwargs)

Monte Carlo Antenna pattern class

Overview

Method	draw_los()	Draw a random line of sight for the current antenna pattern
Method	return_los()	Return the line of sight for a given azimuth and zenith angle
Method	set_gaussian()	Set the antenna pattern to a Gaussian
Method	set_gaussian_fwhm()	Set the antenna pattern to a Gaussian
Method	set_lookup()	Set the antenna pattern from a lookup table
Method	set_pencil_beam()	Set the antenna pattern to a pencil beam
Matrix	G_lookup	The lookup table for the antenna gain
Vector	aa_grid	The azimuth grid
AntennaType	atype	The type of antenna pattern to use
Numeric	sigma_aa	The spread of azimith to use
Numeric	sigma_za	The spread of zenith to use
Vector	za_grid	The zenith grid
Operator	__eq__()	Return self==value.
Operator	__format__()	Default object formatter.
Operator	__ge__()	Return self>=value.
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self) -> None
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	Return repr(self).
Operator	__str__()	Return str(self).

Constructors

__init__(self) → None

Methods

draw_los(self, rng: pyarts3.arts.RandomNumberGenerator, R_ant2enu: pyarts3.arts.Matrix33, bore_sight_los: pyarts3.arts.Vector2) → tuple[pyarts3.arts.Vector2, pyarts3.arts.Matrix33]

Draw a random line of sight for the current antenna pattern :param rng: A random number generator to use for sampling the antenna pattern :type rng: RandomNumberGenerator :param R_ant2enu: The rotation matrix from the antenna frame to the ENU frame :type R_ant2enu: Matrix33 :param bore_sight_los: The line of sight for the boresight of the antenna, in terms of zenith and azimuth angles :type bore_sight_los: Vector2

Returns:

(sampled_rte_los, R_los) –

sampled_rte_losVector2

The sampled line of sight in terms of zenith and azimuth angles

R_losMatrix33

The rotation matrix corresponding to the sampled line of sight

Return type:

Tuple[Vector2, Matrix33]

return_los(self, R_return: pyarts3.arts.Matrix33, R_enu2ant: pyarts3.arts.Matrix33) → float

Return the line of sight for a given azimuth and zenith angle :param R_return: The rotation matrix from the return path to the ENU frame :type R_return: Matrix33 :param R_enu2ant: The rotation matrix from the ENU frame to the antenna frame :type R_enu2ant: Matrix33

Returns:

The line of sight for the given angles, normalized by the antenna gain at the boresight

Return type:

Numeric

set_gaussian(self, za_sigma: float, aa_sigma: float) → None

Set the antenna pattern to a Gaussian

Parameters:

• za_sigma (Numeric) – The standard deviation of the Gaussian in the zenith direction

• aa_sigma (Numeric) – The standard deviation of the Gaussian in the azimuth direction

set_gaussian_fwhm(self, za_fwhm: float, aa_fwhm: float) → None

Set the antenna pattern to a Gaussian

Parameters:

• za_fwhm (Numeric) – The full width half maximum of the Gaussian in the zenith direction

• aa_fwhm (Numeric) – The full width half maximum of the Gaussian in the azimuth direction

set_lookup(self, za: pyarts3.arts.Vector, aa: pyarts3.arts.Vector, G: pyarts3.arts.Matrix) → None

Set the antenna pattern from a lookup table

Parameters:

• za (Vector) – The zenith angle grid for the lookup table

• aa (Vector) – The azimuth angle grid for the lookup table

• G (Matrix) – The gain values for the lookup table, where G[i, j] corresponds to za[i] and aa[j]

set_pencil_beam(self) → None

Set the antenna pattern to a pencil beam

Attributes

G_lookup: Matrix

The lookup table for the antenna gain

aa_grid: Vector

The azimuth grid

atype: AntennaType

The type of antenna pattern to use

sigma_aa: Numeric

The spread of azimith to use

sigma_za: Numeric

The spread of zenith to use

za_grid: Vector

The zenith grid

Operators

__eq__(value, /)

Return self==value.

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(value, /)

Return self>=value.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__()

Return repr(self).

__str__()

Return str(self).