SingleScatteringData

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

Holds single scattering data

Overview

Method

readxml()

Read variable from file.

Method

savexml()

Saves variable to file.

Static Method

fromxml()

Create variable from file.

Vector

T_grid

The temperature grid

Vector

aa_grid

The azimuth grid

Tensor5

abs_vec_data

The absorption vector

String

description

The description

Tensor5

ext_mat_data

The extinction matrix

Vector

f_grid

The frequency grid

Tensor7

pha_mat_data

The phase matrix

PType

ptype

The type

Vector

za_grid

The zenith grid

Operator

__eq__()

Return self==value.

Operator

__format__()

__format__(self, arg: str, /) -> str

Operator

__ge__()

Return self>=value.

Operator

__getstate__()

__getstate__(self) -> tuple

Operator

__gt__()

Return self>value.

Operator

__hash__()

Return hash(self).

Operator

__init__()

__init__(self, arg: pyarts3.arts.SingleScatteringData) -> None

Operator

__le__()

Return self<=value.

Operator

__lt__()

Return self<value.

Operator

__ne__()

Return self!=value.

Operator

__repr__()

__repr__(self) -> str

Operator

__setstate__()

__setstate__(self, arg: tuple, /) -> None

Operator

__str__()

__str__(self) -> str

Constructors

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

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

T_grid: Vector

The temperature grid

aa_grid: Vector

The azimuth grid

abs_vec_data: Tensor5

The absorption vector

description: String

The description

ext_mat_data: Tensor5

The extinction matrix

f_grid: Vector

The frequency grid

pha_mat_data: Tensor7

The phase matrix

ptype: PType

The type

za_grid: Vector

The zenith grid

Operators

__eq__(value, /)

Return self==value.

__format__(self, arg: str, /) str
__ge__(value, /)

Return self>=value.

__getstate__(self) tuple
__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) None
__init__(self, arg: pyarts3.arts.SingleScatteringData) None
__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) str
__setstate__(self, arg: tuple, /) None
__str__(self) str