ARTS 2.5.0 (git: 9ee3ac6c)
RadiationVector Class Reference

Radiation Vector for Stokes dimension 1-4. More...

#include <transmissionmatrix.h>

Public Member Functions

 RadiationVector (Index nf=0, Index stokes=1)
 Construct a new Radiation Vector object. More...
 
 RadiationVector (RadiationVector &&rv) noexcept
 Construct a new Radiation Vector object. More...
 
 RadiationVector (const RadiationVector &rv)=default
 Construct a new Radiation Vector object. More...
 
RadiationVectoroperator= (const RadiationVector &rv)=default
 Assign old radiation vector to this. More...
 
RadiationVectoroperator= (RadiationVector &&rv) noexcept
 Assign old radiation vector to this. More...
 
void leftMul (const TransmissionMatrix &T)
 Multiply radiation vector from the left. More...
 
void SetZero (size_t i)
 Set Radiation Vector to Zero at position. More...
 
const Eigen::Vector4d & Vec4 (size_t i) const
 Return Vector at position. More...
 
const Eigen::Vector3d & Vec3 (size_t i) const
 Return Vector at position. More...
 
const Eigen::Vector2d & Vec2 (size_t i) const
 Return Vector at position. More...
 
const Eigen::Matrix< double, 1, 1 > & Vec1 (size_t i) const
 Return Vector at position. More...
 
Eigen::VectorXd Vec (size_t i) const
 Return Vector at position by copy. More...
 
Eigen::Vector4d & Vec4 (size_t i)
 Return Vector at position. More...
 
Eigen::Vector3d & Vec3 (size_t i)
 Return Vector at position. More...
 
Eigen::Vector2d & Vec2 (size_t i)
 Return Vector at position. More...
 
Eigen::Matrix< double, 1, 1 > & Vec1 (size_t i)
 Return Vector at position. More...
 
void rem_avg (const RadiationVector &O1, const RadiationVector &O2)
 Remove the average of two other RadiationVector from *this. More...
 
void add_avg (const RadiationVector &O1, const RadiationVector &O2)
 Add the average of two other RadiationVector to *this. More...
 
void add_weighted (const TransmissionMatrix &T, const RadiationVector &far, const RadiationVector &close, const ConstMatrixView &Kfar, const ConstMatrixView &Kclose, const Numeric r)
 Add the weighted source of two RadiationVector to *this. More...
 
void addDerivEmission (const TransmissionMatrix &PiT, const TransmissionMatrix &dT, const TransmissionMatrix &T, const RadiationVector &ImJ, const RadiationVector &dJ)
 Add the emission derivative to this. More...
 
void addWeightedDerivEmission (const TransmissionMatrix &PiT, const TransmissionMatrix &dT, const TransmissionMatrix &T, const RadiationVector &I, const RadiationVector &far, const RadiationVector &close, const RadiationVector &d, bool isfar)
 Add the emission derivative to this. More...
 
void addDerivTransmission (const TransmissionMatrix &PiT, const TransmissionMatrix &dT, const RadiationVector &I)
 Add the transmission derivative to this. More...
 
void addMultiplied (const TransmissionMatrix &A, const RadiationVector &x)
 Add multiply. More...
 
void setDerivReflection (const RadiationVector &I, const TransmissionMatrix &PiT, const TransmissionMatrix &Z, const TransmissionMatrix &dZ)
 Sets *this to the reflection derivative. More...
 
void setBackscatterTransmission (const RadiationVector &I0, const TransmissionMatrix &Tr, const TransmissionMatrix &Tf, const TransmissionMatrix &Z)
 Set this to backscatter transmission. More...
 
void setBackscatterTransmissionDerivative (const RadiationVector &I0, const TransmissionMatrix &Tr, const TransmissionMatrix &Tf, const TransmissionMatrix &dZ)
 Set this to backscatter transmission scatter derivative. More...
 
RadiationVectoroperator= (const ConstMatrixView &M)
 Set *this from matrix. More...
 
const Numericoperator() (const Index i, const Index j) const
 Access operator. More...
 
 operator Matrix () const
 Convert *this to Matrix class. More...
 
void setSource (const StokesVector &a, const ConstVectorView &B, const StokesVector &S, Index i)
 Set this to source vector at position. More...
 
Index StokesDim () const
 Get Stokes dimension. More...
 
Index Frequencies () const
 Get frequency count. More...
 

Private Attributes

Index stokes_dim
 
std::vector< Eigen::Vector4d, Eigen::aligned_allocator< Eigen::Vector4d > > R4
 
std::vector< Eigen::Vector3d, Eigen::aligned_allocator< Eigen::Vector3d > > R3
 
