The isce3::io namespace. More...

Classes
struct	findMeta

struct	float16

class	IDataSet
	Our derived dataset structure that includes utility functions. More...

class	IGroup

class	IH5Dataset
	IH5 interface to GDAL Dataset to allow read/write to HDF5 datasets from ISCE. More...

class	IH5File

class	IH5RasterBand
	Raster band of an IH5 Dataset derived from GDALPamRasterBand. More...

struct	n1bit

struct	n2bit

class	Raster
	Data structure meant to handle Raster I/O operations. More...

Typedefs
typedef struct isce3::io::float16	float16

typedef struct isce3::io::n1bit	n1bit

typedef struct isce3::io::n2bit	n2bit

Functions
H5::DataType	IH5GetNativeType (H5::DataType &intype)

void	GDALRegister_IH5 ()
	Function to register driver with GDAL.

template<typename H5obj>
bool	exists (H5obj &h5obj, const std::string &name, const std::string start=".", const std::string type="BOTH")
	Check existence of a dataset or group.

template<typename H5obj, typename T>
void	loadFromH5 (H5obj &h5obj, const std::string &datasetPath, T &v)
	Load scalar dataset from HDF5 file.

template<typename H5obj, typename T>
void	loadFromH5 (H5obj &h5obj, const std::string &datasetPath, std::vector< T > &v)
	Load vector dataset from HDF5 file.

template<typename H5obj, typename T>
void	loadFromH5 (H5obj &h5obj, const std::string &datasetPath, std::valarray< T > &v)
	Load valarray dataset from HDF5 file.

template<typename H5obj, typename T>
void	loadFromH5 (H5obj &h5obj, const std::string &datasetPath, isce3::core::Matrix< T > &m)
	Load Matrix dataset from HDF5 file.

template<typename H5obj, typename T>
void	saveToH5 (H5obj &h5obj, const std::string &datasetPath, const T &val, const std::string &units="")
	Write scalar dataset to HDF5 file.

template<typename H5obj, typename T>
void	saveToH5 (H5obj &h5obj, const std::string &datasetPath, const std::vector< T > &v, const std::string &units="")
	Write vector dataset to HDF5 file.

template<typename H5obj, typename T>
void	saveToH5 (H5obj &h5obj, const std::string &datasetPath, const std::valarray< T > &v, const std::string &units="")
	Write valarray dataset to HDF5 file.

template<typename H5obj, typename T, size_t S>
void	saveToH5 (H5obj &h5obj, const std::string &datasetPath, const std::vector< T > &v, std::array< size_t, S > dims, const std::string &units="")
	Write vector dataset with dimensions to HDF5 file.

template<typename H5obj, typename T, size_t S>
void	saveToH5 (H5obj &h5obj, const std::string &datasetPath, const std::valarray< T > &v, std::array< size_t, S > dims, const std::string &units="")
	Write valarray dataset with dimensions to HDF5 file.

template<typename H5obj, typename T>
void	saveToH5 (H5obj &h5obj, const std::string &datasetPath, const isce3::core::Matrix< T > &mat, const std::string &units="")
	Write Matrix dataset to HDF5 file.

template<typename H5obj>
std::vector< int >	getImageDims (H5obj &h5obj, const std::string &datasetPath)
	Get dimensions of complex imagery from HDF5 file.

template<typename H5obj>
isce3::core::DateTime	getRefEpoch (H5obj &h5obj, const std::string &datasetPath)
	Parse time units in a dataset attribute to get a reference epoch.

template<typename H5obj>
void	setRefEpoch (H5obj &h5obj, const std::string &datasetPath, const isce3::core::DateTime &refEpoch, const bool ensureEpochIntegerSeconds=true)
	Save reference epoch DateTime as an attribute.

Variables
const std::string	defaultGDALDriver = "VRT"
	Default GDAL driver used by Raster for creation.

const GDALDataType	defaultGDALDataType = GDT_Float32
	Default GDAL data type used by Raster for creation.

template<typename T>
auto	asGDT = gdal::detail::Type2GDALDataType<T>::datatype

const hsize_t	chunkSizeX = 128

const hsize_t	chunkSizeY = 128

Detailed Description

The isce3::io namespace.

Function Documentation

◆ exists()

template<typename H5obj>

bool isce3::io::exists	(	H5obj &	h5obj,
		const std::string &	name,
		const std::string	start = ".",
		const std::string	type = "BOTH" )

inline

Check existence of a dataset or group.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	name	H5 path of dataset relative to h5obj.
[in]	start	Relative path from current group/file to start search from.
[in]	type	Type of object to search for. Default: BOTH

