Implementation of ObsFrameWrite class. More...

#include <ObsFrameWrite.h>

Inheritance diagram for ioda::ObsFrameWrite:

[legend]

Collaboration diagram for ioda::ObsFrameWrite:

[legend]

Public Member Functions
	ObsFrameWrite (const ObsSpaceParameters &params)

	~ObsFrameWrite ()

void	frameInit (const VarNameObjectList &varList, const VarNameObjectList &dimVarList, const VarDimMap &varDimMap, const Dimensions_t maxVarSize) override
	initialize for walking through the frames More...

void	frameNext (const VarNameObjectList &varList) override
	move to the next frame More...

bool	frameAvailable () override
	true if a frame is available (not past end of frames) More...

Dimensions_t	frameStart () override
	return current frame starting index More...

Dimensions_t	frameCount (const std::string &varName) override
	return current frame count for variable More...

void	writeFrameVar (const std::string &varName, const std::vector< int > &varData)
	write a frame variable More...

void	writeFrameVar (const std::string &varName, const std::vector< float > &varData)

void	writeFrameVar (const std::string &varName, const std::vector< std::string > &varData)

Public Member Functions inherited from ioda::ObsFrame
	ObsFrame (const ObsSpaceParameters &params)

	~ObsFrame ()

Dimensions_t	ioMaxVarSize () const
	return number of maximum variable size (along first dimension) from ObsIo More...

Dimensions_t	ioNumLocs () const
	return number of locations from ObsIo More...

Dimensions_t	ioNumVars () const
	return number of regular variables from ObsIo More...

Dimensions_t	ioNumDimVars () const
	return number of dimension scale variables from ObsIo More...

Has_Variables &	vars () const
	return variables container from ObsIo More...

Has_Attributes &	atts () const
	return attributes container from ObsIo More...

const VarNameObjectList &	ioVarList () const
	return list of regular variables from ObsIo More...

const VarNameObjectList &	ioDimVarList () const
	return list of dimension scale variables from ObsIo More...

VarDimMap	ioVarDimMap () const
	return map from variables to their attached dimension scales More...

void	ioUpdateVarDimInfo () const
	update variable, dimension info in the ObsIo object More...

bool	ioIsVarDimByNlocs (const std::string &varName) const
	return true if variable is dimensioned by nlocs More...

virtual std::size_t	frameNumLocs () const
	return number of locations More...

virtual std::size_t	frameNumRecs () const
	return number of records More...

Dimensions_t	globalNumLocs () const
	return number of locations that were selected from ObsIo More...

Dimensions_t	globalNumLocsOutsideTimeWindow () const
	return number of locations from obs source that were outside the time window More...

virtual std::vector< std::size_t >	index () const
	return list of indices indicating which locations were selected from ObsIo More...

virtual std::vector< std::size_t >	recnums () const
	return list of record numbers from ObsIo More...

virtual void	frameInit ()
	initialize frame for a read frame object More...

virtual void	frameNext ()
	move to the next frame for a read frame object More...

virtual Dimensions_t	adjNlocsFrameStart () const
	return adjusted nlocs frame start More...

virtual Dimensions_t	adjNlocsFrameCount () const
	return adjusted nlocs frame count More...

Selection	createMemSelection (const std::vector< Dimensions_t > &varShape, const Dimensions_t frameCount)
	create selection object for accessing a memory buffer More...

Selection	createEntireFrameSelection (const std::vector< Dimensions_t > &varShape, const Dimensions_t frameCount)
	create selection object for accessing the entire frame variable More...

Selection	createVarSelection (const std::vector< Dimensions_t > &varShape, const Dimensions_t frameStart, const Dimensions_t frameCount)
	create selection object for accessing a frame from a whole variable More...

Static Public Member Functions
static const std::string	classname ()
	classname method for object counter More...

Private Member Functions
void	copyObsIoDimCoords (const Has_Variables &srcVarContainer, Has_Variables &destVarContainer, const VarNameObjectList &dimVarList)
	copy dimension coordinate values from the frame to the ObsIo backend More...

