ScatteringSpeciesProperty
- class pyarts3.arts.ScatteringSpeciesProperty(*args, **kwargs)
Meta data for scattering spefcies.
This is used to identify atmospheric data that are required for scattering calculations.
It is a combination of free-form strings and a
ParticulateProperty
- you need to see the specific scattering models/methods for what type of data is required.Overview
Method
Read variable from file.
Method
Saves variable to file.
Static Method
Create variable from file.
Particulate property
Species name
Operator
__eq__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) -> bool
Operator
__format__(self, arg: str, /) -> str
Operator
__ge__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) -> bool
Operator
Helper for pickle.
Operator
__gt__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) -> bool
Operator
Return hash(self).
Operator
Overloaded function.
Operator
__le__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) -> bool
Operator
__lt__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) -> bool
Operator
__ne__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) -> bool
Operator
__repr__(self) -> str
Operator
__str__(self) -> str
Constructors
- __init__(self) None
- __init__(self, arg: pyarts3.arts.ScatteringSpeciesProperty) None
- __init__(self, arg0: str, arg1: pyarts3.arts.ParticulateProperty, /) None
- __init__(self, arg: str, /) None
Overloaded function.
__init__(self) -> None
__init__(self, arg: pyarts3.arts.ScatteringSpeciesProperty) -> None
__init__(self, arg0: str, arg1: pyarts3.arts.ParticulateProperty, /) -> None
Constructor
__init__(self, arg: str, /) -> 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.ScatteringSpeciesProperty
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
- pproperty: ParticulateProperty
Particulate property
Operators
- __eq__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) bool
- __ge__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) bool
- __getstate__()
Helper for pickle.
- __gt__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) bool
- __hash__()
Return hash(self).
- __init__(self) None
- __init__(self, arg: pyarts3.arts.ScatteringSpeciesProperty) None
- __init__(self, arg0: str, arg1: pyarts3.arts.ParticulateProperty, /) None
- __init__(self, arg: str, /) None
Overloaded function.
__init__(self) -> None
__init__(self, arg: pyarts3.arts.ScatteringSpeciesProperty) -> None
__init__(self, arg0: str, arg1: pyarts3.arts.ParticulateProperty, /) -> None
Constructor
__init__(self, arg: str, /) -> None
- __le__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) bool
- __lt__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) bool
- __ne__(self, arg: pyarts3.arts.ScatteringSpeciesProperty, /) bool