◆ getImageDims()

template<typename H5obj>

std::vector< int > isce3::io::getImageDims	(	H5obj &	h5obj,
		const std::string &	datasetPath )

inline

Get dimensions of complex imagery from HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of image dataset relative to h5obj.

◆ getRefEpoch()

template<typename H5obj>

isce3::core::DateTime isce3::io::getRefEpoch	(	H5obj &	h5obj,
		const std::string &	datasetPath )

inline

Parse time units in a dataset attribute to get a reference epoch.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[out]	epoch	isce3::core::DateTime of reference epoch.

Exceptions

InvalidArgument if no matching iso8601 string is found.

◆ loadFromH5() [1/4]

template<typename H5obj, typename T>

void isce3::io::loadFromH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		isce3::core::Matrix< T > &	m )

inline

Load Matrix dataset from HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	m	Matrix to store dataset.

◆ loadFromH5() [2/4]

template<typename H5obj, typename T>

void isce3::io::loadFromH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		std::valarray< T > &	v )

inline

Load valarray dataset from HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	v	Valarray to store dataset.

◆ loadFromH5() [3/4]

template<typename H5obj, typename T>

void isce3::io::loadFromH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		std::vector< T > &	v )

inline

Load vector dataset from HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	v	Vector to store dataset.

◆ loadFromH5() [4/4]

template<typename H5obj, typename T>

void isce3::io::loadFromH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		T &	v )

inline

Load scalar dataset from HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	v	Scalar return value.

◆ saveToH5() [1/6]

template<typename H5obj, typename T>

void isce3::io::saveToH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		const isce3::core::Matrix< T > &	mat,
		const std::string &	units = "" )

inline

Write Matrix dataset to HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	mat	Matrix to write.
[in]	units	Units of dataset.

◆ saveToH5() [2/6]

template<typename H5obj, typename T>

void isce3::io::saveToH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		const std::valarray< T > &	v,
		const std::string &	units = "" )

inline

Write valarray dataset to HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	v	Valarray to write.
[in]	units	Units of dataset.

◆ saveToH5() [3/6]

template<typename H5obj, typename T, size_t S>

void isce3::io::saveToH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		const std::valarray< T > &	v,
		std::array< size_t, S >	dims,
		const std::string &	units = "" )

inline

Write valarray dataset with dimensions to HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	v	Valarray to write.
[in]	units	Units of dataset.

◆ saveToH5() [4/6]

template<typename H5obj, typename T>

void isce3::io::saveToH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		const std::vector< T > &	v,
		const std::string &	units = "" )

inline

Write vector dataset to HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	v	Vector to write.
[in]	units	Units of dataset.

◆ saveToH5() [5/6]

template<typename H5obj, typename T, size_t S>

void isce3::io::saveToH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		const std::vector< T > &	v,
		std::array< size_t, S >	dims,
		const std::string &	units = "" )

inline

Write vector dataset with dimensions to HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	v	Vector to write.
[in]	units	Units of dataset.

◆ saveToH5() [6/6]

template<typename H5obj, typename T>

void isce3::io::saveToH5	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		const T &	val,
		const std::string &	units = "" )

inline

Write scalar dataset to HDF5 file.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	val	Value to write
[in]	units	Units of dataset.

◆ setRefEpoch()

template<typename H5obj>

void isce3::io::setRefEpoch	(	H5obj &	h5obj,
		const std::string &	datasetPath,
		const isce3::core::DateTime &	refEpoch,
		const bool	ensureEpochIntegerSeconds = true )

inline

Save reference epoch DateTime as an attribute.

Parameters

[in]	h5obj	HDF5 file or group object.
[in]	datasetPath	H5 path of dataset relative to h5obj.
[in]	epoch	isce3::core::DateTime of reference epoch.
[in]	ensureEpochIntegerSeconds	Ensure that the orbit reference epoch has integer seconds precision (NISAR specs requirement)

Classes

Typedefs

Functions

Variables

Detailed Description

Function Documentation

◆ exists()

◆ getImageDims()

◆ getRefEpoch()

◆ loadFromH5() [1/4]

◆ loadFromH5() [2/4]

◆ loadFromH5() [3/4]

◆ loadFromH5() [4/4]

◆ saveToH5() [1/6]

◆ saveToH5() [2/6]

◆ saveToH5() [3/6]

◆ saveToH5() [4/6]

◆ saveToH5() [5/6]

◆ saveToH5() [6/6]

◆ setRefEpoch()