ArrayOfScatteringSpecies

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

Represents species of scattering particles in the atmosphere.

Workspace variables of type ArrayOfScatteringSpecies

Overview

Method	`add()`	Add scattering species
Method	`get_bulk_scattering_properties_tro_gridded()`	Get bulk scattering properties
Method	`get_bulk_scattering_properties_tro_spectral()`	Get bulk scattering properties
Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
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.ArrayOfScatteringSpecies) -> 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: collections.abc.Sequence[pyarts3.arts.HenyeyGreensteinScatterer | pyarts3.arts.ScatteringGeneralSpectralTRO | pyarts3.arts.ScatteringHabit], /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.ArrayOfScatteringSpecies) → None

Methods

add(self, arg: pyarts3.arts.HenyeyGreensteinScatterer | pyarts3.arts.ScatteringGeneralSpectralTRO | pyarts3.arts.ScatteringHabit, /) → None: Add scattering species

get_bulk_scattering_properties_tro_gridded(self, atm_point: pyarts3.arts.AtmPoint, f_grid: pyarts3.arts.Vector, za_grid: pyarts3.arts.IrregularZenithAngleGrid | pyarts3.arts.DoubleGaussGrid | pyarts3.arts.GaussLegendreGrid | pyarts3.arts.LobattoGrid | pyarts3.arts.FejerGrid) → pyarts3.arts.BulkScatteringPropertiesTROGridded4: Get bulk scattering properties

get_bulk_scattering_properties_tro_spectral(self, atm_point: pyarts3.arts.AtmPoint, f_grid: pyarts3.arts.Vector, l: int) → pyarts3.arts.ScatteringTroSpectralVector: Get bulk scattering properties

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

Create variable from file.

Operators

__init__(self) → None
__init__(self, arg: collections.abc.Sequence[pyarts3.arts.HenyeyGreensteinScatterer | pyarts3.arts.ScatteringGeneralSpectralTRO | pyarts3.arts.ScatteringHabit], /) → None
__init__(self) → None
__init__(self, arg: pyarts3.arts.ArrayOfScatteringSpecies) → None