spectral_propmat_and_atm_path_agendaOperator

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

This is the operator for free customization of the agenda. See spectral_propmat_and_atm_path_agendaOperator for more information.

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_and_atm_path_agenda_operator(ray_path, jac_targets, freq_grid, atm_field, surf_field):
    ...
    # custom code that creates or modifies spectral_propmat_path, spectral_nlte_srcvec_path, spectral_propmat_jac_path, spectral_nlte_srcvec_jac_path, freq_grid_path, freq_wind_shift_jac_path, atm_path, ray_path
    ...
    return spectral_propmat_path, spectral_nlte_srcvec_path, spectral_propmat_jac_path, spectral_nlte_srcvec_jac_path, freq_grid_path, freq_wind_shift_jac_path, atm_path, ray_path

ws.spectral_propmat_and_atm_path_agendaSetOperator(f=my_spectral_propmat_and_atm_path_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	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg: pyarts3.arts.spectral_propmat_and_atm_path_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.ArrayOfPropagationPathPoint, pyarts3.arts.JacobianTargets, pyarts3.arts.AscendingGrid, pyarts3.arts.AtmField, pyarts3.arts.SurfaceField], tuple[pyarts3.arts.ArrayOfPropmatVector, pyarts3.arts.ArrayOfStokvecVector, pyarts3.arts.ArrayOfPropmatMatrix, pyarts3.arts.ArrayOfStokvecMatrix, pyarts3.arts.ArrayOfAscendingGrid, pyarts3.arts.ArrayOfVector3, pyarts3.arts.ArrayOfAtmPoint, pyarts3.arts.ArrayOfPropagationPathPoint]], /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.spectral_propmat_and_atm_path_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_and_atm_path_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

Execute the method directly in python

Parameters:

ray_path (ArrayOfPropagationPathPoint) – A list path points making up a propagation path. See also ray_path.
jac_targets (JacobianTargets) – A list of targets for the Jacobian Matrix calculations. See also jac_targets.
freq_grid (AscendingGrid) – A frequency grid. Unit: Hz. See also freq_grid.
atm_field (AtmField) – An atmospheric field in ARTS, this is the main atmospheric data structure in ARTS. See also atm_field.
surf_field (SurfaceField) – The surface field. See also surf_field.

Returns:

spectral_propmat_path (ArrayOfPropmatVector) – Propagation matrices along the propagation path. See also spectral_propmat_path.
spectral_nlte_srcvec_path (ArrayOfStokvecVector) – Additional non-LTE along the propagation path. See also spectral_nlte_srcvec_path.
spectral_propmat_jac_path (ArrayOfPropmatMatrix) – Propagation derivative matrices along the propagation path. See also spectral_propmat_jac_path.
spectral_nlte_srcvec_jac_path (ArrayOfStokvecMatrix) – Additional non-LTE derivative along the propagation path. See also spectral_nlte_srcvec_jac_path.
freq_grid_path (ArrayOfAscendingGrid) – All freq_grid along the propagation path. See also freq_grid_path.
freq_wind_shift_jac_path (ArrayOfVector3) – A list of freq_wind_shift_jac for a ray path. See also freq_wind_shift_jac_path.
atm_path (ArrayOfAtmPoint) – Atmospheric points along the propagation path. See also atm_path.
ray_path (ArrayOfPropagationPathPoint) – A list path points making up a propagation path. See also ray_path.

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

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

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

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

__hash__(): Return hash(self).

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

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

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

__repr__(self) → str

__str__(self) → str