JacobianSubsurfaceTarget

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

Subsurface target

Overview

Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
Numeric	d	Perturbation magnitude
Callable	inverse_jacobian	Transform a native-unit Jacobian into model-state units.
Callable	inverse_state	Transform model-state values back into native target values.
Index	target_pos	Target position
Callable	transform_state	Transform native target values into the model state.
SubsurfaceKeyVal	type	Type of target
Index	x_size	Size of target in state vector
Index	x_start	Start index of target in state vector
Operator	__eq__()	Return self==value.
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self, arg: pyarts3.arts.JacobianSubsurfaceTarget) -> None
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	__repr__(self) -> str
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

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

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

d: Numeric

Perturbation magnitude

inverse_jacobian: Callable

Transform a native-unit Jacobian into model-state units.

The callable signature is (jacobian, model_state, context) -> jacobian and must apply the derivative of inverse_state with respect to the model state.

inverse_state: Callable

Transform model-state values back into native target values.

The callable signature is (model_state, context) -> native_state. The context is the complete field or data object that owns the target.

target_pos: Index

Target position

transform_state: Callable

Transform native target values into the model state.

The callable signature is (native_state, context) -> model_state. The context is the complete field or data object that owns the target.

type: SubsurfaceKeyVal

Type of target

x_size: Index

Size of target in state vector

x_start: Index

Start index of target in state vector

Operators

__eq__(value, /)

Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /)

Return self>=value.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

__init__(self, arg: pyarts3.arts.JacobianSubsurfaceTarget) → None

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__str__(self) → str