IODA Bundle
oops::ObsFilters< OBS > Class Template Reference

Holds observation filters (usually QC) for one observation type. More...

#include <ObsFilters.h>

Inheritance diagram for oops::ObsFilters< OBS >:
[legend]
Collaboration diagram for oops::ObsFilters< OBS >:
[legend]

Public Member Functions

 ObsFilters (const ObsSpace_ &, const std::vector< ObsFilterParametersWrapper< OBS >> &, ObsDataPtr_ qcflags, ObsVector_ &obserr, const int iteration=0)
 
void preProcess () const
 
void priorFilter (const GeoVaLs_ &) const
 
void postFilter (const ObsVector_ &, const ObsDiags_ &) const
 
Variables requiredVars () const
 
Variables requiredHdiagnostics () const
 

Private Types

typedef GeoVaLs< OBS > GeoVaLs_
 
typedef ObsDiagnostics< OBS > ObsDiags_
 
typedef ObsSpace< OBS > ObsSpace_
 
typedef ObsVector< OBS > ObsVector_
 
typedef std::shared_ptr< ObsFilterBase< OBS > > ObsFilterPtr_
 
typedef std::shared_ptr< ObsDataVector< OBS, int > > ObsDataPtr_
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

std::vector< ObsFilterPtr_filters_
 
Variables geovars_
 
Variables diagvars_
 
ObsDataPtr_ qcflags_
 
ObsVector_obserr_
 
std::shared_ptr< ObsDataVector< OBS, float > > obserrtmp_
 

Detailed Description

template<typename OBS>
class oops::ObsFilters< OBS >

Holds observation filters (usually QC) for one observation type.

Definition at line 35 of file ObsFilters.h.

Member Typedef Documentation

◆ GeoVaLs_

template<typename OBS >
typedef GeoVaLs<OBS> oops::ObsFilters< OBS >::GeoVaLs_
private

Definition at line 37 of file ObsFilters.h.

◆ ObsDataPtr_

template<typename OBS >
typedef std::shared_ptr<ObsDataVector<OBS, int> > oops::ObsFilters< OBS >::ObsDataPtr_
private

Definition at line 42 of file ObsFilters.h.

◆ ObsDiags_

template<typename OBS >
typedef ObsDiagnostics<OBS> oops::ObsFilters< OBS >::ObsDiags_
private

Definition at line 38 of file ObsFilters.h.

◆ ObsFilterPtr_

template<typename OBS >
typedef std::shared_ptr<ObsFilterBase<OBS> > oops::ObsFilters< OBS >::ObsFilterPtr_
private

Definition at line 41 of file ObsFilters.h.

◆ ObsSpace_

template<typename OBS >
typedef ObsSpace<OBS> oops::ObsFilters< OBS >::ObsSpace_
private

Definition at line 39 of file ObsFilters.h.

◆ ObsVector_

template<typename OBS >
typedef ObsVector<OBS> oops::ObsFilters< OBS >::ObsVector_
private

Definition at line 40 of file ObsFilters.h.

Constructor & Destructor Documentation

◆ ObsFilters()

template<typename OBS >
oops::ObsFilters< OBS >::ObsFilters ( const ObsSpace_ os,
const std::vector< ObsFilterParametersWrapper< OBS >> &  filtersParams,
ObsDataPtr_  qcflags,
ObsVector_ obserr,
const int  iteration = 0 
)

Initialize all filters for obspace, from parameters, using qcflags and obserr (observation error variances) iteration argument indicates outer loop iteration in the variational assimilation

Definition at line 73 of file ObsFilters.h.

Here is the call graph for this function:

Member Function Documentation

◆ postFilter()

template<typename OBS >
void oops::ObsFilters< OBS >::postFilter ( const ObsVector_ hofx,
const ObsDiags_ diags 
) const

Definition at line 142 of file ObsFilters.h.

◆ preProcess()

template<typename OBS >
void oops::ObsFilters< OBS >::preProcess

Definition at line 120 of file ObsFilters.h.

◆ print()

template<typename OBS >
void oops::ObsFilters< OBS >::print ( std::ostream &  os) const
overrideprivate

Definition at line 153 of file ObsFilters.h.

◆ priorFilter()

template<typename OBS >
void oops::ObsFilters< OBS >::priorFilter ( const GeoVaLs_ gv) const

Definition at line 131 of file ObsFilters.h.

◆ requiredHdiagnostics()

template<typename OBS >
Variables oops::ObsFilters< OBS >::requiredHdiagnostics ( ) const
inline

Definition at line 57 of file ObsFilters.h.

◆ requiredVars()

template<typename OBS >
Variables oops::ObsFilters< OBS >::requiredVars ( ) const
inline

Definition at line 56 of file ObsFilters.h.

Member Data Documentation

◆ diagvars_

template<typename OBS >
Variables oops::ObsFilters< OBS >::diagvars_
private

Definition at line 64 of file ObsFilters.h.

◆ filters_

template<typename OBS >
std::vector<ObsFilterPtr_> oops::ObsFilters< OBS >::filters_
private

Definition at line 62 of file ObsFilters.h.

◆ geovars_

template<typename OBS >
Variables oops::ObsFilters< OBS >::geovars_
private

Definition at line 63 of file ObsFilters.h.

◆ obserr_

template<typename OBS >
ObsVector_& oops::ObsFilters< OBS >::obserr_
private

Definition at line 66 of file ObsFilters.h.

◆ obserrtmp_

template<typename OBS >
std::shared_ptr<ObsDataVector<OBS, float> > oops::ObsFilters< OBS >::obserrtmp_
private

Definition at line 67 of file ObsFilters.h.

◆ qcflags_

template<typename OBS >
ObsDataPtr_ oops::ObsFilters< OBS >::qcflags_
private

Definition at line 65 of file ObsFilters.h.


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