void	createObsIoVariables (const Has_Variables &srcVarContainer, Has_Variables &destVarContainer, const VarDimMap &dimsAttachedToVars)
	create set of variables from source variables and lists in the ObsIo backend More...

void	createFrameSelection (const std::string &varName, Selection &feSelect, Selection &beSelect)
	set up frontend and backend selection objects for the given variable More...

void	print (std::ostream &os) const override
	print routine for oops::Printable base class More...

template<typename DataType >
void	writeFrameVarHelper (const std::string &varName, const std::vector< DataType > &varData)
	write variable data into frame helper function More...

Additional Inherited Members
Protected Member Functions inherited from ioda::ObsFrame
Selection	createObsIoSelection (const std::vector< Dimensions_t > &varShape, const Dimensions_t frameStart, const Dimensions_t frameCount)
	create selection object for accessing an ObsIo variable More...

void	createFrameFromObsGroup (const VarNameObjectList &varList, const VarNameObjectList &dimVarList, const VarDimMap &varDimMap)
	create a frame object based on dimensions and variables from a source ObsGroup More...

Protected Attributes inherited from ioda::ObsFrame
std::shared_ptr< ObsIo >	obs_io_
	ObsIo object. More...

ObsGroup	obs_frame_
	ObsGroup object (temporary storage for a single frame) More...

Dimensions_t	nrecs_
	number of records from source (file or generator) More...

Dimensions_t	nlocs_
	number of locations from source (file or generator) More...

Dimensions_t	gnlocs_
	total number of locations from source (file or generator) that were selected after the timing window filtering More...

Dimensions_t	gnlocs_outside_timewindow_
	number of nlocs from the file (gnlocs) that are outside the time window More...

ObsSpaceParameters	params_
	ObsIo parameter specs. More...

Dimensions_t	max_frame_size_
	maximum frame size More...

Dimensions_t	max_var_size_
	maximum variable size More...

Dimensions_t	frame_start_
	current frame starting index More...

Detailed Description

Implementation of ObsFrameWrite class.

This class manages one frame of obs data (subset of locations) when writing data to an ObsIo object. Currently, this is simply a transfer of data, but in the future this will also manage stitching back the data from multiple MPI tasks into one file.

Author: Stephen Herbener (JCSDA)

Definition at line 30 of file src/io/ObsFrameWrite.h.

Constructor & Destructor Documentation

◆ ObsFrameWrite()

ioda::ObsFrameWrite::ObsFrameWrite ( const ObsSpaceParameters & params )

explicit

Definition at line 19 of file ObsFrameWrite.cc.

Here is the call graph for this function:

◆ ~ObsFrameWrite()

ioda::ObsFrameWrite::~ObsFrameWrite ( )

Definition at line 27 of file ObsFrameWrite.cc.

Member Function Documentation

◆ classname()

static const std::string ioda::ObsFrameWrite::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 37 of file src/io/ObsFrameWrite.h.

◆ copyObsIoDimCoords()

void ioda::ObsFrameWrite::copyObsIoDimCoords	(	const Has_Variables &	srcVarContainer,
		Has_Variables &	destVarContainer,
		const VarNameObjectList &	dimVarList
	)

private

copy dimension coordinate values from the frame to the ObsIo backend

Parameters

srcVarContainer	Has_Variables object from source
destVarContainer	Has_Variables object from destination
dimVarList	Map containing list of dimension variables

Definition at line 128 of file ObsFrameWrite.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFrameSelection()

void ioda::ObsFrameWrite::createFrameSelection	(	const std::string &	varName,
		Selection &	feSelect,
		Selection &	beSelect
	)

private

set up frontend and backend selection objects for the given variable

Parameters

varName	ObsGroup variable name
feSelect	Front end selection object
beSelect	Back end selection object

Definition at line 209 of file ObsFrameWrite.cc.

Here is the call graph for this function:

◆ createObsIoVariables()

void ioda::ObsFrameWrite::createObsIoVariables	(	const Has_Variables &	srcVarContainer,
		Has_Variables &	destVarContainer,
		const VarDimMap &	dimsAttachedToVars
	)

private

create set of variables from source variables and lists in the ObsIo backend

Parameters

