DisortSettings

class pyarts3.arts.DisortSettings(*args, **kwargs)

The settings required to run Disort.

1. Index Quadrature dimension

2. Index Legendre order

3. Index Fourier order

4. Index The frequency grid

5. Index The level altitude grid

6. Vector Solar azimuth angles

7. Vector Solar zenith angles

8. Vector Solar source

9. MatrixOfDisortBDRF Bi-directional reflectance distribution functions

10. Matrix Optical thicknesses

11. Matrix Single scattering albedos

12. Matrix Fractional scattering

13. Tensor3 Source function polynomial

14. Tensor3 Legendre polynomial coefficients

15. Tensor3 Positive boundary condition

16. Tensor3 Negative boundary condition

Workspace variables of type DisortSettings

disort_settings

Overview

Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
DescendingGrid	altitude_grid
MatrixOfDisortBDRF	bidirectional_reflectance_distribution_functions
Index	fourier_mode_dimension
Matrix	fractional_scattering
AscendingGrid	frequency_grid
Tensor3	legendre_coefficients
Index	legendre_polynomial_dimension
Tensor3	negative_boundary_condition
Matrix	optical_thicknesses
Tensor3	positive_boundary_condition
Index	quadrature_dimension
Matrix	single_scattering_albedo
Vector	solar_azimuth_angle
Vector	solar_source
Vector	solar_zenith_angle
Tensor3	source_polynomial
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.DisortSettings) -> 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) → None

__init__(self, arg: pyarts3.arts.DisortSettings) → 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.DisortSettings

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

altitude_grid: DescendingGrid

bidirectional_reflectance_distribution_functions: MatrixOfDisortBDRF

fourier_mode_dimension: Index

fractional_scattering: Matrix

frequency_grid: AscendingGrid

legendre_coefficients: Tensor3

legendre_polynomial_dimension: Index

negative_boundary_condition: Tensor3

optical_thicknesses: Matrix

positive_boundary_condition: Tensor3

quadrature_dimension: Index

single_scattering_albedo: Matrix

solar_azimuth_angle: Vector

solar_source: Vector

solar_zenith_angle: Vector

source_polynomial: Tensor3

Operators

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

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

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__str__(self) → str