IODA
ioda Namespace Reference

Namespaces

 test
 

Classes

struct  DistanceTypeParameterTraitsHelper
 
class  Distribution
 class for distributing obs across multiple process elements More...
 
class  DistributionFactory
 Factory class to instantiate objects of Distribution subclasses. More...
 
class  FrameDataMap
 frame data map More...
 
class  InefficientDistribution
 Inefficient distribution. More...
 
class  IodaIO
 File access class for IODA. More...
 
class  IodaIOfactory
 Factory class to instantiate objects of IodaIO subclasses. More...
 
struct  IodaTrait
 
class  LocalObsSpaceParameters
 Options controlling local observations subsetting. More...
 
class  NetcdfIO
 Implementation of IodaIO for netcdf. More...
 
class  ObsData
 Observation Data. More...
 
class  ObsDataVector
 ObsDataVector<DATATYPE> handles vectors of data of type DATATYPE in observation space. More...
 
class  ObsGroupingMap
 
class  ObsLocGC99
 ObsLocalization matrix for IODA model. More...
 
class  ObsSpace
 Observation Space View. More...
 
class  ObsSpaceContainer
 Obs container class for IODA. More...
 
class  ObsVector
 ObsVector class to handle vectors in observation space for IODA. More...
 
class  RoundRobin
 Round robin distribution. More...
 
struct  SearchMethodParameterTraitsHelper
 
class  TimeIodaIO
 

Typedefs

template<typename DATATYPE >
using ObsDataRow = std::vector< DATATYPE >
 

Enumerations

enum  DistanceType { DistanceType::GEODESIC, DistanceType::CARTESIAN }
 
enum  SearchMethod { SearchMethod::BRUTEFORCE, SearchMethod::KDTREE }
 
enum  ObsDtype { ObsDtype::None, ObsDtype::Float, ObsDtype::Integer, ObsDtype::String }
 

Functions

std::vector< std::size_t > CharShapeFromStringVector (const std::vector< std::string > &StringVector)
 
std::vector< std::string > CharArrayToStringVector (const char *CharData, const std::vector< std::size_t > &CharShape)
 
void StringVectorToCharArray (const std::vector< std::string > &StringVector, const std::vector< std::size_t > &CharShape, char *CharData)
 
std::string TypeIdName (const std::type_info &TypeId)
 
std::size_t FindMaxStringLength (const std::vector< std::string > &StringVector)
 
template<typename FromType , typename ToType >
void ConvertVarType (const std::vector< FromType > &FromVar, std::vector< ToType > &ToVar)
 
const ObsSpaceobsspace_construct_f (const eckit::Configuration *conf, const util::DateTime *begin, const util::DateTime *end)
 
void obsspace_destruct_f (ObsSpace *obss)
 
void obsspace_obsname_f (const ObsSpace &obss, size_t &lcname, char *cname)
 
const oops::Variables * obsspace_obsvariables_f (const ObsSpace &obss)
 
std::size_t obsspace_get_gnlocs_f (const ObsSpace &obss)
 
std::size_t obsspace_get_nlocs_f (const ObsSpace &obss)
 
std::size_t obsspace_get_nrecs_f (const ObsSpace &obss)
 
std::size_t obsspace_get_nvars_f (const ObsSpace &obss)
 
void obsspace_get_comm_f (const ObsSpace &obss, int &lcname, char *cname)
 
void obsspace_get_recnum_f (const ObsSpace &obss, const std::size_t &length, std::size_t *recnum)
 
void obsspace_get_index_f (const ObsSpace &obss, const std::size_t &length, std::size_t *index)
 
bool obsspace_has_f (const ObsSpace &obss, const char *group, const char *vname)
 
void obsspace_get_int32_f (const ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, int32_t *vec)
 
void obsspace_get_int64_f (const ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, int64_t *vec)
 
void obsspace_get_real32_f (const ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, float *vec)
 
void obsspace_get_real64_f (const ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, double *vec)
 
void obsspace_get_datetime_f (const ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, int32_t *date, int32_t *time)
 
void obsspace_put_int32_f (ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, int32_t *vec)
 
void obsspace_put_int64_f (ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, int64_t *vec)
 
void obsspace_put_real32_f (ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, float *vec)
 
void obsspace_put_real64_f (ObsSpace &obss, const char *group, const char *vname, const std::size_t &length, double *vec)
 
template<typename MODEL >
void instantiateObsLocFactory ()
 

Variables

const std::size_t IODAIO_DEFAULT_FRAME_SIZE = 10000
 Constant to be used for default maximum frame size. More...
 

Typedef Documentation

◆ ObsDataRow

template<typename DATATYPE >
using ioda::ObsDataRow = typedef std::vector<DATATYPE>

Definition at line 34 of file ObsDataVector.h.

Enumeration Type Documentation

◆ DistanceType

enum ioda::DistanceType
strong
Enumerator
GEODESIC 
CARTESIAN 

Definition at line 30 of file LocalObsSpaceParameters.h.

◆ ObsDtype

enum ioda::ObsDtype
strong
Enumerator
None 
Float 
Integer 
String 

Definition at line 63 of file ObsData.h.

◆ SearchMethod

enum ioda::SearchMethod
strong
Enumerator
BRUTEFORCE 
KDTREE 

Definition at line 34 of file LocalObsSpaceParameters.h.

Function Documentation

◆ CharArrayToStringVector()

