ARTS 2.5.10 (git: 2f1c442c)
|
Deals with internal derivatives, Jacobian definition, and OEM calculations. More...
#include <jacobian.h>
Public Member Functions | |
RetrievalQuantity () | |
Default constructor. | |
RetrievalQuantity (Jacobian::Target target, String subtag, String subsubtag, String mode, const Numeric &perturbation, ArrayOfVector grids) | |
Constructor that sets the values. | |
const String & | Subtag () const |
Returns the sub-tag. | |
void | Subtag (const String &st) |
Sets the sub-tag. | |
const String & | SubSubtag () const |
Returns the sub-sub-tag. | |
void | SubSubtag (const String &sst) |
Sets the sub-sub-tag. | |
const String & | Mode () const |
Returns the mode. | |
void | Mode (const String &m) |
Sets the mode. | |
const ArrayOfVector & | Grids () const |
Returns the grids of the retrieval. | |
void | Grids (const ArrayOfVector &g) |
Sets the grids of the retrieval. | |
Index | nelem () const |
Number of elements in the grids. | |
Jacobian::Target & | Target () |
Get the Jacobian Target. | |
const Jacobian::Target & | Target () const |
Get the Jacobian Target. | |
void | Target (const Jacobian::Target &jac) |
Set the Jacobian Target. | |
const QuantumIdentifier & | QuantumIdentity () const |
Returns the identity of this Jacobian. | |
Jacobian::Line | LineType () const noexcept |
Return line type. | |
bool | operator== (Jacobian::Atm other) const noexcept |
Return atm type equality. | |
bool | operator== (Jacobian::Line other) const noexcept |
Return line type equality. | |
bool | operator== (Jacobian::Sensor other) const noexcept |
Return sensor type equality. | |
bool | operator== (Jacobian::Special other) const noexcept |
Return special type equality. | |
bool | operator== (Jacobian::Type other) const noexcept |
Return special type equality. | |
bool | operator== (const ArrayOfSpeciesTag &st) const noexcept |
Return special type equality. | |
void | QuantumIdentity (const QuantumIdentifier &qi) |
Sets the identity of this Jacobian. | |
bool | propmattype () const noexcept |
Returns if this is a propagation matrix type. | |
bool | is_wind () const noexcept |
bool | is_mag () const noexcept |
void | SetTransformationFunc (const String &s) |
Transformation. | |
void | SetTFuncParameters (const Vector &p) |
void | SetTransformationMatrix (const Matrix &A) |
void | SetOffsetVector (const Vector &b) |
bool | HasAffine () const |
const String & | TransformationFunc () const |
const Vector & | TFuncParameters () const |
const Matrix & | TransformationMatrix () const |
const Vector & | OffsetVector () const |
bool | HasSameInternalsAs (const RetrievalQuantity &a) const |
Checks that all the internal variables of *this match with those of the input. | |
String & | SubTag () |
String & | SubSubTag () |
String & | Mode () |
ArrayOfVector & | Grids () |
String & | TransformationFunc () |
Vector & | TFuncParameters () |
Matrix & | Transformation () |
Vector & | Offset () |
const String & | SubTag () const |
const String & | SubSubTag () const |
const Matrix & | Transformation () const |
const Vector & | Offset () const |
Friends | |
ostream & | operator<< (ostream &os, const RetrievalQuantity &ot) |
Deals with internal derivatives, Jacobian definition, and OEM calculations.
Definition at line 325 of file jacobian.h.
|
inline |
|
inline |
Constructor that sets the values.
[in] | subtag | The sub-derivative |
[in] | subsubtag | The sub-sub-derivative |
[in] | mode | The mode of the derivative |
[in] | analytical | Boolean analytical tag |
[in] | perturbation | The size of the perturbation required |
[in] | grids | The retrieval grid |
Definition at line 345 of file jacobian.h.
References mjac, and Jacobian::Target::perturbation.
|
inline |
Definition at line 517 of file jacobian.h.
References mgrids.
|
inline |
Returns the grids of the retrieval.
Grids. Definition grids for the jacobian, eg. p, lat and lon.
Definition at line 408 of file jacobian.h.
References mgrids.
Referenced by calcBaselineFit(), check_and_add_block(), create_covariance_matrix_1D(), create_sparse_covariance_matrix_1D(), diy_from_path_to_rgrids(), diy_from_pos_to_rgrids(), get_gp_atmgrids_to_rq(), get_gp_atmsurf_to_rq(), jacobianAddAbsSpecies(), jacobianAddBasicCatalogParameter(), jacobianAddFreqShift(), jacobianAddFreqStretch(), jacobianAddMagField(), jacobianAddNLTE(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddScatSpecies(), jacobianAddShapeCatalogParameter(), jacobianAddSinefit(), jacobianAddSpecialSpecies(), jacobianAddSurfaceQuantity(), jacobianAddTemperature(), jacobianAddWind(), jacobianCalcFreqShift(), jacobianCalcFreqStretch(), jacobianCalcPointingZaInterp(), jacobianCalcPointingZaRecalc(), and xml_write_to_stream().
|
inline |
Sets the grids of the retrieval.
[in] | g | The grids of the retrieval |
Definition at line 414 of file jacobian.h.
References mgrids.
|
inline |
Definition at line 496 of file jacobian.h.
References ConstMatrixView::empty(), and transformation_matrix.
Referenced by jac_ranges_indices(), transform_jacobian(), transform_x(), and transform_x_back().
|
inline |
Checks that all the internal variables of *this match with those of the input.
[in] | a | Another retrieval quantity object |
Definition at line 508 of file jacobian.h.
References a, mjac, mmode, msubsubtag, and msubtag.
|
inlinenoexcept |
Definition at line 485 of file jacobian.h.
References Jacobian::Target::isMagnetic(), and mjac.
|
inlinenoexcept |
Definition at line 483 of file jacobian.h.
References Jacobian::Target::isWind(), and mjac.
|
inlinenoexcept |
Return line type.
Definition at line 450 of file jacobian.h.
References Jacobian::Target::line, and mjac.
|
inline |
Definition at line 516 of file jacobian.h.
References mmode.
|
inline |
Returns the mode.
Calculation mode. Eg. "abs", "rel", "vmr", "nd", "From propagation matrix". Note that the latter of these only supports "vmr" for abs species.
Definition at line 394 of file jacobian.h.
References mmode.
Referenced by jacobianAddAbsSpecies(), jacobianAddFreqShift(), jacobianAddFreqStretch(), jacobianAddPolyfit(), jacobianAddShapeCatalogParameter(), jacobianAddSinefit(), and xml_write_to_stream().
|
inline |
|
inline |
Number of elements in the grids.
The multiplicative accumulation of grid elements
Definition at line 422 of file jacobian.h.
References mgrids, and Array< base >::nelem().
Referenced by jac_ranges_indices().
|
inline |
Definition at line 521 of file jacobian.h.
References offset_vector.
|
inline |
Definition at line 526 of file jacobian.h.
References offset_vector.
|
inline |
Definition at line 500 of file jacobian.h.
References offset_vector.
Referenced by transform_x(), and transform_x_back().
|
inlinenoexcept |
Return special type equality.
Definition at line 468 of file jacobian.h.
References mjac, and Jacobian::Target::species_array_id.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Returns if this is a propagation matrix type.
Definition at line 477 of file jacobian.h.
References mjac.
|
inline |
Returns the identity of this Jacobian.
QuantumIdentifier as necessary for matching line specific parameters to Jacobian grid
Definition at line 445 of file jacobian.h.
References mjac, and Jacobian::Target::qid.
Referenced by species_iso_match(), and species_match().
|
inline |
Sets the identity of this Jacobian.
[in] | qi | The identity of this Jacobian |
Definition at line 474 of file jacobian.h.
References mjac, and Jacobian::Target::qid.
|
inline |
Definition at line 495 of file jacobian.h.
References b, and offset_vector.
|
inline |
Definition at line 493 of file jacobian.h.
References tfunc_parameters.
|
inline |
Transformation.
FIXMEDOC@Simon The transformations are yours to fix and document FIXMEDOC@Patrick The transformations are yours to fix and document
Definition at line 492 of file jacobian.h.
References transformation_func.
|
inline |
Definition at line 494 of file jacobian.h.
References transformation_matrix.
|
inline |
Definition at line 515 of file jacobian.h.
References msubsubtag.
|
inline |
Returns the sub-sub-tag.
SubSubtag. Eg. for scat species fields: mass_density, mass_flux, ...
Definition at line 379 of file jacobian.h.
References msubsubtag.
Referenced by jacobianAddScatSpecies(), and xml_write_to_stream().
|
inline |
Definition at line 524 of file jacobian.h.
References msubsubtag.
|
inline |
Sets the sub-sub-tag.
[in] | sst | A sub-sub-tag |
Definition at line 385 of file jacobian.h.
References msubsubtag.
|
inline |
Definition at line 514 of file jacobian.h.
References msubtag.
|
inline |
Returns the sub-tag.
Subtag. Eg. for gas species: O3, ClO
Definition at line 365 of file jacobian.h.
References msubtag.
Referenced by jacobianAddAbsSpecies(), jacobianAddPolyfit(), jacobianAddScatSpecies(), jacobianAddSinefit(), jacobianAddSurfaceQuantity(), jacobianAddTemperature(), jacobianAddWind(), and xml_write_to_stream().
|
inline |
Definition at line 523 of file jacobian.h.
References msubtag.
|
inline |
Sets the sub-tag.
[in] | st | A sub-tag |
Definition at line 371 of file jacobian.h.
References msubtag.
|
inline |
Get the Jacobian Target.
Definition at line 431 of file jacobian.h.
References mjac.
Referenced by jacobianAddAbsSpecies(), jacobianAddBasicCatalogParameter(), jacobianAddFreqShift(), jacobianAddFreqStretch(), jacobianAddMagField(), jacobianAddNLTE(), jacobianAddPointingZa(), jacobianAddPolyfit(), jacobianAddScatSpecies(), jacobianAddShapeCatalogParameter(), jacobianAddSinefit(), jacobianAddSpecialSpecies(), jacobianAddSurfaceQuantity(), jacobianAddTemperature(), jacobianAddWind(), jacobianCalcFreqShift(), jacobianCalcFreqStretch(), jacobianCalcPointingZaInterp(), jacobianCalcPointingZaRecalc(), main(), species_match(), and xml_write_to_stream().
|
inline |
|
inline |
|
inline |
Definition at line 519 of file jacobian.h.
References tfunc_parameters.
|
inline |
Definition at line 498 of file jacobian.h.
References tfunc_parameters.
Referenced by transform_jacobian(), transform_x(), and transform_x_back().
|
inline |
Definition at line 520 of file jacobian.h.
References transformation_matrix.
|
inline |
Definition at line 525 of file jacobian.h.
References transformation_matrix.
|
inline |
Definition at line 518 of file jacobian.h.
References transformation_func.
|
inline |
Definition at line 497 of file jacobian.h.
References transformation_func.
Referenced by transform_jacobian(), transform_x(), and transform_x_back().
|
inline |
Definition at line 499 of file jacobian.h.
References transformation_matrix.
Referenced by jac_ranges_indices(), transform_jacobian(), transform_x(), and transform_x_back().
|
friend |
Definition at line 40 of file jacobian.cc.
|
private |
Definition at line 534 of file jacobian.h.
|
private |
Definition at line 535 of file jacobian.h.
Referenced by HasSameInternalsAs(), is_mag(), is_wind(), LineType(), operator==(), propmattype(), QuantumIdentity(), RetrievalQuantity(), and Target().
|
private |
Definition at line 533 of file jacobian.h.
Referenced by HasSameInternalsAs(), and Mode().
|
private |
Definition at line 532 of file jacobian.h.
Referenced by HasSameInternalsAs(), SubSubTag(), and SubSubtag().
|
private |
Definition at line 531 of file jacobian.h.
Referenced by HasSameInternalsAs(), SubTag(), and Subtag().
|
private |
Definition at line 541 of file jacobian.h.
Referenced by Offset(), OffsetVector(), and SetOffsetVector().
|
private |
Definition at line 538 of file jacobian.h.
Referenced by SetTFuncParameters(), and TFuncParameters().
|
private |
Definition at line 537 of file jacobian.h.
Referenced by SetTransformationFunc(), and TransformationFunc().
|
private |
Definition at line 540 of file jacobian.h.
Referenced by HasAffine(), SetTransformationMatrix(), Transformation(), and TransformationMatrix().