The isce3::product namespace. More...

Classes
class	GeoGridParameters

class	GeoGridProduct
	GeoGridProduct class declaration. More...

class	Grid
	A class for representing Grid metadata originally based on NISAR L2 products. More...

class	Metadata

class	ProcessingInformation

class	RadarGridParameters

class	RadarGridProduct
	RadarGridProduct class declaration. More...

class	SubSwaths
	Sub-swaths metadata of a SAR dataset. More...

class	Swath

Functions
std::string	to_string (const GeoGridParameters &geogrid)

std::ostream &	operator<< (std::ostream &out, const GeoGridParameters &geogrid)

GeoGridParameters	bbox2GeoGrid (const isce3::product::RadarGridParameters &radar_grid, const isce3::core::Orbit &orbit, const isce3::core::LUT2d< double > &doppler, double spacing_x, double spacing_y, int epsg, double min_height=isce3::core::GLOBAL_MIN_HEIGHT, double max_height=isce3::core::GLOBAL_MAX_HEIGHT, const double margin=0.0, const int points_per_edge=11, const double threshold=isce3::geometry::detail::DEFAULT_TOL_HEIGHT, const double height_threshold=100)
	Function to create a GeoGridParameters object by using DEM spacing and EPSG, and by estimating the bounding box of the input radar grid.

GeoGridParameters	bbox2GeoGridScaled (const isce3::product::RadarGridParameters &radar_grid, const isce3::core::Orbit &orbit, const isce3::core::LUT2d< double > &doppler, const isce3::io::Raster &dem_raster, double spacing_scale=1.0, double min_height=isce3::core::GLOBAL_MIN_HEIGHT, double max_height=isce3::core::GLOBAL_MAX_HEIGHT, const double margin=0.0, const int points_per_edge=11, const double threshold=isce3::geometry::detail::DEFAULT_TOL_HEIGHT, const double height_threshold=100)
	Function to create a GeoGridParameters object by using DEM spacing and EPSG, and by estimating the bounding box of the input radar grid.

std::vector< std::string >	findGroupPath (isce3::io::IGroup &group, const std::string &group_name)
	Return the path to each child group of `group` that ends with the substring `group_name`.

void	setImageMetadataGroupStr (isce3::io::IH5File &file, std::string &base_dir, isce3::io::IGroup &base_group, std::vector< std::string > &key_vector, std::string &image_group_str, std::string &metadata_group_str)
	Return grids or swaths group paths within the base_group.

void	loadFromH5 (isce3::io::IGroup &group, ProcessingInformation &proc)
	Load ProcessingInformation from HDF5.

void	loadFromH5 (isce3::io::IGroup &group, Swath &swath, char freq)
	Load Swath from HDF5.

void	loadFromH5 (isce3::io::IGroup &group, std::map< char, Swath > &swaths)
	Load multiple swaths from HDF5.

void	populateGridSwathParameterFromH5 (isce3::io::IGroup &group, Grid &grid, const char freq)
	Populate swath-related parameters of the Grid object from HDF5.

void	loadFromH5 (isce3::io::IGroup &group, Grid &grid, const char freq)
	Load Grid from HDF5.

void	loadFromH5 (isce3::io::IGroup &group, std::map< char, Grid > &grids)
	Load multiple grids from HDF5.

void	loadFromH5 (isce3::io::IGroup &group, Metadata &meta, const std::string &product_level)
	Load Metadata parameters from HDF5.

Detailed Description

The isce3::product namespace.

Function Documentation

◆ bbox2GeoGrid()

GeoGridParameters isce3::product::bbox2GeoGrid	(	const isce3::product::RadarGridParameters &	radar_grid,
		const isce3::core::Orbit &	orbit,
		const isce3::core::LUT2d< double > &	doppler,
		double	spacing_x,
		double	spacing_y,
		int	epsg,
		double	min_height = isce3::core::GLOBAL_MIN_HEIGHT,
		double	max_height = isce3::core::GLOBAL_MAX_HEIGHT,
		const double	margin = 0.0,
		const int	points_per_edge = 11,
		const double	threshold = isce3::geometry::detail::DEFAULT_TOL_HEIGHT,
		const double	height_threshold = 100 )

Function to create a GeoGridParameters object by using DEM spacing and EPSG, and by estimating the bounding box of the input radar grid.

Parameters

[in]	radar_grid	Input RadarGridParameters
[in]	orbit	Input orbit
[in]	doppler	Input doppler
[in]	dx	X spacing for geocoded grid
[in]	dy	Y spacing for geocoded grid
[in]	epsg	EPSG code
[in]	min_height	Height lower bound
[in]	max_height	Height upper bound
[in]	margin	Amount to pad estimated bounding box. In decimal degrees.
[in]	point_per_edge	Number of points to use on each side of radar grid.
[in]	threshold	Height threshold (m) for rdr2geo convergence.
[in]	height_threshold	Height threshold for convergence.

◆ bbox2GeoGridScaled()

GeoGridParameters isce3::product::bbox2GeoGridScaled	(	const isce3::product::RadarGridParameters &	radar_grid,
		const isce3::core::Orbit &	orbit,
		const isce3::core::LUT2d< double > &	doppler,
		const isce3::io::Raster &	dem_raster,
		double	spacing_scale = 1.0,
		double	min_height = isce3::core::GLOBAL_MIN_HEIGHT,
		double	max_height = isce3::core::GLOBAL_MAX_HEIGHT,
		const double	margin = 0.0,
		const int	points_per_edge = 11,
		const double	threshold = isce3::geometry::detail::DEFAULT_TOL_HEIGHT,
		const double	height_threshold = 100 )