std::vector< std::string > ioda::CharArrayToStringVector ( const char *  CharData,
const std::vector< std::size_t > &  CharShape 
)

Definition at line 33 of file IodaUtils.cc.

Here is the caller graph for this function:

◆ CharShapeFromStringVector()

std::vector< std::size_t > ioda::CharShapeFromStringVector ( const std::vector< std::string > &  StringVector)

Definition at line 17 of file IodaUtils.cc.

◆ ConvertVarType()

template<typename FromType , typename ToType >
void ioda::ConvertVarType ( const std::vector< FromType > &  FromVar,
std::vector< ToType > &  ToVar 
)

This method will perform numeric data type conversions. The caller needs to allocate memory for the converted data (ToVar). This method is aware of the IODA missing values and will convert these appropriately. For example when converting double to float, all double missing values will be replaced with float missing values during the conversion.

Parameters
[in]FromVarVector of variable we are converting from
[out]ToVarVector of variable we are converting to
[in]VarSizeTotal number of elements in FromVar and ToVar.

Definition at line 48 of file IodaUtils.h.

Here is the call graph for this function:

◆ FindMaxStringLength()

std::size_t ioda::FindMaxStringLength ( const std::vector< std::string > &  StringVector)

Definition at line 106 of file IodaUtils.cc.

Here is the caller graph for this function:

◆ instantiateObsLocFactory()

template<typename MODEL >
void ioda::instantiateObsLocFactory ( )

Definition at line 15 of file instantiateObsLocFactory.h.

◆ obsspace_construct_f()

const ObsSpace * ioda::obsspace_construct_f ( const eckit::Configuration *  conf,
const util::DateTime *  begin,
const util::DateTime *  end 
)

Definition at line 24 of file obsspace_f.cc.

◆ obsspace_destruct_f()

void ioda::obsspace_destruct_f ( ObsSpace obss)

Definition at line 31 of file obsspace_f.cc.

◆ obsspace_get_comm_f()

void ioda::obsspace_get_comm_f ( const ObsSpace obss,
int &  lcname,
char *  cname 
)

Definition at line 66 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_datetime_f()

void ioda::obsspace_get_datetime_f ( const ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
int32_t *  date,
int32_t *  time 
)

Definition at line 130 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_gnlocs_f()

std::size_t ioda::obsspace_get_gnlocs_f ( const ObsSpace obss)

Definition at line 50 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_index_f()

void ioda::obsspace_get_index_f ( const ObsSpace obss,
const std::size_t &  length,
std::size_t *  index 
)

Definition at line 80 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_int32_f()

void ioda::obsspace_get_int32_f ( const ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
int32_t *  vec 
)

Definition at line 94 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_int64_f()

void ioda::obsspace_get_int64_f ( const ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
int64_t *  vec 
)

Definition at line 104 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_nlocs_f()

std::size_t ioda::obsspace_get_nlocs_f ( const ObsSpace obss)

Definition at line 54 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_nrecs_f()

std::size_t ioda::obsspace_get_nrecs_f ( const ObsSpace obss)

Definition at line 58 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_nvars_f()

std::size_t ioda::obsspace_get_nvars_f ( const ObsSpace obss)

Definition at line 62 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_real32_f()

void ioda::obsspace_get_real32_f ( const ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
float *  vec 
)

Definition at line 112 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_real64_f()

void ioda::obsspace_get_real64_f ( const ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
double *  vec 
)

Definition at line 120 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_get_recnum_f()

void ioda::obsspace_get_recnum_f ( const ObsSpace obss,
const std::size_t &  length,
std::size_t *  recnum 
)

Definition at line 72 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_has_f()

bool ioda::obsspace_has_f ( const ObsSpace obss,
const char *  group,
const char *  vname 
)

Definition at line 90 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_obsname_f()

void ioda::obsspace_obsname_f ( const ObsSpace obss,
size_t &  lcname,
char *  cname 
)

Definition at line 37 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_obsvariables_f()

const oops::Variables * ioda::obsspace_obsvariables_f ( const ObsSpace obss)

Definition at line 45 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_put_int32_f()

void ioda::obsspace_put_int32_f ( ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
int32_t *  vec 
)

Definition at line 157 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_put_int64_f()

void ioda::obsspace_put_int64_f ( ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
int64_t *  vec 
)

Definition at line 167 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_put_real32_f()

void ioda::obsspace_put_real32_f ( ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
float *  vec 
)

Definition at line 175 of file obsspace_f.cc.

Here is the call graph for this function:

◆ obsspace_put_real64_f()

void ioda::obsspace_put_real64_f ( ObsSpace obss,
const char *  group,
const char *  vname,
const std::size_t &  length,
double *  vec 
)

Definition at line 183 of file obsspace_f.cc.

Here is the call graph for this function:

◆ StringVectorToCharArray()

void ioda::StringVectorToCharArray ( const std::vector< std::string > &  StringVector,
const std::vector< std::size_t > &  CharShape,
char *  CharData 
)

Definition at line 67 of file IodaUtils.cc.

Here is the caller graph for this function:

◆ TypeIdName()

std::string ioda::TypeIdName ( const std::type_info &  TypeId)

Definition at line 86 of file IodaUtils.cc.

Here is the caller graph for this function:

Variable Documentation

◆ IODAIO_DEFAULT_FRAME_SIZE

const std::size_t ioda::IODAIO_DEFAULT_FRAME_SIZE = 10000

Constant to be used for default maximum frame size.

Definition at line 20 of file IodaIOfactory.h.