HeterodyneFrequencyRange

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

A staged heterodyne mixer and filter response builder.

Overview

Method	`bandpass()`	Apply an ideal bandpass filter on the current local frequency axis.
Method	`channel_response()`	Compute the real-frequency response for one spectrometer channel.
Method	`channel_responses()`	Overloaded function.
Method	`filter()`	Apply a weighted bandpass filter on the current local frequency axis.
Method	`global_response()`	Evaluate one path response on the original real-frequency axis.
Method	`highpass()`	Apply an ideal highpass filter on the current local frequency axis.
Method	`local_response()`	Evaluate one path response on the current local frequency axis.
Method	`lowpass()`	Apply an ideal lowpass filter on the current local frequency axis.
Method	`mix()`	Apply one heterodyne LO mixing stage.
Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`list`[`Vector2`]	`global_ranges`	Global frequency range
`list`[`Vector2`]	`local_ranges`	Local frequency range
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) → None

__init__(self, lo: float, bandpass: pyarts3.arts.Vector2 = [0, inf]) → None

__init__(self, lo: pyarts3.arts.ArrayOfNumeric, bandpasses: pyarts3.arts.ArrayOfVector2) → None

__init__(self) → None

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

Overloaded function.

__init__(self) -> None

Construct an empty staged heterodyne response.

Stages can then be applied in sequence using lowpass(), highpass(), bandpass(), filter(), and mix().

__init__(self, lo: float, bandpass: pyarts3.arts.Vector2 = [0, inf]) -> None

Construct a heterodyne response from one ideal bandpass and one LO stage.

This is shorthand for creating an empty object, applying bandpass(), and then applying mix().

__init__(self, lo: pyarts3.arts.ArrayOfNumeric, bandpasses: pyarts3.arts.ArrayOfVector2) -> None

Construct a heterodyne response from a sequence of ideal bandpass and LO stages.

The sequence is applied as bandpass[0] -> lo[0] -> bandpass[1] -> lo[1] -> ....

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

Methods

bandpass(self, bandpass: pyarts3.arts.Vector2) → None: Apply an ideal bandpass filter on the current local frequency axis.

channel_response(self, channel: pyarts3.arts.sensor.Channel) → pyarts3.arts.SortedGriddedField1: Compute the real-frequency response for one spectrometer channel.

The returned gridded field is aggregated across all active mixer paths.

channel_responses(self, channels: collections.abc.Sequence[pyarts3.arts.sensor.Channel]) → pyarts3.arts.ArrayOfSortedGriddedField1

channel_responses(self, spectrometer: pyarts3.arts.sensor.Spectrometer) → pyarts3.arts.ArrayOfSortedGriddedField1

Overloaded function.

channel_responses(self, channels: collections.abc.Sequence[pyarts3.arts.sensor.Channel]) -> pyarts3.arts.ArrayOfSortedGriddedField1

Compute the real-frequency response for multiple spectrometer channels.

Each returned gridded field is aggregated across all active mixer paths for the matching input channel.

channel_responses(self, spectrometer: pyarts3.arts.sensor.Spectrometer) -> pyarts3.arts.ArrayOfSortedGriddedField1

Compute the real-frequency response for all channels in a spectrometer.

Each returned gridded field is aggregated across all active mixer paths for the matching spectrometer channel.

filter(self, bandpass_filter: pyarts3.arts.SortedGriddedField1) → None: Apply a weighted bandpass filter on the current local frequency axis.

The filter weights are interpreted on the filter’s relative frequency grid and are zero outside that grid.

global_response(self, f: pyarts3.arts.Vector, path_index: int = 0) → pyarts3.arts.Vector: Evaluate one path response on the original real-frequency axis.

highpass(self, lower: float) → None: Apply an ideal highpass filter on the current local frequency axis.

local_response(self, f: pyarts3.arts.Vector, path_index: int = 0) → pyarts3.arts.Vector: Evaluate one path response on the current local frequency axis.

lowpass(self, upper: float) → None: Apply an ideal lowpass filter on the current local frequency axis.

mix(self, lo: float) → None: Apply one heterodyne LO mixing stage.

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.HeterodyneFrequencyRange

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

global_ranges: list[Vector2]: Global frequency range

local_ranges: list[Vector2]: Local frequency range

Operators

__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) → None

__init__(self, lo: float, bandpass: pyarts3.arts.Vector2 = [0, inf]) → None

__init__(self, lo: pyarts3.arts.ArrayOfNumeric, bandpasses: pyarts3.arts.ArrayOfVector2) → None

__init__(self) → None

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

Overloaded function.

__init__(self) -> None

Construct an empty staged heterodyne response.

Stages can then be applied in sequence using lowpass(), highpass(), bandpass(), filter(), and mix().

__init__(self, lo: float, bandpass: pyarts3.arts.Vector2 = [0, inf]) -> None

Construct a heterodyne response from one ideal bandpass and one LO stage.

This is shorthand for creating an empty object, applying bandpass(), and then applying mix().

__init__(self, lo: pyarts3.arts.ArrayOfNumeric, bandpasses: pyarts3.arts.ArrayOfVector2) -> None

Construct a heterodyne response from a sequence of ideal bandpass and LO stages.

The sequence is applied as bandpass[0] -> lo[0] -> bandpass[1] -> lo[1] -> ....

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

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

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

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

__repr__(self) → str

__str__(self) → str