JacobianTargets

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

A list of targets for use in Jacobian Matrix calculations

This type flags the type of calculations that should be performed when computing the Jacobian matrix or partial derivatives.

Workspace variables of type JacobianTargets

jacobian_targets

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Method	`target_count()`	The number of targets added to the Jacobian.
Method	`x_size()`	The size of the model state vector.
Static Method	`fromxml()`	Create variable from file.
`ArrayOfAtmTargets`	`atm`	List of atmospheric targets
`ArrayOfErrorTarget`	`error`	List of error targets
`ArrayOfLineTarget`	`line`	List of line targets
`ArrayOfSensorTarget`	`sensor`	List of sensor targets
`ArrayOfSubsurfaceTarget`	`subsurf`	List of subsurface targets
`ArrayOfSurfaceTarget`	`surf`	List of surface targets
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`	Helper for pickle.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	__init__(self, arg: pyarts3.arts.JacobianTargets) -> 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.JacobianTargets) → 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

target_count(self) → int: The number of targets added to the Jacobian.

x_size(self) → int: The size of the model state vector.

Static Methods

fromxml(file: str) → pyarts3.arts.JacobianTargets

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

atm: ArrayOfAtmTargets: List of atmospheric targets

error: ArrayOfErrorTarget: List of error targets

line: ArrayOfLineTarget: List of line targets

sensor: ArrayOfSensorTarget: List of sensor targets

subsurf: ArrayOfSubsurfaceTarget: List of subsurface targets

surf: ArrayOfSurfaceTarget: List of surface targets

Operators

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

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

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

__getstate__(): Helper for pickle.

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

__hash__(): Return hash(self).

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

__le__(value, /): Return self<=value.

__lt__(value, /): Return self<value.

__ne__(value, /): Return self!=value.

__repr__(self) → str

__str__(self) → str