ParticulateProperty

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

Numerical properties used to numerically represent particle populations.

Valid options:

"MassDensity" or "m": Mass density in kg/m^{-3}
"NumberDensity" or "n": Number density in m^{-3}
"DMax" or "dmax": Maximum particle diameter in m.
"DVeq" or "dveq": Volume-equivalent diameter in m.
"Extinction" or "ext": Extinction in m^{-1}
"SingleScatteringAlbedo" or "ssa": Single scattering albedo
"ShapeParameter" or "ShapeParameter": PSD shape parmeter in arbitary units.
"IntercepParameter" or "InterceptParameter": PSD intercept parameter in arbitary units.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
Static Method	`get_options()`	Get a list of all options
Static Method	`get_options_as_strings()`	Get a list of all options as strings
Static Data	`pyarts3.arts.ParticulateProperty.DMax`	“DMax” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.DVeq`	“DVeq” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.Extinction`	“Extinction” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.IntercepParameter`	“IntercepParameter” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.InterceptParameter`	“IntercepParameter” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.MassDensity`	“MassDensity” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.NumberDensity`	“NumberDensity” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.ShapeParameter`	“ShapeParameter” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.SingleScatteringAlbedo`	“SingleScatteringAlbedo” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.dmax`	“DMax” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.dveq`	“DVeq” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.ext`	“Extinction” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.m`	“MassDensity” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.n`	“NumberDensity” (`ParticulateProperty`)
Static Data	`pyarts3.arts.ParticulateProperty.ssa`	“SingleScatteringAlbedo” (`ParticulateProperty`)
Operator	`__eq__()`	self == other
Operator	`__format__()`	Default object formatter.
Operator	`__ge__()`	self >= other
Operator	`__getstate__()`	__getstate__(self) -> tuple[str]
Operator	`__gt__()`	self > other
Operator	`__hash__()`	Allows hashing
Operator	`__init__()`	__init__(self, arg: str, /) -> None
Operator	`__le__()`	self <= other
Operator	`__lt__()`	self < other
Operator	`__ne__()`	self != other
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setstate__()`	__setstate__(self, arg: tuple[str], /) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None
__init__(self, arg: pyarts3.arts.ParticulateProperty) → None
__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:: 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.ParticulateProperty

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

get_options() → list[pyarts3.arts.ParticulateProperty]: Get a list of all options

get_options_as_strings() → list[str]: Get a list of all options as strings

Operators

__eq__(self, arg: pyarts3.arts.ParticulateProperty, /) → bool: self == other

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(self, arg: pyarts3.arts.ParticulateProperty, /) → bool: self >= other

__getstate__(self) → tuple[str]

__gt__(self, arg: pyarts3.arts.ParticulateProperty, /) → bool: self > other

__hash__(self) → int: Allows hashing

__init__(self) → None
__init__(self, arg: pyarts3.arts.ParticulateProperty) → None
__init__(self, arg: str, /) → None

__le__(self, arg: pyarts3.arts.ParticulateProperty, /) → bool: self <= other

__lt__(self, arg: pyarts3.arts.ParticulateProperty, /) → bool: self < other

__ne__(self, arg: pyarts3.arts.ParticulateProperty, /) → bool: self != other

__repr__(self) → str

__setstate__(self, arg: tuple[str], /) → None

__str__(self) → str