ARTS 2.5.9 (git: 825fa5f2)
Jacobian::Target Struct Reference

Holds all information required for individual partial derivatives. More...

#include <jacobian.h>

Public Member Functions

 Target (Atm atype)
 Atmospheric type. More...
 
 Target (Line ltype, const QuantumIdentifier &iqid, Species::Species specid)
 Line type. More...
 
 Target (Sensor stype)
 Sensor type. More...
 
 Target (Special stype, ArrayOfSpeciesTag aostid)
 Special type. More...
 
 Target (Special stype, String sid)
 Special type. More...
 
 Target ()=default
 A defaultable none-type. More...
 
bool operator== (Atm other) const noexcept
 Checks if the type of jacobian is the input atmospheric parameter. More...
 
bool operator== (Line other) const noexcept
 Checks if the type of jacobian is the input line parameter. More...
 
bool operator== (Sensor other) const noexcept
 Checks if the type of jacobian is the input sensor parameter. More...
 
bool operator== (Special other) const noexcept
 Checks if the type of jacobian is the input sensor parameter. More...
 
bool operator== (Type other) const noexcept
 Checks if the type is correct. More...
 
bool sameTargetType (const Target &other) const noexcept
 
std::string_view TargetType () const noexcept
 Return type as string. More...
 
void TargetType (const std::string_view &s) noexcept
 Sets target based on a string. More...
 
void TargetSubType (const std::string_view &s) noexcept
 Sets sub target based on a string. More...
 
std::string_view TargetSubType () const noexcept
 
bool TargetTypeOK () const noexcept
 Are we good? More...
 
bool TargetSubTypeOK () const noexcept
 Are we good? More...
 
bool isSpeciesVMR () const noexcept
 Special species case. More...
 
bool isWind () const noexcept
 Special wind case. More...
 
bool isMagnetic () const noexcept
 Special magnetic field case. More...
 
bool isFrequency () const noexcept
 Special frequency case. More...
 
bool isPointing () const noexcept
 Special pointing case. More...
 
bool needQuantumIdentity () const noexcept
 Does this type need the QuantumIdentifier? More...
 
bool needArrayOfSpeciesTag () const noexcept
 Does this type need the ArrayOfSpeciesTag? More...
 
bool needString () const noexcept
 Does this type need the String? More...
 

Public Attributes

Type type {Type::FINAL}
 ! Type of quantity, never set manually More...
 
Atm atm {Atm::FINAL}
 Type of atm quantity. More...
 
Line line {Line::FINAL}
 Type of line quantity. More...
 
Sensor sensor {Sensor::FINAL}
 Type of sensor quantity. More...
 
Special special {Special::FINAL}
 Type of special quantity. More...
 
Numeric perturbation {std::numeric_limits<Numeric>::quiet_NaN()}
 Perturbations for methods where theoretical computations are impossible or plain slow. More...
 
QuantumIdentifier qid {}
 ID for the Line types of partial derivatives. More...
 
ArrayOfSpeciesTag species_array_id {0}
 ID for some of the Special types of partial derivatives. More...
 
String string_id {}
 ID for some of the Special types of partial derivatives. More...
 
Species::Species species_id {Species::Species::FINAL}
 Species ID for line parameters. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const Target &x)
 

Detailed Description

Holds all information required for individual partial derivatives.

Definition at line 108 of file jacobian.h.

Constructor & Destructor Documentation

◆ Target() [1/6]

Jacobian::Target::Target ( Atm  atype)
inlineexplicit

Atmospheric type.

Definition at line 140 of file jacobian.h.

References ARTS_ASSERT, and good_enum().

◆ Target() [2/6]

Jacobian::Target::Target ( Line  ltype,
const QuantumIdentifier iqid,
Species::Species  specid 
)
inlineexplicit

Line type.

Definition at line 145 of file jacobian.h.

References ARTS_ASSERT, and good_enum().

◆ Target() [3/6]

Jacobian::Target::Target ( Sensor  stype)
inlineexplicit

Sensor type.

Definition at line 153 of file jacobian.h.

References ARTS_ASSERT, and good_enum().

◆ Target() [4/6]

Jacobian::Target::Target ( Special  stype,
ArrayOfSpeciesTag  aostid 
)
inlineexplicit

Special type.

Definition at line 158 of file jacobian.h.

References ARTS_ASSERT.

◆ Target() [5/6]

Jacobian::Target::Target ( Special  stype,
String  sid 
)
inlineexplicit

Special type.

Definition at line 166 of file jacobian.h.

References ARTS_ASSERT.

◆ Target() [6/6]

Jacobian::Target::Target ( )
explicitdefault

A defaultable none-type.

Member Function Documentation

◆ isFrequency()

bool Jacobian::Target::isFrequency ( ) const
inlinenoexcept

Special frequency case.

Definition at line 290 of file jacobian.h.

◆ isMagnetic()

bool Jacobian::Target::isMagnetic ( ) const
inlinenoexcept

Special magnetic field case.

Definition at line 284 of file jacobian.h.

Referenced by RetrievalQuantity::is_mag().

◆ isPointing()

bool Jacobian::Target::isPointing ( ) const
inlinenoexcept

Special pointing case.

Definition at line 296 of file jacobian.h.

◆ isSpeciesVMR()

bool Jacobian::Target::isSpeciesVMR ( ) const
inlinenoexcept

Special species case.

Definition at line 273 of file jacobian.h.

◆ isWind()

bool Jacobian::Target::isWind ( ) const
inlinenoexcept

