#include <ObsSpaceParameters.h>

Inheritance diagram for ioda::ObsTopLevelParameters:

Collaboration diagram for ioda::ObsTopLevelParameters:

Public Member Functions
void	deserialize (util::CompositePath &path, const eckit::Configuration &config) override

const ObsIoParametersBase &	obsIoInParameters () const
	parameters indicating where to load data from More...

Public Attributes
oops::RequiredParameter< std::string >	obsSpaceName {"name", this}
	name of obs space More...

oops::Parameter< int >	obsPertSeed {"obs perturbations seed", 0, this}
	perturbation seed More...

oops::Parameter< std::string >	distName {"distribution", "RoundRobin", this}
	name of MPI distribution More...

oops::RequiredParameter< oops::Variables >	simVars {"simulated variables", this}
	simulated variables More...

oops::OptionalParameter< std::vector< float > >	haloCenter {"center", this}
	Halo distribution center. More...

oops::OptionalParameter< float >	haloRadius {"radius", this}
	Halo distribution radius. More...

oops::OptionalParameter< ObsFileOutParameters >	obsOutFile {"obsdataout", this}
	output specification by writing to a file More...

oops::OptionalParameter< ObsExtendParameters >	obsExtend {"extension", this}
	extend the ObsSpace with extra fixed-size records More...

Private Attributes
oops::OptionalParameter< ObsFileInParameters >	obsInFile {"obsdatain", this}
	Fill this section to read observations from a file. More...

oops::OptionalParameter< LegacyObsGenerateParameters >	obsGenerate {"generate", this}
	Fill this section to generate observations on the fly. More...

oops::OptionalParameter< ObsIoParametersWrapper >	source {"source", this}
	Fill this section instead of `obsdatain` and `generate` to load observations from any other source. More...

Detailed Description

Definition at line 170 of file ObsSpaceParameters.h.

Member Function Documentation

◆ deserialize()

void ioda::ObsTopLevelParameters::deserialize	(	util::CompositePath &	path,
		const eckit::Configuration &	config
	)

override

Reimplemented to store contents of the obsdatain or generate section (if present) in the source member variable. This makes it possible for the options related to the source of input data to be accessed in a uniform way (regardless of in which section they were specified) by calling obsIoInParameters().

Definition at line 12 of file ObsSpaceParameters.cc.

◆ obsIoInParameters()

const ObsIoParametersBase& ioda::ObsTopLevelParameters::obsIoInParameters ( ) const

inline

parameters indicating where to load data from

Definition at line 205 of file ObsSpaceParameters.h.

Here is the caller graph for this function:

Member Data Documentation

◆ distName

oops::Parameter<std::string> ioda::ObsTopLevelParameters::distName {"distribution", "RoundRobin", this}

name of MPI distribution

Definition at line 187 of file ObsSpaceParameters.h.

◆ haloCenter

oops::OptionalParameter<std::vector<float> > ioda::ObsTopLevelParameters::haloCenter {"center", this}

Halo distribution center.

Definition at line 193 of file ObsSpaceParameters.h.

◆ haloRadius

oops::OptionalParameter<float> ioda::ObsTopLevelParameters::haloRadius {"radius", this}

Halo distribution radius.

Definition at line 196 of file ObsSpaceParameters.h.

◆ obsExtend

oops::OptionalParameter<ObsExtendParameters> ioda::ObsTopLevelParameters::obsExtend {"extension", this}

extend the ObsSpace with extra fixed-size records

Definition at line 202 of file ObsSpaceParameters.h.

◆ obsGenerate

oops::OptionalParameter<LegacyObsGenerateParameters> ioda::ObsTopLevelParameters::obsGenerate {"generate", this}

private

Fill this section to generate observations on the fly.

Definition at line 216 of file ObsSpaceParameters.h.

◆ obsInFile

oops::OptionalParameter<ObsFileInParameters> ioda::ObsTopLevelParameters::obsInFile {"obsdatain", this}

private

Fill this section to read observations from a file.

Definition at line 213 of file ObsSpaceParameters.h.

◆ obsOutFile

oops::OptionalParameter<ObsFileOutParameters> ioda::ObsTopLevelParameters::obsOutFile {"obsdataout", this}

output specification by writing to a file

Definition at line 199 of file ObsSpaceParameters.h.

◆ obsPertSeed

oops::Parameter<int> ioda::ObsTopLevelParameters::obsPertSeed {"obs perturbations seed", 0, this}

perturbation seed

Definition at line 184 of file ObsSpaceParameters.h.

◆ obsSpaceName

oops::RequiredParameter<std::string> ioda::ObsTopLevelParameters::obsSpaceName {"name", this}

name of obs space

Definition at line 181 of file ObsSpaceParameters.h.

◆ simVars

oops::RequiredParameter<oops::Variables> ioda::ObsTopLevelParameters::simVars {"simulated variables", this}

simulated variables

Definition at line 190 of file ObsSpaceParameters.h.

◆ source

oops::OptionalParameter<ObsIoParametersWrapper> ioda::ObsTopLevelParameters::source {"source", this}

private

Fill this section instead of obsdatain and generate to load observations from any other source.

Definition at line 220 of file ObsSpaceParameters.h.

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

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ deserialize()

◆ obsIoInParameters()

Member Data Documentation

◆ distName

◆ haloCenter

◆ haloRadius

◆ obsExtend

◆ obsGenerate

◆ obsInFile

◆ obsOutFile

◆ obsPertSeed

◆ obsSpaceName

◆ simVars

◆ source