std::vector< Eigen::Vector2d, Eigen::aligned_allocator< Eigen::Vector2d > > R2
 
std::vector< Eigen::Matrix< double, 1, 1 >, Eigen::aligned_allocator< Eigen::Matrix< double, 1, 1 > > > R1
 

Friends

std::ostream & operator<< (std::ostream &os, const RadiationVector &rv)
 Output operator. More...
 
std::istream & operator>> (std::istream &data, RadiationVector &rv)
 Input operator. More...
 

Detailed Description

Radiation Vector for Stokes dimension 1-4.

Definition at line 473 of file transmissionmatrix.h.

Constructor & Destructor Documentation

◆ RadiationVector() [1/3]

RadiationVector::RadiationVector ( Index  nf = 0,
Index  stokes = 1 
)
inline

Construct a new Radiation Vector object.

Parameters
[in]nfNumber of frequencies
[in]stokesStokes dimension

Definition at line 490 of file transmissionmatrix.h.

References ARTS_ASSERT.

◆ RadiationVector() [2/3]

RadiationVector::RadiationVector ( RadiationVector &&  rv)
inlinenoexcept

Construct a new Radiation Vector object.

Parameters
[in]rvOld Radiation Vector to move from

Definition at line 503 of file transmissionmatrix.h.

◆ RadiationVector() [3/3]

RadiationVector::RadiationVector ( const RadiationVector rv)
default

Construct a new Radiation Vector object.

Parameters
[in]rvOld Vector to copy from

Member Function Documentation

◆ add_avg()

void RadiationVector::add_avg ( const RadiationVector O1,
const RadiationVector O2 
)
inline

Add the average of two other RadiationVector to *this.

Parameters
[in]O1Input 1
[in]O2Input 2

Definition at line 666 of file transmissionmatrix.h.

References R1, R2, R3, and R4.

Referenced by update_radiation_vector().

◆ add_weighted()

void RadiationVector::add_weighted ( const TransmissionMatrix T,
const RadiationVector far,
const RadiationVector close,
const ConstMatrixView Kfar,
const ConstMatrixView Kclose,
const Numeric  r 
)
inline

Add the weighted source of two RadiationVector to *this.

Parameters
[in]TThe transmission matrix
[in]farInput 1
[in]closeInput 2

Definition at line 683 of file transmissionmatrix.h.

References joker, R1, R2, R3, R4, TransmissionMatrix::second_order_integration_source(), and TransmissionMatrix::TraMat().

Referenced by update_radiation_vector().

◆ addDerivEmission()

void RadiationVector::addDerivEmission ( const TransmissionMatrix PiT,
const TransmissionMatrix dT,
const TransmissionMatrix T,
const RadiationVector ImJ,
const RadiationVector dJ 
)
inline

Add the emission derivative to this.

Parameters
[in]PiTAccumulated transmission to space
[in]dTDerivative of transmission matrix
[in]TTransmission matrix
[in]ImJIntensity minus the emission vector
[in]dJDerivative of the emission vector

Definition at line 707 of file transmissionmatrix.h.

References TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, and R4.

◆ addDerivTransmission()

void RadiationVector::addDerivTransmission ( const TransmissionMatrix PiT,
const TransmissionMatrix dT,
const RadiationVector I 
)
inline

Add the transmission derivative to this.

Parameters
[in]PiTAccumulated transmission to space
[in]dTDerivative of transmission matrix
[in]IIntensity vector

Definition at line 759 of file transmissionmatrix.h.

References TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, and R4.

◆ addMultiplied()

void RadiationVector::addMultiplied ( const TransmissionMatrix A,
const RadiationVector x 
)
inline

Add multiply.

Performs essentially this += A * x

Assumes this and x are not aliases

Parameters
[in]ADerivative of transmission matrix
[in]xIntensity vector

Definition at line 782 of file transmissionmatrix.h.

References TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, and R4.

◆ addWeightedDerivEmission()

void RadiationVector::addWeightedDerivEmission ( const TransmissionMatrix PiT,
const TransmissionMatrix dT,
const TransmissionMatrix T,
const RadiationVector I,
const RadiationVector far,
const RadiationVector close,
const RadiationVector d,
bool  isfar 
)
inline

Add the emission derivative to this.

Parameters
[in]PiTAccumulated transmission to space
[in]dTDerivative of transmission matrix
[in]TTransmission matrix
[in]ImJIntensity minus the emission vector
[in]dJDerivative of the emission vector

Definition at line 734 of file transmissionmatrix.h.

References d, TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, R4, and TransmissionMatrix::second_order_integration_dsource().

