Block

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

A single block matrix

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`Range`	`column_range`	The element column range of this block.
`tuple`[`int`, `int`]	`indices`	The row and column block indices.
`Matrix` or `Sparse`	`matrix`	The matrix held inside the instance
`Range`	`row_range`	The element row range of this block.
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	Default object formatter.
Operator	`__ge__()`	Return self>=value.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	Return repr(self).
Operator	`__str__()`	Return str(self).

Constructors

__init__(self) → None

__init__(self, arg: Block) → None

__init__(self, arg0: Range, arg1: Range, arg2: tuple[int, int], arg3: Matrix, /) → None

__init__(self, arg0: Range, arg1: Range, arg2: tuple[int, int], arg3: Sparse, /) → None

Overloaded function.

__init__(self) -> None
__init__(self, arg: pyarts3.arts.Block) -> None
__init__(self, arg0: pyarts3.arts.Range, arg1: pyarts3.arts.Range, arg2: tuple[int, int], arg3: pyarts3.arts.Matrix, /) -> None

By value, dense

__init__(self, arg0: pyarts3.arts.Range, arg1: pyarts3.arts.Range, arg2: tuple[int, int], arg3: pyarts3.arts.Sparse, /) -> None

By value, sparse

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) → Block

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.

Attributes

column_range: Range: The element column range of this block.

indices: tuple[int, int]: The row and column block indices.

matrix: Matrix | Sparse: The matrix held inside the instance

row_range: Range: The element row range of this block.

Operators

__eq__(value, /): Return self==value.

__format__(format_spec, /)

Default object formatter.

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

__ge__(value, /): Return self>=value.

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

__init__(self) → None