#include <Legendre.h>

Inheritance diagram for ufo::Legendre:

Collaboration diagram for ufo::Legendre:

Public Types
typedef LegendreParameters	Parameters_

Public Member Functions
	Legendre (const Parameters_ &, const oops::Variables &)

	~Legendre ()

void	compute (const ioda::ObsSpace &, const GeoVaLs &, const ObsDiagnostics &, ioda::ObsVector &) const override
	compute the predictor More...

Public Member Functions inherited from ufo::PredictorBase
	PredictorBase (const PredictorParametersBase &, const oops::Variables &)

virtual	~PredictorBase ()=default

const oops::Variables &	requiredGeovars () const
	geovars names required to compute the predictor More...

const oops::Variables &	requiredHdiagnostics () const
	hdiags names required to compute the predictor More...

std::string &	name ()
	predictor name More...

const std::string &	name () const

Private Attributes
int	order_

int	nscan_

Additional Inherited Members
Protected Attributes inherited from ufo::PredictorBase
oops::Variables	vars_
	variables that will be bias-corrected using this predictor More...

oops::Variables	geovars_
	required GeoVaLs More...

oops::Variables	hdiags_
	required ObsDiagnostics More...

Detailed Description

This Legendre predictor is for fitting residual errors between the ends of the scan extremes; thus, the scan position is rescaled between -1 and 1 (xscan variable). Legendre polynomials are calculated with recurrence relations. Polynomials can be produced for an order (as addressed by input parameter of that name). The data must contain scan positions in the variable "scan_position@MetaData" and the number of scan positons in"sensor_numb_scan_position@MetaData". Both of these are vectors with length nlocs in the current implementation.

Definition at line 55 of file Legendre.h.

Member Typedef Documentation

◆ Parameters_

typedef LegendreParameters ufo::Legendre::Parameters_

The type of parameters accepted by the constructor of this predictor. This typedef is used by the PredictorFactory.

Definition at line 59 of file Legendre.h.

Constructor & Destructor Documentation

◆ Legendre()

ufo::Legendre::Legendre	(	const Parameters_ &	parameters,
		const oops::Variables &	vars
	)

Definition at line 20 of file Legendre.cc.

Here is the call graph for this function:

◆ ~Legendre()

ufo::Legendre::~Legendre ( )

inline

Definition at line 62 of file Legendre.h.

Member Function Documentation

◆ compute()

void ufo::Legendre::compute	(	const ioda::ObsSpace &	,
		const GeoVaLs &	,
		const ObsDiagnostics &	,
		ioda::ObsVector &
	)		const

overridevirtual

compute the predictor

Implements ufo::PredictorBase.

Definition at line 32 of file Legendre.cc.

Here is the call graph for this function:

Member Data Documentation

◆ nscan_

int ufo::Legendre::nscan_

private

Definition at line 71 of file Legendre.h.

◆ order_

int ufo::Legendre::order_

private

Definition at line 70 of file Legendre.h.

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

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members