UFO
ufo::ObsLocParameters Class Reference

Options controlling local observations subsetting. More...

#include <ObsLocParameters.h>

Inheritance diagram for ufo::ObsLocParameters:
Collaboration diagram for ufo::ObsLocParameters:

Public Member Functions

double distance (const eckit::geometry::Point2 &p1, const eckit::geometry::Point2 &p2) const
 

Public Attributes

oops::RequiredParameter< double > lengthscale {"lengthscale", this}
 Localization lengthscale (find all obs within the distance from reference point) More...
 
oops::Parameter< SearchMethodsearchMethod {"search method", SearchMethod::BRUTEFORCE, this}
 Method for searching for nearest points: brute force or KD-tree. More...
 
oops::OptionalParameter< int > maxnobs {"max nobs", this}
 Maximum number of obs. More...
 
oops::Parameter< DistanceTypedistanceType {"distance type", DistanceType::GEODESIC, this}
 

Static Public Attributes

static constexpr double radius_earth = 6.371e6
 

Detailed Description

Options controlling local observations subsetting.

Definition at line 78 of file ObsLocParameters.h.

Member Function Documentation

◆ distance()

double ufo::ObsLocParameters::distance ( const eckit::geometry::Point2 &  p1,
const eckit::geometry::Point2 &  p2 
) const
inline

returns distance between points p1 and p2, depending on the distance calculation type distanceType

Definition at line 97 of file ObsLocParameters.h.

Here is the call graph for this function:

Member Data Documentation

◆ distanceType

oops::Parameter<DistanceType> ufo::ObsLocParameters::distanceType {"distance type", DistanceType::GEODESIC, this}

Distance calculation type: geodesic (on sphere) or cartesian (euclidian) Default: geodesic

Definition at line 93 of file ObsLocParameters.h.

◆ lengthscale

oops::RequiredParameter<double> ufo::ObsLocParameters::lengthscale {"lengthscale", this}

Localization lengthscale (find all obs within the distance from reference point)

Definition at line 83 of file ObsLocParameters.h.

◆ maxnobs

oops::OptionalParameter<int> ufo::ObsLocParameters::maxnobs {"max nobs", this}

Maximum number of obs.

Definition at line 89 of file ObsLocParameters.h.

◆ radius_earth

constexpr double ufo::ObsLocParameters::radius_earth = 6.371e6
staticconstexpr

Definition at line 107 of file ObsLocParameters.h.

◆ searchMethod

oops::Parameter<SearchMethod> ufo::ObsLocParameters::searchMethod {"search method", SearchMethod::BRUTEFORCE, this}

Method for searching for nearest points: brute force or KD-tree.

Definition at line 86 of file ObsLocParameters.h.


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