ARTS  2.4.0(git:4fb77825)
LinearModel Class Reference

Linear Forward model. More...

Public Member Functions

 LinearModel (Index m_, Index n_)
 Default Constructor. More...
 
 LinearModel (ConstMatrixView J_, ConstVectorView y0_)
 Construct a linear model from a given Jacobian J and offset vector y0. More...
 
const OEMMatrix & Jacobian (const ConstVectorView &xi)
 See ForwardModel class. More...
 
OEMVector evaluate (const ConstVectorView &xi)
 See ForwardModel class. More...
 

Public Attributes

const Index m
 
const Index n
 

Private Attributes

OEMMatrix J
 
OEMVector y0
 

Detailed Description

Linear Forward model.

Linear forward model class that represents an affine relationship between state vector x and measurement vector y:

y = K * x + y_0

The resulting object stores a copy of the jacobian and the offset vector as Matrix and Vector, respectively.

Definition at line 51 of file test_oem.cc.

Constructor & Destructor Documentation

◆ LinearModel() [1/2]

LinearModel::LinearModel ( Index  m_,
Index  n_ 
)
inline

Default Constructor.

Definition at line 54 of file test_oem.cc.

◆ LinearModel() [2/2]

LinearModel::LinearModel ( ConstMatrixView  J_,
ConstVectorView  y0_ 
)
inline

Construct a linear model from a given Jacobian J and offset vector y0.

Parameters
[in]J_The Jacobian of the forward model.
[in]y0_The constant offset of the forward model.

Definition at line 62 of file test_oem.cc.

Member Function Documentation

◆ evaluate()

OEMVector LinearModel::evaluate ( const ConstVectorView xi)
inline

See ForwardModel class.

Definition at line 69 of file test_oem.cc.

References J, m, mult(), ARTS::Var::y(), and y0.

◆ Jacobian()

const OEMMatrix& LinearModel::Jacobian ( const ConstVectorView xi)
inline

See ForwardModel class.

Definition at line 66 of file test_oem.cc.

References J.

Member Data Documentation

◆ J

OEMMatrix LinearModel::J
private

Definition at line 80 of file test_oem.cc.

Referenced by evaluate(), and Jacobian().

◆ m

const Index LinearModel::m

Definition at line 77 of file test_oem.cc.

Referenced by evaluate().

◆ n

const Index LinearModel::n

Definition at line 77 of file test_oem.cc.

◆ y0

OEMVector LinearModel::y0
private

Definition at line 81 of file test_oem.cc.

Referenced by evaluate().


The documentation for this class was generated from the following file: