UFO
ufo::TrackCheckShipParameters Class Reference

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

#include <TrackCheckShipParameters.h>

Inheritance diagram for ufo::TrackCheckShipParameters:
Collaboration diagram for ufo::TrackCheckShipParameters:

Public Attributes

oops::Parameter< util::Duration > temporalResolution
 
oops::Parameter< double > spatialResolution
 
oops::Parameter< double > maxSpeed
 Maximum speed (before marking as fast) in km/s. More...
 
oops::OptionalParameter< float > debugWindowStart
 
oops::OptionalParameter< float > debugWindowEnd
 
oops::Parameter< int > inputCategory
 
oops::Parameter< bool > deferredCheckSimultaneous
 If deferredCheckSimultaneous set to true, check of simultaneous observations will be deferred until the end, at which point flagged observations may be reinstated. More...
 
oops::Parameter< bool > earlyBreakCheck
 If earlyBreakCheck set to true, check will stop early based on the number of short-spaced, fast, and bended segments of the track. More...
 
oops::Parameter< bool > testingMode
 To be set to true if the filter's unit tests are being run. More...
 
- Public Attributes inherited from ufo::TrackCheckUtilsParameters
oops::OptionalParameter< VariablestationIdVariable
 

Detailed Description

Options controlling the operation of the ship track check filter.

Definition at line 26 of file TrackCheckShipParameters.h.

Member Data Documentation

◆ debugWindowEnd

oops::OptionalParameter<float> ufo::TrackCheckShipParameters::debugWindowEnd
Initial value:
{
"debug window end", this
}

The end of an observation window where trace output should be produced. If blank, the end of the track will be treated as the end of this window.

Definition at line 58 of file TrackCheckShipParameters.h.

◆ debugWindowStart

oops::OptionalParameter<float> ufo::TrackCheckShipParameters::debugWindowStart
Initial value:
{
"debug window start", this
}

The start of an observation window where trace output should be produced. If blank, the start of the track will be treated as the start of this window.

Definition at line 52 of file TrackCheckShipParameters.h.

◆ deferredCheckSimultaneous

oops::Parameter<bool> ufo::TrackCheckShipParameters::deferredCheckSimultaneous
Initial value:
{
"deferred check simultaneous", false, this
}

If deferredCheckSimultaneous set to true, check of simultaneous observations will be deferred until the end, at which point flagged observations may be reinstated.

Definition at line 71 of file TrackCheckShipParameters.h.

◆ earlyBreakCheck

oops::Parameter<bool> ufo::TrackCheckShipParameters::earlyBreakCheck
Initial value:
{
"early break check", true, this
}

If earlyBreakCheck set to true, check will stop early based on the number of short-spaced, fast, and bended segments of the track.

Definition at line 77 of file TrackCheckShipParameters.h.

◆ inputCategory

oops::Parameter<int> ufo::TrackCheckShipParameters::inputCategory
Initial value:
{
"input category", 2, this
}

The type of input source. This affects the treatment of tracks with large numbers of simultaneous observations.

Definition at line 64 of file TrackCheckShipParameters.h.

◆ maxSpeed

oops::Parameter<double> ufo::TrackCheckShipParameters::maxSpeed
Initial value:
{
"max speed", 1.0, this
}

Maximum speed (before marking as fast) in km/s.

Definition at line 46 of file TrackCheckShipParameters.h.

◆ spatialResolution

oops::Parameter<double> ufo::TrackCheckShipParameters::spatialResolution
Initial value:
{
"spatial resolution", 1.0, 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 41 of file TrackCheckShipParameters.h.

◆ temporalResolution

oops::Parameter<util::Duration> ufo::TrackCheckShipParameters::temporalResolution
Initial value:
{
"temporal resolution", util::Duration("PT10M"), this
}

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

Definition at line 30 of file TrackCheckShipParameters.h.

◆ testingMode

oops::Parameter<bool> ufo::TrackCheckShipParameters::testingMode
Initial value:
{
"testing mode", false, this
}

To be set to true if the filter's unit tests are being run.

Definition at line 82 of file TrackCheckShipParameters.h.


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