◆ Frequencies()

Index RadiationVector::Frequencies ( ) const
inline

Get frequency count.

Definition at line 976 of file transmissionmatrix.h.

References R1, R2, R3, R4, and stokes_dim.

Referenced by operator Matrix(), operator=(), and xml_write_to_stream().

◆ leftMul()

void RadiationVector::leftMul ( const TransmissionMatrix T)
inline

Multiply radiation vector from the left.

Parameters
[in]TTranmission Vector

Definition at line 541 of file transmissionmatrix.h.

References TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, and R4.

Referenced by update_radiation_vector().

◆ operator Matrix()

RadiationVector::operator Matrix ( ) const
inline

Convert *this to Matrix class.

Returns
Matrix

Definition at line 909 of file transmissionmatrix.h.

References Frequencies(), M, R1, R2, R3, R4, and stokes_dim.

◆ operator()()

const Numeric & RadiationVector::operator() ( const Index  i,
const Index  j 
) const
inline

Access operator.

Parameters
[in]iPosition in outer vector
[in]jPosition in inner vector
Returns
const Numeric&

Definition at line 892 of file transmissionmatrix.h.

References R1, R2, R3, R4, and stokes_dim.

◆ operator=() [1/3]

RadiationVector & RadiationVector::operator= ( const ConstMatrixView M)
inline

Set *this from matrix.

Parameters
[in]MMatrix
Returns
RadiationVector& *this

Definition at line 863 of file transmissionmatrix.h.

References ARTS_ASSERT, Frequencies(), M, R1, R2, R3, R4, and stokes_dim.

◆ operator=() [2/3]

RadiationVector & RadiationVector::operator= ( const RadiationVector rv)
default

Assign old radiation vector to this.

Parameters
[in]rvold vetor to copy
Returns
RadiationVector& *this

◆ operator=() [3/3]

RadiationVector & RadiationVector::operator= ( RadiationVector &&  rv)
inlinenoexcept

Assign old radiation vector to this.

Parameters
[in]rvold vetor to move from
Returns
RadiationVector& *this

Definition at line 528 of file transmissionmatrix.h.

References R1, R2, R3, R4, and stokes_dim.

◆ rem_avg()

void RadiationVector::rem_avg ( const RadiationVector O1,
const RadiationVector O2 
)
inline

Remove the average of two other RadiationVector from *this.

Parameters
[in]O1Input 1
[in]O2Input 2

Definition at line 649 of file transmissionmatrix.h.

References R1, R2, R3, and R4.

Referenced by update_radiation_vector().

◆ setBackscatterTransmission()

void RadiationVector::setBackscatterTransmission ( const RadiationVector I0,
const TransmissionMatrix Tr,
const TransmissionMatrix Tf,
const TransmissionMatrix Z 
)
inline

Set this to backscatter transmission.

Parameters
[in]I0Incoming intensity vector
[in]TrReflection transmission
[in]TfForward transmission
[in]ZReflection matrix

Definition at line 823 of file transmissionmatrix.h.

References TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, and R4.

◆ setBackscatterTransmissionDerivative()

void RadiationVector::setBackscatterTransmissionDerivative ( const RadiationVector I0,
const TransmissionMatrix Tr,
const TransmissionMatrix Tf,
const TransmissionMatrix dZ 
)
inline

Set this to backscatter transmission scatter derivative.

Parameters
[in]I0Incoming intensity vector
[in]TrReflection transmission
[in]TfForward transmission
[in]dZReflection matrix derivative

Definition at line 844 of file transmissionmatrix.h.

References TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, and R4.

◆ setDerivReflection()

void RadiationVector::setDerivReflection ( const RadiationVector I,
const TransmissionMatrix PiT,
const TransmissionMatrix Z,
const TransmissionMatrix dZ 
)
inline

Sets *this to the reflection derivative.

Parameters
[in]IIntensity vector
[in]PiTAccumulated transmission to space
[in]ZReflection matrix
[in]dZDerivative of reflection matrix

Definition at line 801 of file transmissionmatrix.h.

References TransmissionMatrix::Mat1(), TransmissionMatrix::Mat2(), TransmissionMatrix::Mat3(), TransmissionMatrix::Mat4(), R1, R2, R3, and R4.

◆ setSource()

void RadiationVector::setSource ( const StokesVector a,
const ConstVectorView B,
const StokesVector S,
Index  i 
)
inline

Set this to source vector at position.

Parameters
[in]aAbsorption vector
[in]BPlanck vector
[in]SScattering source vector
[in]iPosition

Definition at line 928 of file transmissionmatrix.h.