Function to create a GeoGridParameters object by using DEM spacing and EPSG, and by estimating the bounding box of the input radar grid.

Spacing can be adjusted by scalar.

Parameters

[in]	radar_grid	Input RadarGridParameters
[in]	orbit	Input orbit
[in]	doppler	Input doppler
[in]	dem_raster	DEM from which EPSG and spacing is extracted
[in]	spacing_scale	Scalar increase or decrease geogrid spacing
[in]	min_height	Height lower bound
[in]	max_height	Height upper bound
[in]	margin	Amount to pad estimated bounding box. In decimal degrees.
[in]	point_per_edge	Number of points to use on each side of radar grid.
[in]	threshold	Height threshold (m) for rdr2geo convergence.
[in]	height_threshold	Height threshold for convergence.

◆ findGroupPath()

std::vector< std::string > isce3::product::findGroupPath	(	isce3::io::IGroup &	group,
		const std::string &	group_name )

Return the path to each child group of group that ends with the substring group_name.

Find unique group path excluding repeated occurrences.

Return the path to each child group of group that ends with the substring group_name.

Parameters

[in]	group	Parent group
[in]	group_name	Search string

Returns: List of child group paths

◆ loadFromH5() [1/6]

void isce3::product::loadFromH5	(	isce3::io::IGroup &	group,
		Grid &	grid,
		const char	freq )

inline

Load Grid from HDF5.

Parameters

[in]	group	HDF5 group object.
[in]	grid	Grid object to be configured.
[in]	freq	Frequency designation (e.g., A or B)

◆ loadFromH5() [2/6]

void isce3::product::loadFromH5	(	isce3::io::IGroup &	group,
		Metadata &	meta,
		const std::string &	product_level )

inline

Load Metadata parameters from HDF5.

Parameters

[in]	group	HDF5 group object.
[in]	meta	Metadata object to be configured.

◆ loadFromH5() [3/6]

void isce3::product::loadFromH5	(	isce3::io::IGroup &	group,
		ProcessingInformation &	proc )

inline

Load ProcessingInformation from HDF5.

Parameters

[in]	group	HDF5 group object.
[in]	proc	ProcessingInformation object to be configured.

◆ loadFromH5() [4/6]

void isce3::product::loadFromH5	(	isce3::io::IGroup &	group,
		std::map< char, Grid > &	grids )

inline

Load multiple grids from HDF5.

Parameters

[in]	group	HDF5 group object.
[in]	grids	Map of Grids to be configured.

◆ loadFromH5() [5/6]

void isce3::product::loadFromH5	(	isce3::io::IGroup &	group,
		std::map< char, Swath > &	swaths )

inline

Load multiple swaths from HDF5.

Parameters

[in]	group	HDF5 group object.
[in]	swaths	Map of Swaths to be configured.

◆ loadFromH5() [6/6]

void isce3::product::loadFromH5	(	isce3::io::IGroup &	group,
		Swath &	swath,
		char	freq )

inline

Load Swath from HDF5.

Parameters

[in]	group	HDF5 group object.
[in]	swath	Swath object to be configured.
[in]	freq	Frequency designation (e.g., A or B)

◆ populateGridSwathParameterFromH5()

void isce3::product::populateGridSwathParameterFromH5	(	isce3::io::IGroup &	group,
		Grid &	grid,
		const char	freq )

inline

Populate swath-related parameters of the Grid object from HDF5.

Parameters

[in]	group	HDF5 group object.
[in]	grid	Grid object to be configured.
[in]	freq	Frequency designation (e.g., A or B)

◆ setImageMetadataGroupStr()

void isce3::product::setImageMetadataGroupStr	(	isce3::io::IH5File &	file,
		std::string &	base_dir,
		isce3::io::IGroup &	base_group,
		std::vector< std::string > &	key_vector,
		std::string &	image_group_str,
		std::string &	metadata_group_str )

Return grids or swaths group paths within the base_group.

Start by assigning an empty string to image_group_str in case grids and swaths group are not found.

Parameters

[in]	file
[in]	base_dir	Path to `base_group` object (e.g. '/science/')
[in]	base_group	Base group
[in]	key_vector	Vector containing possible image groups (e.g., 'swaths', 'grids', or both) to look for
[out]	image_group_str	Path to first image group found containing one of the `key_vector` keys (e.g., '/science/LSAR/RSLC/swaths')
[in]	metadata_group_str	Path to first metadata group found by substituting `key` with `metadata` in `image_group_str` (e.g., '/science/LSAR/RSLC/metadata')

Classes

Functions

Detailed Description

Function Documentation

◆ bbox2GeoGrid()

◆ bbox2GeoGridScaled()

◆ findGroupPath()

◆ loadFromH5() [1/6]

◆ loadFromH5() [2/6]

◆ loadFromH5() [3/6]

◆ loadFromH5() [4/6]

◆ loadFromH5() [5/6]

◆ loadFromH5() [6/6]

◆ populateGridSwathParameterFromH5()

◆ setImageMetadataGroupStr()