UFO
Classes | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ufo::ObsLocalization< MODEL > Class Template Reference

Horizontal Box car observation space localization. More...

#include <ObsLocalization.h>

Inheritance diagram for ufo::ObsLocalization< MODEL >:
Inheritance graph
[legend]
Collaboration diagram for ufo::ObsLocalization< MODEL >:
Collaboration graph
[legend]

Classes

struct  TreeTrait
 

Public Types

typedef eckit::KDTreeMemory< TreeTrait > KDTree
 

Public Member Functions

 ObsLocalization (const eckit::Configuration &, const ioda::ObsSpace &)
 
void computeLocalization (const GeometryIterator_ &, ioda::ObsVector &locvector) const override
 
const std::vector< int > & localobs () const
 
const std::vector< double > & horizontalObsdist () const
 
const ObsLocParameters & localizationOptions () const
 

Private Types

typedef MODEL::GeometryIterator GeometryIterator_
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

ObsLocParameters options_
 
std::vector< double > obsdist_
 
std::vector< int > localobs_
 
std::unique_ptr< KDTree > kd_
 KD-tree for searching for local obs. More...
 
std::vector< float > lats_
 
std::vector< float > lons_
 
std::string distName_
 TODO(travis) distribution name is needed for temporary fix, should be removed eventually. More...
 

Detailed Description

template<class MODEL>
class ufo::ObsLocalization< MODEL >

Horizontal Box car observation space localization.

Definition at line 39 of file ObsLocalization.h.

Member Typedef Documentation

◆ GeometryIterator_

template<class MODEL >
typedef MODEL::GeometryIterator ufo::ObsLocalization< MODEL >::GeometryIterator_
private

Definition at line 40 of file ObsLocalization.h.

◆ KDTree

template<class MODEL >
typedef eckit::KDTreeMemory<TreeTrait> ufo::ObsLocalization< MODEL >::KDTree

Definition at line 47 of file ObsLocalization.h.

Constructor & Destructor Documentation

◆ ObsLocalization()

template<typename MODEL >
ufo::ObsLocalization< MODEL >::ObsLocalization ( const eckit::Configuration &  config,
const ioda::ObsSpace &  obsspace 
)

Creates a KDTree class member that can be used for searching for local obs

Definition at line 82 of file ObsLocalization.h.

Here is the call graph for this function:

Member Function Documentation

◆ computeLocalization()

template<typename MODEL >
void ufo::ObsLocalization< MODEL >::computeLocalization ( const GeometryIterator_ &  i,
ioda::ObsVector &  locvector 
) const
override

compute localization and save localization values in locvector (missing values indicate that observation is outside of localization)

Definition at line 119 of file ObsLocalization.h.

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

◆ horizontalObsdist()

template<class MODEL >
const std::vector<double>& ufo::ObsLocalization< MODEL >::horizontalObsdist ( ) const
inline

Definition at line 56 of file ObsLocalization.h.

Here is the caller graph for this function:

◆ localizationOptions()

template<class MODEL >
const ObsLocParameters& ufo::ObsLocalization< MODEL >::localizationOptions ( ) const
inline

Definition at line 57 of file ObsLocalization.h.

Here is the caller graph for this function:

◆ localobs()

template<class MODEL >
const std::vector<int>& ufo::ObsLocalization< MODEL >::localobs ( ) const
inline

Definition at line 55 of file ObsLocalization.h.

Here is the caller graph for this function:

◆ print()

template<typename MODEL >
void ufo::ObsLocalization< MODEL >::print ( std::ostream &  os) const
overrideprivate

Definition at line 229 of file ObsLocalization.h.

Member Data Documentation

◆ distName_

template<class MODEL >
std::string ufo::ObsLocalization< MODEL >::distName_
private

TODO(travis) distribution name is needed for temporary fix, should be removed eventually.

Definition at line 73 of file ObsLocalization.h.

◆ kd_

template<class MODEL >
std::unique_ptr<KDTree> ufo::ObsLocalization< MODEL >::kd_
private

KD-tree for searching for local obs.

Definition at line 67 of file ObsLocalization.h.

◆ lats_

template<class MODEL >
std::vector<float> ufo::ObsLocalization< MODEL >::lats_
private

Definition at line 69 of file ObsLocalization.h.

◆ localobs_

template<class MODEL >
std::vector<int> ufo::ObsLocalization< MODEL >::localobs_
mutableprivate

Definition at line 62 of file ObsLocalization.h.

◆ lons_

template<class MODEL >
std::vector<float> ufo::ObsLocalization< MODEL >::lons_
private

Definition at line 70 of file ObsLocalization.h.

◆ obsdist_

template<class MODEL >
std::vector<double> ufo::ObsLocalization< MODEL >::obsdist_
mutableprivate

Definition at line 61 of file ObsLocalization.h.

◆ options_

template<class MODEL >
ObsLocParameters ufo::ObsLocalization< MODEL >::options_
private

Definition at line 60 of file ObsLocalization.h.

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