UFO
ufo::TrackCheckParameters Class Reference

Options controlling the operation of the track check filter. More...

#include <TrackCheckParameters.h>

Inheritance diagram for ufo::TrackCheckParameters:
Collaboration diagram for ufo::TrackCheckParameters:

Public Attributes

oops::Parameter< util::Duration > temporalResolution
 
oops::Parameter< float > spatialResolution
 
oops::Parameter< int > numDistinctBuddiesPerDirection
 
oops::Parameter< int > distinctBuddyResolutionMultiplier
 
oops::OptionalParameter< float > maxClimbRate {"max_climb_rate", this}
 Maximum allowed rate of ascent and descent (Pa/s). If not set, climb rate checks are disabled. More...
 
oops::Parameter< std::map< float, float > > maxSpeedInterpolationPoints
 
oops::Parameter< float > rejectionThreshold
 
- Public Attributes inherited from ufo::TrackCheckUtilsParameters
oops::OptionalParameter< VariablestationIdVariable
 
- Public Attributes inherited from ufo::FilterParametersBaseWithAbstractAction
oops::OptionalParameter< std::vector< Variable > > filterVariables
 
oops::Parameter< std::vector< WhereParameters > > where {"where", {}, this}
 
oops::Parameter< bool > deferToPost {"defer to post", false, this}
 

Additional Inherited Members

- Public Member Functions inherited from ufo::FilterParametersBase
const FilterActionParametersBaseaction () const override
 Return parameters defining the action performed on observations flagged by the filter. More...
 

Detailed Description

Options controlling the operation of the track check filter.

Definition at line 31 of file TrackCheckParameters.h.

Member Data Documentation

◆ distinctBuddyResolutionMultiplier

oops::Parameter<int> ufo::TrackCheckParameters::distinctBuddyResolutionMultiplier
Initial value:
{
"distinct_buddy_resolution_multiplier", 3, this}

Controls the size of the set of observations against which each observation is compared.

See also
numDistinctBuddiesPerDirection

Definition at line 62 of file TrackCheckParameters.h.

◆ maxClimbRate

oops::OptionalParameter<float> ufo::TrackCheckParameters::maxClimbRate {"max_climb_rate", this}

Maximum allowed rate of ascent and descent (Pa/s). If not set, climb rate checks are disabled.

Definition at line 66 of file TrackCheckParameters.h.

◆ maxSpeedInterpolationPoints

oops::Parameter<std::map<float, float> > ufo::TrackCheckParameters::maxSpeedInterpolationPoints
Initial value:
{
"max_speed_interpolation_points", std::map<float, float>{{0.0f, 1000.0f}}, this}

Encoding of the function mapping air pressure (in Pa) to the maximum speed (in m/s) considered to be realistic.

The function is taken to be a linear interpolation of a series of (pressure, speed) points. The pressures and speeds at these points should be specified as keys and values of a JSON-style map. Owing to a bug in the eckit YAML parser, the keys must be enclosed in quotes. For example,

max_speed_interpolation_points: { "0": 900, "100000": 100 }

encodes a linear function equal to 900 m/s at 0 Pa and 100 m/s at 100000 Pa.

Definition at line 78 of file TrackCheckParameters.h.

◆ numDistinctBuddiesPerDirection

oops::Parameter<int> ufo::TrackCheckParameters::numDistinctBuddiesPerDirection
Initial value:
{
"num_distinct_buddies_per_direction", 3, this}

Controls the size of the set of observations against which each observation is compared.

Each observation O(x, t) (taken at time t and location x) is compared against the smallest set of observations O'(x', t') immediately preceding and following O(x, t) that contains num_distinct_buddies_per_direction earlier observations meeting the following conditions:

  • |t' - t| > distinct_buddy_resolution_multiplier * temporal_resolution
  • |x' - x| > distinct_buddy_resolution_multiplier * spatial_resolution
  • O' has not yet been rejected and the same number of later observations meeting the same conditions.

Definition at line 57 of file TrackCheckParameters.h.

◆ rejectionThreshold

oops::Parameter<float> ufo::TrackCheckParameters::rejectionThreshold
Initial value:
{
"rejection_threshold", 0.5f, this}

Maximum fraction of climb rate or speed estimates obtained by comparison with other observations that are allowed to fall outside the allowed ranges before an observation is rejected.

Definition at line 83 of file TrackCheckParameters.h.

◆ spatialResolution

oops::Parameter<float> ufo::TrackCheckParameters::spatialResolution
Initial value:
{
"spatial_resolution", 1.0f, this}

Assumed spatial resolution of the observations (in km), i.e. absolute accuracy of the reported positions.

Instantaneous speeds are estimated conservatively with the formula

speed_estimate = (reported_distance - spatial_resolution) / (reported_time + temporal_resolution).

Definition at line 46 of file TrackCheckParameters.h.

◆ temporalResolution

oops::Parameter<util::Duration> ufo::TrackCheckParameters::temporalResolution
Initial value:
{
"temporal_resolution", util::Duration("PT1M"), this}

Assumed temporal resolution of the observations, i.e. absolute accuracy of the reported observation times.

Definition at line 37 of file TrackCheckParameters.h.


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