UFO
ufo::CLWRetMW Class Reference

Retrieve cloud liquid water from 23.8 GHz and 31.4 GHz channels. More...

#include <CLWRetMW.h>

Inheritance diagram for ufo::CLWRetMW:
Collaboration diagram for ufo::CLWRetMW:

Public Member Functions

 CLWRetMW (const eckit::LocalConfiguration &=eckit::LocalConfiguration())
 
 ~CLWRetMW ()
 
void compute (const ObsFilterData &, ioda::ObsDataVector< float > &) const
 compute the result of the function More...
 
const ufo::VariablesrequiredVariables () const
 geovals required to compute the function More...
 
const std::vector< std::string > & clwVariableGroups () const
 
- Public Member Functions inherited from ufo::ObsFunctionBase< float >
 ObsFunctionBase (const eckit::LocalConfiguration conf=eckit::LocalConfiguration())
 
virtual ~ObsFunctionBase ()
 

Static Public Member Functions

static void cloudLiquidWater (const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, std::vector< float > &)
 
static void CIret_37v37h_diff (const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, std::vector< float > &)
 
static void clw_retr_amsr2 (const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, const std::vector< float > &, std::vector< float > &)
 Retrieve AMSR2_GCOM-W1 cloud liquid water. This retrieval function is taken from the subroutine "retrieval_amsr2()" in GSI. More...
 
static float getBadValue ()
 

Private Attributes

ufo::Variables invars_
 
CLWRetMWParameters options_
 

Static Private Attributes

static constexpr float bad_clwret_value_ = 1000.f
 

Additional Inherited Members

- Public Types inherited from ufo::ObsFunctionBase< float >
typedef float Value_
 Type of the values produced by the function. More...
 

Detailed Description

Retrieve cloud liquid water from 23.8 GHz and 31.4 GHz channels.

Reference: Grody et al. (2001) Determination of precipitable water and cloud liquid water over oceans from the NOAA 15 advanced microwave sounding unit Journal of Geophysical Research (Vol. 106, No. D3, Pages 2943-2953)

Definition at line 88 of file CLWRetMW.h.

Constructor & Destructor Documentation

◆ CLWRetMW()

ufo::CLWRetMW::CLWRetMW ( const eckit::LocalConfiguration &  conf = eckit::LocalConfiguration())
explicit

Definition at line 27 of file CLWRetMW.cc.

◆ ~CLWRetMW()

ufo::CLWRetMW::~CLWRetMW ( )

Definition at line 96 of file CLWRetMW.cc.

Member Function Documentation

◆ CIret_37v37h_diff()

void ufo::CLWRetMW::CIret_37v37h_diff ( const std::vector< float > &  bt_clr_37v,
const std::vector< float > &  bt_clr_37h,
const std::vector< float > &  water_frac,
const std::vector< float > &  bt37v,
const std::vector< float > &  bt37h,
std::vector< float > &  out 
)
static

Retrieve cloud index from GMI 37V and 37H channels.

GMI cloud index: 1.0 - (Tb_37v - Tb_37h)/(Tb_37v_clr - Tb_37h_clr), in which Tb_37v_clr and Tb_37h_clr for calculated Tb at 37 V and 37H GHz from module values assuming in clear-sky condition. Tb_37v and Tb_37h are Tb observations at 37 V and 37H GHz.

Definition at line 302 of file CLWRetMW.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cloudLiquidWater()

void ufo::CLWRetMW::cloudLiquidWater ( const std::vector< float > &  szas,
const std::vector< float > &  tsavg,
const std::vector< float > &  water_frac,
const std::vector< float > &  bt238,
const std::vector< float > &  bt314,
std::vector< float > &  out 
)
static

Retrieve cloud liquid water from AMSU-A 23.8 GHz and 31.4 GHz channels.

Reference: Grody et al. (2001) Determination of precipitable water and cloud liquid water over oceans from the NOAA 15 advanced microwave sounding unit

Definition at line 266 of file CLWRetMW.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clw_retr_amsr2()

void ufo::CLWRetMW::clw_retr_amsr2 ( const std::vector< float > &  bt18v,
const std::vector< float > &  bt18h,
const std::vector< float > &  bt36v,
const std::vector< float > &  bt36h,
std::vector< float > &  out 
)
static

Retrieve AMSR2_GCOM-W1 cloud liquid water. This retrieval function is taken from the subroutine "retrieval_amsr2()" in GSI.

Definition at line 332 of file CLWRetMW.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clwVariableGroups()

const std::vector<std::string>& ufo::CLWRetMW::clwVariableGroups ( ) const
inline

Definition at line 97 of file CLWRetMW.h.

Here is the caller graph for this function:

◆ compute()

void ufo::CLWRetMW::compute ( const ObsFilterData ,
ioda::ObsDataVector< float > &   
) const
virtual

compute the result of the function

Implements ufo::ObsFunctionBase< float >.

Definition at line 100 of file CLWRetMW.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getBadValue()

static float ufo::CLWRetMW::getBadValue ( )
inlinestatic

Definition at line 117 of file CLWRetMW.h.

Here is the caller graph for this function:

◆ requiredVariables()

const ufo::Variables & ufo::CLWRetMW::requiredVariables ( ) const
virtual

geovals required to compute the function

Implements ufo::ObsFunctionBase< float >.

Definition at line 364 of file CLWRetMW.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ bad_clwret_value_

constexpr float ufo::CLWRetMW::bad_clwret_value_ = 1000.f
staticconstexprprivate

Definition at line 122 of file CLWRetMW.h.

◆ invars_

ufo::Variables ufo::CLWRetMW::invars_
private

Definition at line 120 of file CLWRetMW.h.

◆ options_

CLWRetMWParameters ufo::CLWRetMW::options_
private

Definition at line 121 of file CLWRetMW.h.


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