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.

Matrix or Sparse

matrix

The matrix held inside the instance

Operator

__eq__()

Return self==value.

Operator

__format__()

Default object formatter.

Operator

__ge__()

Return self>=value.

Operator

__getstate__()

__getstate__(self) -> tuple[pyarts3.arts.Range, pyarts3.arts.Range, tuple[int, int], pyarts3.arts.Matrix | pyarts3.arts.Sparse]

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

__setstate__()

__setstate__(self, arg: tuple[pyarts3.arts.Range, pyarts3.arts.Range, tuple[int, int], pyarts3.arts.Matrix | pyarts3.arts.Sparse], /) -> None

Operator

__str__()

Return str(self).

Constructors

__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
__init__(self, arg0: pyarts3.arts.Range, arg1: pyarts3.arts.Range, arg2: tuple[int, int], arg3: pyarts3.arts.Sparse, /) None

Overloaded function.

  1. __init__(self) -> None

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

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

By value, dense

  1. __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) pyarts3.arts.Block

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

matrix: Matrix | Sparse

The matrix held inside the instance

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.

__getstate__(self) tuple[pyarts3.arts.Range, pyarts3.arts.Range, tuple[int, int], pyarts3.arts.Matrix | pyarts3.arts.Sparse]
__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__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
__init__(self, arg0: pyarts3.arts.Range, arg1: pyarts3.arts.Range, arg2: tuple[int, int], arg3: pyarts3.arts.Sparse, /) None

Overloaded function.

  1. __init__(self) -> None

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

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

By value, dense

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

By value, sparse

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__()

Return repr(self).

__setstate__(self, arg: tuple[pyarts3.arts.Range, pyarts3.arts.Range, tuple[int, int], pyarts3.arts.Matrix | pyarts3.arts.Sparse], /) None
__str__()

Return str(self).