OOPS
Public Member Functions | Private Types | List of all members
oops::ObsLocalizationBase< MODEL, OBS > Class Template Referenceabstract

#include <ObsLocalizationBase.h>

Inheritance diagram for oops::ObsLocalizationBase< MODEL, OBS >:
Inheritance graph
[legend]
Collaboration diagram for oops::ObsLocalizationBase< MODEL, OBS >:
Collaboration graph
[legend]

Public Member Functions

 ObsLocalizationBase ()=default
 
virtual ~ObsLocalizationBase ()=default
 
void computeLocalization (const GeometryIterator< MODEL > &point, ObsVector< OBS > &locfactor) const
 
virtual void computeLocalization (const GeometryIterator_ &point, ObsVector_ &locfactor) const =0
 

Private Types

typedef MODEL::GeometryIterator GeometryIterator_
 
typedef OBS::ObsVector ObsVector_
 

Detailed Description

template<typename MODEL, typename OBS>
class oops::ObsLocalizationBase< MODEL, OBS >

Base class for observation-space localization. Defines the interfaces for observation space localization. Use this class as a base class for OBS- and MODEL-specific implementations.

Definition at line 28 of file ObsLocalizationBase.h.

Member Typedef Documentation

◆ GeometryIterator_

template<typename MODEL , typename OBS >
typedef MODEL::GeometryIterator oops::ObsLocalizationBase< MODEL, OBS >::GeometryIterator_
private

Definition at line 30 of file ObsLocalizationBase.h.

◆ ObsVector_

template<typename MODEL , typename OBS >
typedef OBS::ObsVector oops::ObsLocalizationBase< MODEL, OBS >::ObsVector_
private

Definition at line 31 of file ObsLocalizationBase.h.

Constructor & Destructor Documentation

◆ ObsLocalizationBase()

template<typename MODEL , typename OBS >
oops::ObsLocalizationBase< MODEL, OBS >::ObsLocalizationBase ( )
default

◆ ~ObsLocalizationBase()

template<typename MODEL , typename OBS >
virtual oops::ObsLocalizationBase< MODEL, OBS >::~ObsLocalizationBase ( )
virtualdefault

Member Function Documentation

◆ computeLocalization() [1/2]

template<typename MODEL , typename OBS >
void oops::ObsLocalizationBase< MODEL, OBS >::computeLocalization ( const GeometryIterator< MODEL > &  point,
ObsVector< OBS > &  locfactor 
) const
inline

compute obs-space localization: fill locfactor with observation-space localization values between observations and point in model-space. Set locfactor to missing value for observations that are not local. Method used in oops. Calls computeLocalization abstract method, and passes OBS- and MODEL-specific classes to the OBS- and MODEL-specific implementations of ObsLocalization.

Definition at line 42 of file ObsLocalizationBase.h.

Here is the call graph for this function:

◆ computeLocalization() [2/2]

template<typename MODEL , typename OBS >
virtual void oops::ObsLocalizationBase< MODEL, OBS >::computeLocalization ( const GeometryIterator_ &  point,
ObsVector_ &  locfactor 
) const
pure virtual

compute obs-space localization: fill locfactor with observation-space localization values between observations and point in model-space. Set locfactor to missing value for observations that are not local.

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