Computes observation operator (from GeoVaLs), applies bias correction and runs QC filters. More...

#include <CalcHofX.h>

Collaboration diagram for oops::CalcHofX< OBS >:

[legend]

Public Member Functions
	CalcHofX (const ObsSpaces_ &, const eckit::Configuration &)
	Initializes ObsOperators, Locations, and QC data. More...

void	initialize (const ObsAuxCtrls_ &, const int iteration=0)
	Initializes variables, obs bias, obs filters (could be different for different iterations. More...

Observations_	compute (const GeoVaLsVec_ &)
	Computes H(x) from the filled in GeoVaLs. More...

const LocationsVec_ &	locations () const
	accessor to the locations More...

const VariablesVec_ &	requiredVars () const
	accessor to variables required from the model More...

const ObsDataVec_< int > &	qcflags () const
	accessor to QC flags More...

void	readQcFlags (const std::string &qcname)
	read QC flags from `qcname` variable from file More...

void	resetQc ()
	reset QC flags and ObsErrors More...

void	saveQcFlags (const std::string &) const
	save QC flags to ObsSpaces More...

void	saveObsErrors (const std::string &) const
	save obs error variances (modified in QC) to ObsSpaces More...

void	maskObsErrors ()
	mask obs errors with QC flags More...

Private Types
typedef GeoVaLs< OBS >	GeoVaLs_

typedef Locations< OBS >	Locations_

typedef ObsAuxControls< OBS >	ObsAuxCtrls_

typedef ObsDiagnostics< OBS >	ObsDiags_

typedef Observations< OBS >	Observations_

typedef ObsFilters< OBS >	ObsFilters_

typedef ObsOperator< OBS >	ObsOperator_

typedef ObsSpaces< OBS >	ObsSpaces_

typedef ObsVector< OBS >	ObsVector_

template<typename DATA >
using	ObsData_ = ObsDataVector< OBS, DATA >

template<typename DATA >
using	ObsDataVec_ = std::vector< std::shared_ptr< ObsData_< DATA > >>

typedef std::vector< std::unique_ptr< GeoVaLs_ > >	GeoVaLsVec_

typedef std::vector< std::unique_ptr< Locations_ > >	LocationsVec_

typedef std::vector< std::unique_ptr< ObsFilters_ > >	ObsFiltersVec_

typedef std::vector< std::unique_ptr< ObsOperator_ > >	ObsOperatorVec_

typedef std::vector< std::shared_ptr< ObsVector_ > >	ObsVectorVec_

typedef std::vector< Variables >	VariablesVec_

Private Attributes
eckit::LocalConfiguration	obsconfig_

const ObsSpaces_ &	obspaces_

ObsOperatorVec_	obsops_

LocationsVec_	locations_

const ObsAuxCtrls_ *	biascoeff_

ObsDataVec_< int >	qcflags_

ObsVectorVec_	obserrs_

ObsFiltersVec_	filters_

VariablesVec_	geovars_

Detailed Description

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

Computes observation operator (from GeoVaLs), applies bias correction and runs QC filters.

Definition at line 50 of file CalcHofX.h.

Member Typedef Documentation

◆ GeoVaLs_

template<typename OBS >

typedef GeoVaLs<OBS> oops::CalcHofX< OBS >::GeoVaLs_

private

Definition at line 51 of file CalcHofX.h.

◆ GeoVaLsVec_

template<typename OBS >

typedef std::vector<std::unique_ptr<GeoVaLs_> > oops::CalcHofX< OBS >::GeoVaLsVec_

private

Definition at line 63 of file CalcHofX.h.

◆ Locations_

template<typename OBS >

typedef Locations<OBS> oops::CalcHofX< OBS >::Locations_

private

Definition at line 52 of file CalcHofX.h.

◆ LocationsVec_

template<typename OBS >

typedef std::vector<std::unique_ptr<Locations_> > oops::CalcHofX< OBS >::LocationsVec_

private

Definition at line 64 of file CalcHofX.h.

◆ ObsAuxCtrls_

template<typename OBS >

typedef ObsAuxControls<OBS> oops::CalcHofX< OBS >::ObsAuxCtrls_

private

Definition at line 53 of file CalcHofX.h.

◆ ObsData_

template<typename OBS >

template<typename DATA >

using oops::CalcHofX< OBS >::ObsData_ = ObsDataVector<OBS, DATA>

private

Definition at line 60 of file CalcHofX.h.

◆ ObsDataVec_

template<typename OBS >

template<typename DATA >

using oops::CalcHofX< OBS >::ObsDataVec_ = std::vector<std::shared_ptr<ObsData_<DATA> >>

private

Definition at line 61 of file CalcHofX.h.

◆ ObsDiags_

template<typename OBS >

typedef ObsDiagnostics<OBS> oops::CalcHofX< OBS >::ObsDiags_

private

Definition at line 54 of file CalcHofX.h.

◆ Observations_

template<typename OBS >

typedef Observations<OBS> oops::CalcHofX< OBS >::Observations_

private

Definition at line 55 of file CalcHofX.h.

◆ ObsFilters_

template<typename OBS >

typedef ObsFilters<OBS> oops::CalcHofX< OBS >::ObsFilters_

private

Definition at line 56 of file CalcHofX.h.

◆ ObsFiltersVec_

template<typename OBS >

typedef std::vector<std::unique_ptr<ObsFilters_> > oops::CalcHofX< OBS >::ObsFiltersVec_

private

Definition at line 65 of file CalcHofX.h.

◆ ObsOperator_

template<typename OBS >

typedef ObsOperator<OBS> oops::CalcHofX< OBS >::ObsOperator_

private

Definition at line 57 of file CalcHofX.h.

◆ ObsOperatorVec_

template<typename OBS >

typedef std::vector<std::unique_ptr<ObsOperator_> > oops::CalcHofX< OBS >::ObsOperatorVec_

private

Definition at line 66 of file CalcHofX.h.

◆ ObsSpaces_

template<typename OBS >

typedef ObsSpaces<OBS> oops::CalcHofX< OBS >::ObsSpaces_

private

Definition at line 58 of file CalcHofX.h.

◆ ObsVector_

template<typename OBS >

typedef ObsVector<OBS> oops::CalcHofX< OBS >::ObsVector_

private

Definition at line 59 of file CalcHofX.h.

◆ ObsVectorVec_

template<typename OBS >

typedef std::vector<std::shared_ptr<ObsVector_> > oops::CalcHofX< OBS >::ObsVectorVec_

private

Definition at line 67 of file CalcHofX.h.

◆ VariablesVec_

template<typename OBS >

typedef std::vector<Variables> oops::CalcHofX< OBS >::VariablesVec_

private

Definition at line 68 of file CalcHofX.h.

Constructor & Destructor Documentation

◆ CalcHofX()

template<typename OBS >

oops::CalcHofX< OBS >::CalcHofX	(	const ObsSpaces_ &	obspaces,
		const eckit::Configuration &	config
	)

Initializes ObsOperators, Locations, and QC data.

Set up observation operators

Allocate QC flags

Allocate and read initial obs error

Definition at line 114 of file CalcHofX.h.

Here is the call graph for this function:

Member Function Documentation

◆ compute()

template<typename OBS >

Observations< OBS > oops::CalcHofX< OBS >::compute ( const GeoVaLsVec_ & geovals )

Computes H(x) from the filled in GeoVaLs.

call prior filters

compute H(x)

call posterior filters

Definition at line 170 of file CalcHofX.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize()

template<typename OBS >

void oops::CalcHofX< OBS >::initialize	(	const ObsAuxCtrls_ &	obsaux,
		const int	iteration = `0`
	)

Initializes variables, obs bias, obs filters (could be different for different iterations.

Set up QC filters and run preprocess

Set up variables requested from the model

Definition at line 147 of file CalcHofX.h.

Here is the caller graph for this function:

◆ locations()

template<typename OBS >

const LocationsVec_& oops::CalcHofX< OBS >::locations ( ) const

inline

accessor to the locations

Definition at line 82 of file CalcHofX.h.

Here is the caller graph for this function:

◆ maskObsErrors()

template<typename OBS >

void oops::CalcHofX< OBS >::maskObsErrors

mask obs errors with QC flags

Definition at line 234 of file CalcHofX.h.

◆ qcflags()

template<typename OBS >

const ObsDataVec_<int>& oops::CalcHofX< OBS >::qcflags ( ) const

inline

accessor to QC flags

Definition at line 86 of file CalcHofX.h.

◆ readQcFlags()

template<typename OBS >

void oops::CalcHofX< OBS >::readQcFlags ( const std::string & qcname )

read QC flags from qcname variable from file

Definition at line 195 of file CalcHofX.h.

◆ requiredVars()

template<typename OBS >

const VariablesVec_& oops::CalcHofX< OBS >::requiredVars ( ) const

inline

accessor to variables required from the model

Definition at line 84 of file CalcHofX.h.

Here is the caller graph for this function:

◆ resetQc()

template<typename OBS >

void oops::CalcHofX< OBS >::resetQc

reset QC flags and ObsErrors

Definition at line 204 of file CalcHofX.h.

◆ saveObsErrors()

template<typename OBS >

void oops::CalcHofX< OBS >::saveObsErrors ( const std::string & name ) const

save obs error variances (modified in QC) to ObsSpaces

Definition at line 225 of file CalcHofX.h.

Here is the caller graph for this function:

◆ saveQcFlags()

template<typename OBS >

void oops::CalcHofX< OBS >::saveQcFlags ( const std::string & name ) const

save QC flags to ObsSpaces

Definition at line 216 of file CalcHofX.h.

Here is the caller graph for this function:

Member Data Documentation

◆ biascoeff_

template<typename OBS >

const ObsAuxCtrls_* oops::CalcHofX< OBS >::biascoeff_

private

Definition at line 104 of file CalcHofX.h.

◆ filters_

template<typename OBS >

ObsFiltersVec_ oops::CalcHofX< OBS >::filters_

private

Definition at line 107 of file CalcHofX.h.

◆ geovars_

template<typename OBS >

VariablesVec_ oops::CalcHofX< OBS >::geovars_

private

Definition at line 108 of file CalcHofX.h.

◆ locations_

template<typename OBS >

LocationsVec_ oops::CalcHofX< OBS >::locations_

private

Definition at line 103 of file CalcHofX.h.

◆ obsconfig_

template<typename OBS >

eckit::LocalConfiguration oops::CalcHofX< OBS >::obsconfig_

private

Definition at line 100 of file CalcHofX.h.

◆ obserrs_

template<typename OBS >

ObsVectorVec_ oops::CalcHofX< OBS >::obserrs_

private

Definition at line 106 of file CalcHofX.h.

◆ obsops_

template<typename OBS >

ObsOperatorVec_ oops::CalcHofX< OBS >::obsops_

private

Definition at line 102 of file CalcHofX.h.

◆ obspaces_

template<typename OBS >

const ObsSpaces_& oops::CalcHofX< OBS >::obspaces_

private

Definition at line 101 of file CalcHofX.h.

◆ qcflags_

template<typename OBS >

ObsDataVec_<int> oops::CalcHofX< OBS >::qcflags_

private

Definition at line 105 of file CalcHofX.h.

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

CalcHofX.h

Public Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ GeoVaLs_

◆ GeoVaLsVec_

◆ Locations_

◆ LocationsVec_

◆ ObsAuxCtrls_

◆ ObsData_

◆ ObsDataVec_

◆ ObsDiags_

◆ Observations_

◆ ObsFilters_

◆ ObsFiltersVec_

◆ ObsOperator_

◆ ObsOperatorVec_

◆ ObsSpaces_

◆ ObsVector_

◆ ObsVectorVec_

◆ VariablesVec_

Constructor & Destructor Documentation

◆ CalcHofX()

Member Function Documentation

◆ compute()

◆ initialize()

◆ locations()

◆ maskObsErrors()

◆ qcflags()

◆ readQcFlags()

◆ requiredVars()

◆ resetQc()

◆ saveObsErrors()

◆ saveQcFlags()

Member Data Documentation

◆ biascoeff_

◆ filters_

◆ geovars_

◆ locations_

◆ obsconfig_

◆ obserrs_

◆ obsops_

◆ obspaces_

◆ qcflags_

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