References a, ARTS_ASSERT, PropagationMatrix::IsEmpty(), PropagationMatrix::K12(), PropagationMatrix::K13(), PropagationMatrix::K14(), PropagationMatrix::Kjj(), PropagationMatrix::NumberOfAzimuthAngles(), PropagationMatrix::NumberOfZenithAngles(), R1, R2, R3, R4, and stokes_dim.

Referenced by stepwise_source().

◆ SetZero()

void RadiationVector::SetZero ( size_t  i)
inline

Set Radiation Vector to Zero at position.

Parameters
[in]iposition

Definition at line 552 of file transmissionmatrix.h.

References R1, R2, R3, R4, and stokes_dim.

Referenced by stepwise_source().

◆ StokesDim()

Index RadiationVector::StokesDim ( ) const
inline

Get Stokes dimension.

Definition at line 973 of file transmissionmatrix.h.

References stokes_dim.

Referenced by stepwise_source(), and xml_write_to_stream().

◆ Vec()

Eigen::VectorXd RadiationVector::Vec ( size_t  i) const
inline

Return Vector at position by copy.

Parameters
[in]iposition
Returns
const Eigen::Matrix<double, 1, 1>& Vector

Definition at line 602 of file transmissionmatrix.h.

References stokes_dim, Vec1(), Vec2(), Vec3(), and Vec4().

◆ Vec1() [1/2]

Eigen::Matrix< double, 1, 1 > & RadiationVector::Vec1 ( size_t  i)
inline

Return Vector at position.

Parameters
[in]iposition
Returns
Eigen::Matrix<double, 1, 1>& Vector

Definition at line 642 of file transmissionmatrix.h.

References R1.

◆ Vec1() [2/2]

const Eigen::Matrix< double, 1, 1 > & RadiationVector::Vec1 ( size_t  i) const
inline

Return Vector at position.

Parameters
[in]iposition
Returns
const Eigen::Matrix<double, 1, 1>& Vector

Definition at line 595 of file transmissionmatrix.h.

References R1.

Referenced by stepwise_source(), and Vec().

◆ Vec2() [1/2]

Eigen::Vector2d & RadiationVector::Vec2 ( size_t  i)
inline

Return Vector at position.

Parameters
[in]iposition
Returns
Eigen::Vector2d& Vector

Definition at line 635 of file transmissionmatrix.h.

References R2.

◆ Vec2() [2/2]

const Eigen::Vector2d & RadiationVector::Vec2 ( size_t  i) const
inline

Return Vector at position.

Parameters
[in]iposition
Returns
const Eigen::Vector2d& Vector

Definition at line 588 of file transmissionmatrix.h.

References R2.

Referenced by stepwise_source(), and Vec().

◆ Vec3() [1/2]

Eigen::Vector3d & RadiationVector::Vec3 ( size_t  i)
inline

Return Vector at position.

Parameters
[in]iposition
Returns
Eigen::Vector3d& Vector

Definition at line 628 of file transmissionmatrix.h.

References R3.

◆ Vec3() [2/2]

const Eigen::Vector3d & RadiationVector::Vec3 ( size_t  i) const
inline

Return Vector at position.

Parameters
[in]iposition
Returns
const Eigen::Vector3d& Vector

Definition at line 581 of file transmissionmatrix.h.

References R3.

Referenced by stepwise_source(), and Vec().

◆ Vec4() [1/2]

Eigen::Vector4d & RadiationVector::Vec4 ( size_t  i)
inline

Return Vector at position.

Parameters
[in]iposition
Returns
Eigen::Vector4d& Vector

Definition at line 621 of file transmissionmatrix.h.

References R4.

◆ Vec4() [2/2]

const Eigen::Vector4d & RadiationVector::Vec4 ( size_t  i) const
inline

Return Vector at position.

Parameters
[in]iposition
Returns
const Eigen::Vector4d& Vector

Definition at line 574 of file transmissionmatrix.h.

References R4.

Referenced by stepwise_source(), and Vec().

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const RadiationVector rv 
)
friend

Output operator.

Definition at line 1691 of file transmissionmatrix.cc.

◆ operator>>

std::istream & operator>> ( std::istream &  data,
RadiationVector rv 
)
friend

Input operator.

Definition at line 1727 of file transmissionmatrix.cc.

Member Data Documentation

◆ R1

std::vector<Eigen::Matrix<double, 1, 1>, Eigen::aligned_allocator<Eigen::Matrix<double, 1, 1> > > RadiationVector::R1
private

◆ R2

◆ R3

◆ R4

◆ stokes_dim

Index RadiationVector::stokes_dim
private

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