disort_settings_downwelling_wrapper_agendaOperator
- class pyarts3.arts.disort_settings_downwelling_wrapper_agendaOperator(*args, **kwargs)
This is the operator for free customization of the agenda:
disort_settings_downwelling_wrapper_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_disort_settings_downwelling_wrapper_agenda_operator(frequency_grid, ray_path, atmospheric_field, surface_field, subsurface_field, disort_quadrature_dimension, disort_fourier_mode_dimension, disort_legendre_polynomial_dimension, disort_settings_agenda): ... # custom code that creates or modifies disort_settings ... return disort_settings ws.disort_settings_downwelling_wrapper_agendaSetOperator(f=my_disort_settings_downwelling_wrapper_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
Read variable from file.
Method
Saves variable to file.
Static Method
Create variable from file.
Operator
Execute the method directly in python
Operator
Return self==value.
Operator
__format__(self, arg: str, /) -> str
Operator
Return self>=value.
Operator
Helper for pickle.
Operator
Return self>value.
Operator
Return hash(self).
Operator
__init__(self, arg: pyarts3.arts.disort_settings_downwelling_wrapper_agendaOperator) -> None
Operator
Return self<=value.
Operator
Return self<value.
Operator
Return self!=value.
Operator
__repr__(self) -> str
Operator
__str__(self) -> str
Constructors
- __init__(self, arg: collections.abc.Callable[[pyarts3.arts.AscendingGrid, pyarts3.arts.ArrayOfPropagationPathPoint, pyarts3.arts.AtmField, pyarts3.arts.SurfaceField, pyarts3.arts.SubsurfaceField, int, int, int, pyarts3.arts.Agenda], tuple[pyarts3.arts.DisortSettings]], /) None
- __init__(self) None
- __init__(self, arg: pyarts3.arts.disort_settings_downwelling_wrapper_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:
- 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:
Static Methods
- fromxml(file: str) pyarts3.arts.disort_settings_downwelling_wrapper_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, frequency_grid: pyarts3.arts.AscendingGrid, ray_path: pyarts3.arts.ArrayOfPropagationPathPoint, atmospheric_field: pyarts3.arts.AtmField, surface_field: pyarts3.arts.SurfaceField, subsurface_field: pyarts3.arts.SubsurfaceField, disort_quadrature_dimension: int, disort_fourier_mode_dimension: int, disort_legendre_polynomial_dimension: int, disort_settings_agenda: pyarts3.arts.Agenda) tuple[pyarts3.arts.DisortSettings]
Execute the method directly in python
- Parameters:
frequency_grid (
AscendingGrid
) – A single frequency grid. See alsofrequency_grid
.ray_path (
ArrayOfPropagationPathPoint
) – A list path points making up a propagation path. See alsoray_path
.atmospheric_field (
AtmField
) – An atmospheric field in ARTS. See alsoatmospheric_field
.surface_field (
SurfaceField
) – The surface field. See alsosurface_field
.subsurface_field (
SubsurfaceField
) – The sub-surface field. See alsosubsurface_field
.disort_quadrature_dimension (
Index
) – The quadrature size for Disort. See alsodisort_quadrature_dimension
.disort_fourier_mode_dimension (
Index
) – The number of Fourier modes for Disort. See alsodisort_fourier_mode_dimension
.disort_legendre_polynomial_dimension (
Index
) – The number of input Legendre polynimials for Disort. See alsodisort_legendre_polynomial_dimension
.disort_settings_agenda (
Agenda
) – An agenda for setting up Disort. See alsodisort_settings_agenda
.
- Returns:
disort_settings – Contains the full settings of spectral Disort calculations. See also
disort_settings
.- Return type:
- __eq__(value, /)
Return self==value.
- __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.ArrayOfPropagationPathPoint, pyarts3.arts.AtmField, pyarts3.arts.SurfaceField, pyarts3.arts.SubsurfaceField, int, int, int, pyarts3.arts.Agenda], tuple[pyarts3.arts.DisortSettings]], /) None
- __init__(self) None
- __init__(self, arg: pyarts3.arts.disort_settings_downwelling_wrapper_agendaOperator) None
- __le__(value, /)
Return self<=value.
- __lt__(value, /)
Return self<value.
- __ne__(value, /)
Return self!=value.