Implementation of ObsIo generating observations at locations specified in the input YAML file (parsed earlier into the ObsGenerateListParameters object passed to the constructor). More...
#include <ObsIoGenerateList.h>
Public Types | |
| typedef ObsGenerateListParameters | Parameters_ |
| Type used by ObsIoFactory. More... | |
Public Member Functions | |
| ObsIoGenerateList (const Parameters_ &ioParams, const ObsSpaceParameters &obsSpaceParams) | |
| ~ObsIoGenerateList () | |
| bool | applyTimingWindow () const override |
| return true if only observations within the timing window should be retained, false otherwise. More... | |
 Public Member Functions inherited from ioda::ObsIo | |
| ObsIo () | |
| virtual | ~ObsIo () |
| Dimensions_t | maxVarSize () const |
| return number of maximum variable size (along first dimension) More... | |
| Dimensions_t | numLocs () const |
| return number of locations from the source More... | |
| Dimensions_t | numVars () const |
| return number of regular variables from the source More... | |
| Dimensions_t | numDimVars () const |
| return number of dimension scale variables from the source More... | |
| const VarNameObjectList & | varList () const |
| return list of regular variable names More... | |
| const VarNameObjectList & | dimVarList () const |
| return list of dimension scale variable names More... | |
| VarDimMap | varDimMap () const |
| return map of variables to attached dimension scales More... | |
| bool | isVarDimByNlocs (const std::string &varName) const |
| return true if variable's first dimension is nlocs More... | |
| Has_Variables & | vars () |
| access to the variables container in the associated ObsGroup More... | |
| Has_Attributes & | atts () |
| access to the attributes container in the associated ObsGroup More... | |
| void | updateVarDimInfo () |
| update the variable and dimension information More... | |
| const std::vector< std::string > & | obsGroupingVars () const |
| return the names of variables to be used to group observations into records More... | |
| virtual bool | eachProcessGeneratesSeparateObs () const |
| return true if each process generates a separate series of observations (e.g. read from different files). More... | |
Static Public Member Functions | |
| static const std::string | classname () |
| classname method for object counter More... | |
Private Member Functions | |
| void | genDistList (const EmbeddedObsGenerateListParameters ¶ms, const std::vector< float > &obsErrors, const std::vector< std::string > &simVarNames) |
| generate observation locations using the list method More... | |
| void | print (std::ostream &os) const override |
| print routine for oops::Printable base class More... | |
Additional Inherited Members | |
| Protected Attributes inherited from ioda::ObsIo | |
| ObsGroup | obs_group_ |
| ObsGroup object representing io source/destination. More... | |
| Dimensions_t | max_var_size_ |
| maximum variable size (ie, first dimension size) More... | |
| Dimensions_t | nlocs_ |
| number of locations from source (file or generator) More... | |
| VarNameObjectList | var_list_ |
| list of regular variables from source (file or generator) More... | |
| VarNameObjectList | dim_var_list_ |
| list of dimension scale variables from source (file or generator) More... | |
| VarDimMap | dims_attached_to_vars_ |
| map containing variables with their attached dimension scales More... | |
| std::vector< std::string > | obs_grouping_vars_ |
| names of variables to be used to group observations into records More... | |
Detailed Description
Implementation of ObsIo generating observations at locations specified in the input YAML file (parsed earlier into the ObsGenerateListParameters object passed to the constructor).
Definition at line 31 of file ObsIoGenerateList.h.
Member Typedef Documentation
◆ Parameters_
Type used by ObsIoFactory.
Definition at line 41 of file ObsIoGenerateList.h.
Constructor & Destructor Documentation
◆ ObsIoGenerateList()
|
explicit |
◆ ~ObsIoGenerateList()
| ioda::ObsIoGenerateList::~ObsIoGenerateList | ( | ) |
Definition at line 59 of file ObsIoGenerateList.cc.
Member Function Documentation
◆ applyTimingWindow()
|
inlineoverridevirtual |
return true if only observations within the timing window should be retained, false otherwise.
Reimplemented from ioda::ObsIo.
Definition at line 47 of file ObsIoGenerateList.h.
◆ classname()
|
inlinestatic |
classname method for object counter
This method is supplied for the ObjectCounter base class. It defines a name to identify an object of this class for reporting by OOPS.
Definition at line 38 of file ObsIoGenerateList.h.
◆ genDistList()
|
private |
generate observation locations using the list method
This method will generate a set of latitudes and longitudes of which can be used for testing without reading in an obs file. The values are simply read from lists in the configuration file. The purpose of this method is to allow the user to exactly specify obs locations. these data are intended for use with the MakeObs functionality.
- Parameters
-
params Parameters structure specific to the generate list method obsErrors list of error estimates for each assimilated variable simVarNames list of names of variables to be assimilated
Definition at line 65 of file ObsIoGenerateList.cc.
◆ print()
|
overrideprivatevirtual |
print routine for oops::Printable base class
- Parameters
-
ostream output stream
Implements ioda::ObsIo.
Definition at line 80 of file ObsIoGenerateList.cc.
The documentation for this class was generated from the following files:
