propagation_matrix_agendaOperator

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

This is the operator for free customization of the agenda: propagation_matrix_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_propagation_matrix_agenda_operator(frequency_grid, frequency_grid_wind_shift_jacobian, jacobian_targets, select_species, ray_path_point, atmospheric_point):
    ...
    # custom code that creates or modifies propagation_matrix, propagation_matrix_source_vector_nonlte, propagation_matrix_jacobian, propagation_matrix_source_vector_nonlte_jacobian
    ...
    return propagation_matrix, propagation_matrix_source_vector_nonlte, propagation_matrix_jacobian, propagation_matrix_source_vector_nonlte_jacobian

ws.propagation_matrix_agendaSetOperator(f=my_propagation_matrix_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.propagation_matrix_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.Vector3, pyarts3.arts.JacobianTargets, pyarts3.arts.SpeciesEnum, pyarts3.arts.PropagationPathPoint, pyarts3.arts.AtmPoint], tuple[pyarts3.arts.PropmatVector, pyarts3.arts.StokvecVector, pyarts3.arts.PropmatMatrix, pyarts3.arts.StokvecMatrix]], /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.propagation_matrix_agendaOperator) → None

Methods

readxml(self, file: str) → str

Read variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

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) – Type of file to save. See FileType for options.
clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:: Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) → pyarts3.arts.propagation_matrix_agendaOperator

Create variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

Operators

__call__(self, frequency_grid: pyarts3.arts.AscendingGrid, frequency_grid_wind_shift_jacobian: pyarts3.arts.Vector3, jacobian_targets: pyarts3.arts.JacobianTargets, select_species: pyarts3.arts.SpeciesEnum, ray_path_point: pyarts3.arts.PropagationPathPoint, atmospheric_point: pyarts3.arts.AtmPoint) → tuple[pyarts3.arts.PropmatVector, pyarts3.arts.StokvecVector, pyarts3.arts.PropmatMatrix, pyarts3.arts.StokvecMatrix]

Execute the method directly in python

Parameters:

frequency_grid (AscendingGrid) – A single frequency grid. See also frequency_grid.
frequency_grid_wind_shift_jacobian (Vector3) – The frequency grid wind shift Jacobian. See also frequency_grid_wind_shift_jacobian.
jacobian_targets (JacobianTargets) – A list of targets for the Jacobian Matrix calculations. See also jacobian_targets.
select_species (SpeciesEnum) – Species selection. See also select_species.
ray_path_point (PropagationPathPoint) – A single path point. See also ray_path_point.
atmospheric_point (AtmPoint) – An atmospheric point in ARTS. See also atmospheric_point.

Returns:

propagation_matrix (PropmatVector) – This contains the fully polarized propagation matrix for the current path point. See also propagation_matrix.
propagation_matrix_source_vector_nonlte (StokvecVector) – The part of the source vector that is due to non-LTE. See also propagation_matrix_source_vector_nonlte.
propagation_matrix_jacobian (PropmatMatrix) – Partial derivative of the propagation_matrix with regards to jacobian_targets. See also propagation_matrix_jacobian.
propagation_matrix_source_vector_nonlte_jacobian (StokvecMatrix) – Partial derivative of the propagation_matrix_source_vector_nonlte with regards to jacobian_targets. See also propagation_matrix_source_vector_nonlte_jacobian.

__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.Vector3, pyarts3.arts.JacobianTargets, pyarts3.arts.SpeciesEnum, pyarts3.arts.PropagationPathPoint, pyarts3.arts.AtmPoint], tuple[pyarts3.arts.PropmatVector, pyarts3.arts.StokvecVector, pyarts3.arts.PropmatMatrix, pyarts3.arts.StokvecMatrix]], /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.propagation_matrix_agendaOperator) → None

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

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

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

__repr__(self) → str

__str__(self) → str