spectral_propmat_scat_spectral_agendaOperator

class pyarts3.arts.spectral_propmat_scat_spectral_agendaOperator(*args, **kwargs)

This is the operator for free customization of the agenda: spectral_propmat_scat_spectral_agenda.

The python meta-code to make use of this operator class instead of the standard agenda in a workspace reads like this:

import pyarts3 as pyarts

ws = pyarts.Workspace()

def my_spectral_propmat_scat_spectral_agenda_operator(freq_grid, atm_point, legendre_degree):
    ...
    # custom code that creates or modifies spectral_propmat_scat, spectral_absvec_scat, spectral_phamat_spectral
    ...
    return spectral_propmat_scat, spectral_absvec_scat, spectral_phamat_spectral

ws.spectral_propmat_scat_spectral_agendaSetOperator(f=my_spectral_propmat_scat_spectral_agenda_operator)

You are free to put whatever custom code you want in the operator. The types returned must be convertible to the types of the workspace variables being returned. The input to the operator from the workspace will be the types of the workspace variables that are passed to the agenda. Failure to follow these rules will result in a runtime error.

Note

There might be constraints on the input and output passed to the operator. Check the documentation of the agenda for more details.

Warning

Accessing global variables in the operator is not thread safe. It is very likely ARTS will access your operator in parallel. You need to make sure that the operator is thread safe.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
Operator	`__call__()`	Execute the method directly in python
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`	Helper for pickle.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg: pyarts3.arts.spectral_propmat_scat_spectral_agendaOperator) -> None
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, arg: collections.abc.Callable[[pyarts3.arts.AscendingGrid, pyarts3.arts.AtmPoint, int], tuple[pyarts3.arts.PropmatVector, pyarts3.arts.StokvecVector, pyarts3.arts.SpecmatMatrix]], /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.spectral_propmat_scat_spectral_agendaOperator) → 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.spectral_propmat_scat_spectral_agendaOperator

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

Operators

__call__(self, freq_grid: pyarts3.arts.AscendingGrid, atm_point: pyarts3.arts.AtmPoint, legendre_degree: int) → tuple[pyarts3.arts.PropmatVector, pyarts3.arts.StokvecVector, pyarts3.arts.SpecmatMatrix]

Execute the method directly in python

Parameters:

freq_grid (AscendingGrid) – A frequency grid. Unit: Hz. See also freq_grid.
atm_point (AtmPoint) – An atmospheric point in ARTS. See also atm_point.
legendre_degree (Index) – The degree of a Legendre polynimial. See also legendre_degree.

Returns:

spectral_propmat_scat (PropmatVector) – This contains the propagation matrix for scattering for the current path point. See also spectral_propmat_scat.
spectral_absvec_scat (StokvecVector) – The absorption vector of totally random orientation particles at a single point along a path using spectral representation. See also spectral_absvec_scat.
spectral_phamat_spectral (SpecmatMatrix) – The spectral phase matrix of totally random orientation particles at a single point along a path using spectral representation. See also spectral_phamat_spectral.

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

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

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

__getstate__(): Helper for pickle.

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

__hash__(): Return hash(self).

__init__(self, arg: collections.abc.Callable[[pyarts3.arts.AscendingGrid, pyarts3.arts.AtmPoint, int], tuple[pyarts3.arts.PropmatVector, pyarts3.arts.StokvecVector, pyarts3.arts.SpecmatMatrix]], /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.spectral_propmat_scat_spectral_agendaOperator) → None

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

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

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

__repr__(self) → str

__str__(self) → str