GaussianAntenna

class pyarts3.arts.sensor.GaussianAntenna(*args, **kwargs)

A Gaussian antenna response defined by angular offset from the bore LOS on a local zenith/azimuth grid.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`AntennaPatternField`	`response`	Local antenna response field.
Operator	`__call__()`	Map the antenna pattern onto one observation element.
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self, grid: pyarts3.arts.ZenGrid, std: float, azi_grid_size: int = 2, weight: pyarts3.arts.Stokvec = [1, 0, 0, 0]) → None

__init__(self) → None

__init__(self, arg: pyarts3.arts.sensor.GaussianAntenna) → None

Overloaded function.

__init__(self, grid: pyarts3.arts.ZenGrid, std: float, azi_grid_size: int = 2, weight: pyarts3.arts.Stokvec = [1, 0, 0, 0]) -> None

Construct a Gaussian antenna response on the supplied local grid. The azimuth grid is constructed from the provided size

__init__(self) -> None
__init__(self, arg: pyarts3.arts.sensor.GaussianAntenna) -> None

Methods

readxml(self, file: str) → str

Read variable from file.

Parameters:: file (str) – A file that can be read.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

Saves variable to file.

Parameters:

file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files.
type (str, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.
clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

fromxml(file: str) → pyarts3.arts.sensor.GaussianAntenna

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.
Returns:: artstype – The variable created from the file.
Return type:: T

Attributes

response: AntennaPatternField: Local antenna response field.

Operators

__call__(self, channel: pyarts3.arts.sensor.Channel, pos: pyarts3.arts.Vector3, bore_los: pyarts3.arts.Vector2, ell: pyarts3.arts.Vector2) → pyarts3.arts.SensorObsel: Map the antenna pattern onto one observation element.

__eq__(value, /): Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /): Return self>=value.

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

__init__(self, grid: pyarts3.arts.ZenGrid, std: float, azi_grid_size: int = 2, weight: pyarts3.arts.Stokvec = [1, 0, 0, 0]) → None

__init__(self) → None

__init__(self, arg: pyarts3.arts.sensor.GaussianAntenna) → None

Overloaded function.

__init__(self, grid: pyarts3.arts.ZenGrid, std: float, azi_grid_size: int = 2, weight: pyarts3.arts.Stokvec = [1, 0, 0, 0]) -> None

Construct a Gaussian antenna response on the supplied local grid. The azimuth grid is constructed from the provided size

__init__(self) -> None
__init__(self, arg: pyarts3.arts.sensor.GaussianAntenna) -> None

__le__(value, /): Return self<=value.

__lt__(value, /): Return self<value.

__ne__(value, /): Return self!=value.

__repr__(self) → str

__str__(self) → str