Special wind case.

Definition at line 278 of file jacobian.h.

Referenced by RetrievalQuantity::is_wind().

◆ needArrayOfSpeciesTag()

bool Jacobian::Target::needArrayOfSpeciesTag ( ) const
inlinenoexcept

Does this type need the ArrayOfSpeciesTag?

Definition at line 307 of file jacobian.h.

Referenced by xml_read_from_stream(), and xml_write_to_stream().

◆ needQuantumIdentity()

bool Jacobian::Target::needQuantumIdentity ( ) const
inlinenoexcept

Does this type need the QuantumIdentifier?

Definition at line 302 of file jacobian.h.

Referenced by xml_read_from_stream(), and xml_write_to_stream().

◆ needString()

bool Jacobian::Target::needString ( ) const
inlinenoexcept

Does this type need the String?

Definition at line 312 of file jacobian.h.

Referenced by xml_read_from_stream(), and xml_write_to_stream().

◆ operator==() [1/5]

bool Jacobian::Target::operator== ( Atm  other) const
inlinenoexcept

Checks if the type of jacobian is the input atmospheric parameter.

Definition at line 178 of file jacobian.h.

◆ operator==() [2/5]

bool Jacobian::Target::operator== ( Line  other) const
inlinenoexcept

Checks if the type of jacobian is the input line parameter.

Definition at line 181 of file jacobian.h.

◆ operator==() [3/5]

bool Jacobian::Target::operator== ( Sensor  other) const
inlinenoexcept

Checks if the type of jacobian is the input sensor parameter.

Definition at line 184 of file jacobian.h.

◆ operator==() [4/5]

bool Jacobian::Target::operator== ( Special  other) const
inlinenoexcept

Checks if the type of jacobian is the input sensor parameter.

Definition at line 187 of file jacobian.h.

◆ operator==() [5/5]

bool Jacobian::Target::operator== ( Type  other) const
inlinenoexcept

Checks if the type is correct.

Definition at line 190 of file jacobian.h.

◆ sameTargetType()

bool Jacobian::Target::sameTargetType ( const Target other) const
inlinenoexcept

Definition at line 192 of file jacobian.h.

Referenced by jacobianAddBasicCatalogParameter().

◆ TargetSubType() [1/2]

std::string_view Jacobian::Target::TargetSubType ( ) const
inlinenoexcept

Definition at line 231 of file jacobian.h.

References toString().

◆ TargetSubType() [2/2]

void Jacobian::Target::TargetSubType ( const std::string_view &  s)
inlinenoexcept

Sets sub target based on a string.

Definition at line 207 of file jacobian.h.

Referenced by xml_read_from_stream(), and xml_write_to_stream().

◆ TargetSubTypeOK()

bool Jacobian::Target::TargetSubTypeOK ( ) const
inlinenoexcept

Are we good?

Definition at line 251 of file jacobian.h.

References good_enum().

Referenced by xml_read_from_stream().

◆ TargetType() [1/2]

std::string_view Jacobian::Target::TargetType ( ) const
inlinenoexcept

Return type as string.

Definition at line 199 of file jacobian.h.

References toString().

Referenced by xml_read_from_stream(), and xml_write_to_stream().

◆ TargetType() [2/2]

void Jacobian::Target::TargetType ( const std::string_view &  s)
inlinenoexcept

Sets target based on a string.

Definition at line 204 of file jacobian.h.

◆ TargetTypeOK()

bool Jacobian::Target::TargetTypeOK ( ) const
inlinenoexcept

Are we good?

Definition at line 248 of file jacobian.h.

References good_enum().

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const Target x 
)
friend

Definition at line 1208 of file jacobian.cc.

Member Data Documentation

◆ atm

Atm Jacobian::Target::atm {Atm::FINAL}

Type of atm quantity.

Definition at line 113 of file jacobian.h.

◆ line

Line Jacobian::Target::line {Line::FINAL}

Type of line quantity.

Definition at line 116 of file jacobian.h.

Referenced by RetrievalQuantity::LineType().

◆ perturbation

◆ qid

QuantumIdentifier Jacobian::Target::qid {}

ID for the Line types of partial derivatives.

Definition at line 128 of file jacobian.h.

Referenced by RetrievalQuantity::QuantumIdentity(), xml_read_from_stream(), and xml_write_to_stream().

◆ sensor

Sensor Jacobian::Target::sensor {Sensor::FINAL}

Type of sensor quantity.

Definition at line 119 of file jacobian.h.

◆ special

Special Jacobian::Target::special {Special::FINAL}

Type of special quantity.

Definition at line 122 of file jacobian.h.

◆ species_array_id

ArrayOfSpeciesTag Jacobian::Target::species_array_id {0}

ID for some of the Special types of partial derivatives.

Definition at line 131 of file jacobian.h.

Referenced by RetrievalQuantity::operator==(), species_match(), xml_read_from_stream(), and xml_write_to_stream().

◆ species_id

Species::Species Jacobian::Target::species_id {Species::Species::FINAL}

Species ID for line parameters.

Definition at line 137 of file jacobian.h.

Referenced by jacobianAddShapeCatalogParameter().

◆ string_id

String Jacobian::Target::string_id {}

ID for some of the Special types of partial derivatives.

Definition at line 134 of file jacobian.h.

Referenced by xml_read_from_stream(), and xml_write_to_stream().

◆ type

Type Jacobian::Target::type {Type::FINAL}

! Type of quantity, never set manually

Definition at line 110 of file jacobian.h.


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