srcVarContainer	Has_Variables object from source
destVarContainer	Has_Variables object from destination
dimsAttachedToVars	Map containing list of attached dims for each variable

Definition at line 161 of file ObsFrameWrite.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ frameAvailable()

bool ioda::ObsFrameWrite::frameAvailable ( )

overridevirtual

true if a frame is available (not past end of frames)

Implements ioda::ObsFrame.

Definition at line 88 of file ObsFrameWrite.cc.

Here is the caller graph for this function:

◆ frameCount()

Dimensions_t ioda::ObsFrameWrite::frameCount ( const std::string & varName )

overridevirtual

return current frame count for variable

Variables can be of different sizes so it's possible that the frame has moved past the end of some variables but not so for other variables. When the frame is past the end of the given variable, this routine returns a zero to indicate that we're done with this variable.

Parameters

varName variable name

Implements ioda::ObsFrame.

Definition at line 98 of file ObsFrameWrite.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ frameInit()

void ioda::ObsFrameWrite::frameInit	(	const VarNameObjectList &	varList,
		const VarNameObjectList &	dimVarList,
		const VarDimMap &	varDimMap,
		const Dimensions_t	maxVarSize
	)

overridevirtual

initialize for walking through the frames

Parameters

varList	source ObsGroup list of regular variables
dimVarList	source ObsGroup list of dimension variable names
varDimMap	source ObsGroup map showing variables with associated dimensions
maxVarSize	source ObsGroup maximum variable size along the first dimension

Reimplemented from ioda::ObsFrame.

Definition at line 30 of file ObsFrameWrite.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ frameNext()

void ioda::ObsFrameWrite::frameNext ( const VarNameObjectList & varList )

overridevirtual

move to the next frame

Reimplemented from ioda::ObsFrame.

Definition at line 47 of file ObsFrameWrite.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ frameStart()

Dimensions_t ioda::ObsFrameWrite::frameStart ( )

overridevirtual

return current frame starting index

Parameters

varName name of variable

Implements ioda::ObsFrame.

Definition at line 93 of file ObsFrameWrite.cc.

Here is the caller graph for this function:

◆ print()

void ioda::ObsFrameWrite::print ( std::ostream & os ) const

overrideprivatevirtual

print routine for oops::Printable base class

Parameters

ostream output stream

Implements ioda::ObsFrame.

Definition at line 244 of file ObsFrameWrite.cc.

◆ writeFrameVar() [1/3]

void ioda::ObsFrameWrite::writeFrameVar	(	const std::string &	varName,
		const std::vector< float > &	varData
	)

Definition at line 116 of file ObsFrameWrite.cc.

◆ writeFrameVar() [2/3]

void ioda::ObsFrameWrite::writeFrameVar	(	const std::string &	varName,
		const std::vector< int > &	varData
	)

write a frame variable

This function requires the caller to allocate the proper amount of memory for the intput vector varData. The following signatures are for different variable data types.

Parameters

varName	variable name
varData	varible data

Definition at line 112 of file ObsFrameWrite.cc.

Here is the caller graph for this function:

◆ writeFrameVar() [3/3]

void ioda::ObsFrameWrite::writeFrameVar	(	const std::string &	varName,
		const std::vector< std::string > &	varData
	)

Definition at line 120 of file ObsFrameWrite.cc.

◆ writeFrameVarHelper()

template<typename DataType >

void ioda::ObsFrameWrite::writeFrameVarHelper	(	const std::string &	varName,
		const std::vector< DataType > &	varData
	)

inlineprivate

write variable data into frame helper function

Parameters

varName	variable name
varData	varible data

Definition at line 119 of file src/io/ObsFrameWrite.h.

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ObsFrameWrite()

◆ ~ObsFrameWrite()

Member Function Documentation

◆ classname()

◆ copyObsIoDimCoords()

◆ createFrameSelection()

◆ createObsIoVariables()

◆ frameAvailable()

◆ frameCount()

◆ frameInit()

◆ frameNext()

◆ frameStart()

◆ print()

◆ writeFrameVar() [1/3]

◆ writeFrameVar() [2/3]

◆ writeFrameVar() [3/3]

◆ writeFrameVarHelper()