Observation error inflation action. More...

#include <InflateError.h>

Inheritance diagram for ufo::InflateError:

Collaboration diagram for ufo::InflateError:

[legend]

Public Types
typedef InflateErrorParameters	Parameters_

Public Member Functions
	InflateError (const Parameters_ &)

void	apply (const Variables &, const std::vector< std::vector< bool >> &, const ObsFilterData &, int, ioda::ObsDataVector< int > &, ioda::ObsDataVector< float > &) const override

const ufo::Variables &	requiredVariables () const override

Public Member Functions inherited from ufo::FilterActionBase
	FilterActionBase ()

virtual	~FilterActionBase ()

Private Attributes
Variables	allvars_

Parameters_	parameters_
	variables required to compute inflation More...

Detailed Description

Observation error inflation action.

Inflates Observation error for filter variables by:

constant (if "inflation factor" is specified in yaml)
spatially varying filter data (if "inflation variable" is specified in yaml). If inflation variable is the same size as filter variables, inflation is done variable by variable (e.g. inflation variable 1 is used to inflate filter variable 1; inflation variable 2 is used to inflate filter variable 2, etc). If inflation variable is of size 1, the same inflation variable is used for updating all filter variables.

Definition at line 49 of file InflateError.h.

Member Typedef Documentation

◆ Parameters_

typedef InflateErrorParameters ufo::InflateError::Parameters_

The type of parameters accepted by the constructor of this action. This typedef is used by the FilterActionFactory.

Definition at line 53 of file InflateError.h.

Constructor & Destructor Documentation

◆ InflateError()

ufo::InflateError::InflateError ( const Parameters_ & parameters )

explicit

Definition at line 41 of file InflateError.cc.

Member Function Documentation

◆ apply()

void ufo::InflateError::apply	(	const Variables &	vars,
		const std::vector< std::vector< bool >> &	flagged,
		const ObsFilterData &	data,
		int	,
		ioda::ObsDataVector< int > &	flags,
		ioda::ObsDataVector< float > &	obserr
	)		const

overridevirtual

Inflate ObsError by either a constant inflation factor, or by a varying inflation variable.

Parameters

vars	variables that need to be inflated in the ObsError (filter variables)
flagged	result of "where" statement: which variables/locations need to be updated (has the same variables as `vars`, in the same order)
data	accessor to obs filter data
flags	QC flags (for all "simulated variables")
obserr	ObsError (for all "simulated variables")

Implements ufo::FilterActionBase.

Definition at line 58 of file InflateError.cc.

Here is the call graph for this function:

◆ requiredVariables()

const ufo::Variables& ufo::InflateError::requiredVariables ( ) const

inlineoverridevirtual

Implements ufo::FilterActionBase.

Definition at line 61 of file InflateError.h.

Member Data Documentation

◆ allvars_

Variables ufo::InflateError::allvars_

private

Definition at line 64 of file InflateError.h.

◆ parameters_

Parameters_ ufo::InflateError::parameters_

private

variables required to compute inflation

Definition at line 65 of file InflateError.h.

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

Public Types

Public Member Functions

Private Attributes