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

#include <Raster.h>

Public Member Functions
	Raster (const std::string &fname, GDALAccess access=GA_ReadOnly)
	Constructor to open an existing file with specified Access mode - defaults to read-only.

	Raster (const std::string &fname, size_t width, size_t length, size_t numBands, GDALDataType dtype=isce3::io::defaultGDALDataType, const std::string &driverName=isce3::io::defaultGDALDriver)
	Constructor to create a dataset.

	Raster (const std::string &fname, size_t width, size_t length, GDALDataType dtype=isce3::io::defaultGDALDataType)
	Constructor to create a 1 band dataset with default Driver.

template<typename T>
	Raster (Eigen::PlainObjectBase< T > &view)

template<typename Derived>
	Raster (Eigen::Block< Derived > &view)

	Raster (const std::string &fname, const Raster &rast)
	Create new raster object like another.

template<typename T>
	Raster (const std::string &fname, const std::vector< T > &buffer, size_t length)

template<typename T>
	Raster (const std::string &fname, const std::valarray< T > &buffer, size_t length)

	Raster (const std::string &fname, const std::vector< Raster > &rastVec)
	Create a VRT raster dataset with collection of bands from Rasters.

	Raster (isce3::io::gdal::Raster &)
	Create legacy raster reference to isce3::io::gdal::Raster.

	Raster (const Raster &)
	Copy constructor.

	Raster (GDALDataset *inputDataset, bool owner=true)
	Constructor from an existing GDAL Dataset.

void	initFromPointer (void *ptr, GDALDataType dtype, size_t width, size_t length, size_t pixeloffset, size_t lineoffset)
	Construct dataset for a 1 band dataset with raw pointer, dimensions and offsets.

	~Raster ()
	Destructor.

Raster &	operator= (const Raster &)
	Assignment operator.

size_t	length () const
	Length getter.

size_t	width () const
	Width getter.

size_t	numBands () const
	Number of bands getter.

GDALAccess	access () const
	Access mode getter.

GDALDataset *	dataset () const
	GDALDataset pointer getter.

void	dataset (GDALDataset *ds)
	GDALDataset pointer setter.

bool	dataset_owner () const
	GDALDataset owner getter.

GDALDataType	dtype (const size_t band=1) const
	Return GDALDatatype of specified band.

bool	match (const Raster &rast) const
	Check dimensions compatibility with another raster.

void	open (const std::string &fname, GDALAccess access)
	Open file with GDAL.

void	addRasterToVRT (const isce3::io::Raster &rast)
	Add a raster to VRT.

void	addBandToVRT (GDALRasterBand *inBand)
	Add a GDALRasterBand to VRT.

void	addRawBandToVRT (const std::string &fname, GDALDataType dtype)
	Add a raw data band to VRT.

template<typename T>
void	getSetValue (T &buffer, size_t xidz, size_t yidx, size_t band, GDALRWFlag)
	Get/Set single value for given band.

template<typename T>
void	getValue (T &buffer, size_t xidx, size_t yidx, size_t band=1)

template<typename T>
void	setValue (T &buffer, size_t xidx, size_t yidx, size_t band=1)

template<typename T>
void	getSetLine (T *buffer, size_t yidx, size_t iowidth, size_t band, GDALRWFlag iodir)
	Get/Set line in a band from raw pointer.

template<typename T>
void	getLine (T *buffer, size_t yidx, size_t iowidth, size_t band=1)
	Read one line of data from given band to buffer, vector, or valarray.

template<typename T>
void	getLine (std::vector< T > &vec, size_t yidx, size_t band=1)

template<typename T>
void	getLine (std::valarray< T > &arr, size_t yidx, size_t band=1)

template<typename T>
void	setLine (T *buffer, size_t yidx, size_t iowidth, size_t band=1)
	Write one line of data from buffer, vector, or valarray to given band.

template<typename T>
void	setLine (std::vector< T > &vec, size_t yidx, size_t band=1)

template<typename T>
void	setLine (std::valarray< T > &arr, size_t yidx, size_t band=1)

template<typename T>
void	getSetBlock (T *buffer, size_t xidx, size_t yidx, size_t iowidth, size_t iolength, size_t band, GDALRWFlag iodir)
	Get/Set block in band from raw pointer.

template<typename T>
void	getBlock (T *buffer, size_t xidx, size_t yidx, size_t iowidth, size_t iolength, size_t band=1)
	Read block of data from given band to buffer, vector, or valarray.

template<typename T>
void	getBlock (std::vector< T > &vec, size_t xidx, size_t yidx, size_t iowidth, size_t iolength, size_t band=1)

template<typename T>
void	getBlock (std::valarray< T > &arr, size_t xidx, size_t yidx, size_t iowidth, size_t iolength, size_t band=1)

template<typename T>
void	getBlock (isce3::core::Matrix< T > &mat, size_t xidx, size_t yidx, size_t band=1)
	Read/write block of data from given band to/from Matrix<T>

template<typename T>
void	getBlock (isce3::core::EArray2D< T > &mat, size_t xidx, size_t yidx, size_t band=1)
	Read/write block of data from given band to/from EArray2D<T>

template<typename T>
void	getBlock (isce3::core::EMatrix2D< T > &mat, size_t xidx, size_t yidx, size_t band=1)
	Read/write block of data from given band to/from EArray2D<T>

template<typename Derived>
void	getBlock (Eigen::Block< Derived > &block, int xoff, int yoff, int band=1) const

template<typename T>
void	setBlock (T *buffer, size_t xidx, size_t yidx, size_t iowidth, size_t iolength, size_t band=1)
	Write block of data to given band from buffer, vector, or valarray.

template<typename T>
void	setBlock (std::vector< T > &vec, size_t xidx, size_t yidx, size_t iowidth, size_t iolength, size_t band=1)

template<typename T>
void	setBlock (std::valarray< T > &arr, size_t xidx, size_t yidx, size_t iowidth, size_t iolength, size_t band=1)

template<typename T>
void	setBlock (isce3::core::Matrix< T > &mat, size_t xidx, size_t yidx, size_t band=1)

template<typename T>
void	setBlock (isce3::core::EArray2D< T > &mat, size_t xidx, size_t yidx, size_t band=1)

template<typename T>
void	setBlock (isce3::core::EMatrix2D< T > &mat, size_t xidx, size_t yidx, size_t band=1)

template<typename Derived>
void	setBlock (const Eigen::Block< Derived > &block, int xoff, int yoff, int band=1)

int	getEPSG () const
	Return EPSG code corresponding to raster.

int	setEPSG (int code)
	Set EPSG code.

void	setGeoTransform (double *arr)
	Set Raster GeoTransform from buffer, vector, or valarray.

void	setGeoTransform (std::vector< double > &)

void	setGeoTransform (std::valarray< double > &)

void	getGeoTransform (double *) const
	Copy Raster GeoTransform into a buffer, vector, or valarray.

void	getGeoTransform (std::vector< double > &) const

void	getGeoTransform (std::valarray< double > &) const

double	x0 () const
	Return Western Limit of Raster.

double	y0 () const
	Return Northern Limit of Raster.

double	dx () const
	Return EW pixel spacing of Raster.

double	dy () const
	Return NS pixel spacing of Raster.

Detailed Description

Data structure meant to handle Raster I/O operations.

This is currently a thin wrapper over GDAL's Dataset class with some simpler interfaces for I/O. ISCE is expected to only support North-up and West-left oriented rasters.

Constructor & Destructor Documentation

◆ Raster() [1/7]

isce3::io::Raster::Raster	(	const std::string &	fname,
		GDALAccess	access = GA_ReadOnly )

Constructor to open an existing file with specified Access mode - defaults to read-only.

Parameters

[in]	fname	Existing filename
[in]	access	GDAL access mode

Files are opened with GDALOpenShared

◆ Raster() [2/7]

isce3::io::Raster::Raster	(	const std::string &	fname,
		size_t	width,
		size_t	length,
		size_t	numBands,
		GDALDataType	dtype = isce3::io::defaultGDALDataType,
		const std::string &	driverName = isce3::io::defaultGDALDriver )

Constructor to create a dataset.

Parameters

[in]	fname	Filename to create
[in]	width	Width of raster image
[in]	length	Length of raster image
[in]	numBands	Number of bands in raster image
[in]	dtype	GDALDataType associated with dataset
[in]	driverName	GDAL Driver to use

In general, GDAL is used to create dataset. When VRT driver is used, the dataset is interpreted in a special manner - it is assumed that the user expects a flat binary file with a VRT pointing to the data using VRTRawRasterBand

◆ Raster() [3/7]

isce3::io::Raster::Raster	(	const std::string &	fname,
		size_t	width,
		size_t	length,
		GDALDataType	dtype = isce3::io::defaultGDALDataType )

Constructor to create a 1 band dataset with default Driver.

Parameters

[in]	fname	File name to create
[in]	width	Width of raster image
[in]	length	Length of raster image
[in]	dtype	GDALDataType associated with dataset

◆ Raster() [4/7]

isce3::io::Raster::Raster	(	const std::string &	fname,
		const Raster &	rast )

Create new raster object like another.

Parameters

[in]	fname	File name to create
[in]	rast	Reference raster object

◆ Raster() [5/7]

isce3::io::Raster::Raster	(	const std::string &	fname,
		const std::vector< Raster > &	rastVec )

Create a VRT raster dataset with collection of bands from Rasters.

Parameters

[in]	fname	Output VRT filename to create
[in]	rastVec	std::vector of Raster objects

◆ Raster() [6/7]

isce3::io::Raster::Raster ( const Raster & rast )

Copy constructor.

Parameters

[in] rast Source raster.

It increments GDAL's reference counter after weak-copying the pointer

◆ Raster() [7/7]

isce3::io::Raster::Raster	(	GDALDataset *	inputDataset,
		bool	owner = true )

Constructor from an existing GDAL Dataset.

Parameters

[in] inputDataset Pointer to an existing dataset

Member Function Documentation

◆ addBandToVRT()

void isce3::io::Raster::addBandToVRT ( GDALRasterBand * inBand )

inline

Add a GDALRasterBand to VRT.

Parameters

[in] inBand GDALRasterBand pointer

◆ addRasterToVRT()

void isce3::io::Raster::addRasterToVRT ( const isce3::io::Raster & rast )

inline

Add a raster to VRT.

Parameters

[in] rast Input raster dataset

◆ addRawBandToVRT()

void isce3::io::Raster::addRawBandToVRT	(	const std::string &	fname,
		GDALDataType	dtype )

inline

Add a raw data band to VRT.

Parameters

[in]	fname	Raw file name
[in]	dtype	GDALDataType

◆ dataset()

void isce3::io::Raster::dataset ( GDALDataset * ds )

inline

GDALDataset pointer setter.

Parameters

[in] ds GDALDataset pointer

◆ dtype()

GDALDataType isce3::io::Raster::dtype ( const size_t band = 1 ) const

inline

Return GDALDatatype of specified band.

Parameters

[in] band Band number in 1-index

◆ getBlock()

template<typename T>

void isce3::io::Raster::getBlock	(	T *	buffer,
		size_t	xidx,
		size_t	yidx,
		size_t	iowidth,
		size_t	iolength,
		size_t	band = 1 )

Read block of data from given band to buffer, vector, or valarray.

Parameters

[in]	buffer	Raw pointer to buffer
[in]	xidx	Pixel index (0-based)
[in]	yidx	Line index (0-based)
[in]	iowidth	Number of pixels to read
[in]	iolength	Number of lines to read
[in]	band	Band index (1-based)

◆ getEPSG()

int isce3::io::Raster::getEPSG ( ) const

Return EPSG code corresponding to raster.

Uses GDAL's inbuilt OSRFindMatches to determine the EPSG code from the WKT representation of the projection system.

This is designed to work with GDAL 2.3+

◆ getGeoTransform() [1/3]

void isce3::io::Raster::getGeoTransform ( double * arr ) const

inline

Copy Raster GeoTransform into a buffer, vector, or valarray.

Parameters

[in] arr pointer to buffer of 6 double precision numbers

No memory check is performed

◆ getGeoTransform() [2/3]

void isce3::io::Raster::getGeoTransform ( std::valarray< double > & arr ) const

inline

Parameters

[in] arr std::valarray to copy GeoTransform into

◆ getGeoTransform() [3/3]

void isce3::io::Raster::getGeoTransform ( std::vector< double > & arr ) const

inline

Parameters

[in] arr std::vector to copy GeoTransform into

◆ getLine()

template<typename T>

void isce3::io::Raster::getLine	(	T *	buffer,
		size_t	yidx,
		size_t	iowidth,
		size_t	band = 1 )

Read one line of data from given band to buffer, vector, or valarray.

Parameters

[in]	buffer	Raw pointer to buffer
[in]	yidx	Line index (0-based)
[in]	iowidth	Number of samples to read
[in]	band	Band index (1-based)

◆ getSetBlock()

template<typename T>

void isce3::io::Raster::getSetBlock	(	T *	buffer,
		size_t	xidx,
		size_t	yidx,
		size_t	iowidth,
		size_t	iolength,
		size_t	band,
		GDALRWFlag	iodir )

Get/Set block in band from raw pointer.

Parameters

[in]	buffer	Raw pointer for I/O
[in]	xidx	Pixel index (0-based)
[in]	yidx	Line index (0-based)
[in]	iowidth	Number of pixels to read/write
[in]	iolength	Number of lines to read/write

Datatype translation is automatically determined from the type of buffer

◆ getSetLine()

template<typename T>

void isce3::io::Raster::getSetLine	(	T *	buffer,
		size_t	yidx,
		size_t	iowidth,
		size_t	band,
		GDALRWFlag	iodir )

Get/Set line in a band from raw pointer.

Parameters

[in,out]	buffer	Raw pointer to buffer
[in]	xidx	Line location within band (0-based)
[in]	iowidth	Width of I/O buffer
[in]	band	Band index (1-based)
[in]	iodir	GDALRWFlag to indicate read / write

Datatype translation is automatically determined using type of pointer passed

◆ getSetValue()

template<typename T>

void isce3::io::Raster::getSetValue	(	T &	buffer,
		size_t	xidx,
		size_t	yidx,
		size_t	band,
		GDALRWFlag	iodir )

Get/Set single value for given band.

Parameters

[in,out]	buffer	Buffer of type T
[in]	xidx	Pixel index (0-based)
[in]	yidx	Line index (0-based)
[in]	band	Band index (1-based)
[in]	GDALRWFlag

Determines datatype translation to use from the type of buffer passed in

◆ getValue()

template<typename T>

void isce3::io::Raster::getValue	(	T &	buffer,
		size_t	xidx,
		size_t	yidx,
		size_t	band = 1 )

Parameters

[out]	buffer	Buffer to copy data into
[in]	xidx	Pixel index (0-based)
[in]	yidx	Line index (0-based)
[in]	band	Band index (1-based)

◆ match()

bool isce3::io::Raster::match ( const Raster & rast ) const

inline

Check dimensions compatibility with another raster.

Parameters

[in] rast Reference raster to compare against

◆ open()

void isce3::io::Raster::open	(	const std::string &	fname,
		GDALAccess	access = GA_ReadOnly )

inline

Open file with GDAL.

Parameters

[in]	fname	Filename to open
[in]	access	Access mode

◆ setBlock()

template<typename T>

void isce3::io::Raster::setBlock	(	T *	buffer,
		size_t	xidx,
		size_t	yidx,
		size_t	iowidth,
		size_t	iolength,
		size_t	band = 1 )

Write block of data to given band from buffer, vector, or valarray.

Parameters

[in]	buffer	Raw pointer to buffer
[in]	xidx	Pixel index (0-based)
[in]	yidx	Line index (0-based)
[in]	iowidth	Number of pixels to read
[in]	iolength	Number of lines to read
[in]	band	Band index (1-based)

◆ setEPSG()

int isce3::io::Raster::setEPSG ( int epsgcode )

Set EPSG code.

Parameters

[in] epsgcode EPSG code corresponding to projection system

GDAL relies on GDAL_DATA environment variable to interpret these codes. Make sure that these are set.

◆ setGeoTransform() [1/3]

void isce3::io::Raster::setGeoTransform ( double * arr )

inline

Set Raster GeoTransform from buffer, vector, or valarray.

Parameters

[in] arr Array of 6 double precision numbers

No memory check performed for length of array

◆ setGeoTransform() [2/3]

void isce3::io::Raster::setGeoTransform ( std::valarray< double > & arr )

inline

Parameters

[in] arr std::valarray of 6 double precision numbers

◆ setGeoTransform() [3/3]

void isce3::io::Raster::setGeoTransform ( std::vector< double > & arr )

inline

Parameters

[in] arr std::vector of 6 double precision numbers

◆ setLine()

template<typename T>

void isce3::io::Raster::setLine	(	T *	buffer,
		size_t	yidx,
		size_t	iowidth,
		size_t	band = 1 )

Write one line of data from buffer, vector, or valarray to given band.

Parameters

[in]	buffer	Raw pointer to buffer
[in]	yidx	Line index (0-based)
[in]	iowidth	Number of samples to write
[in]	band	Band index (1-based)

◆ setValue()

template<typename T>

void isce3::io::Raster::setValue	(	T &	buffer,
		size_t	xidx,
		size_t	yidx,
		size_t	band = 1 )

Parameters

[in]	buffer	Buffer to copy data from
[in]	xidx	Pixel index (0-based)
[in]	yidx	Line index (0-based)
[in]	band	Band index (1-based)

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

/home/runner/work/isce3/isce3/cxx/isce3/io/Raster.h
/home/runner/work/isce3/isce3/cxx/isce3/io/Raster.cpp
/home/runner/work/isce3/isce3/cxx/isce3/io/Raster.icc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Raster() [1/7]

◆ Raster() [2/7]

◆ Raster() [3/7]

◆ Raster() [4/7]

◆ Raster() [5/7]

◆ Raster() [6/7]

◆ Raster() [7/7]

Member Function Documentation

◆ addBandToVRT()

◆ addRasterToVRT()

◆ addRawBandToVRT()

◆ dataset()

◆ dtype()

◆ getBlock()

◆ getEPSG()

◆ getGeoTransform() [1/3]

◆ getGeoTransform() [2/3]

◆ getGeoTransform() [3/3]

◆ getLine()

◆ getSetBlock()

◆ getSetLine()

◆ getSetValue()

◆ getValue()

◆ match()

◆ open()

◆ setBlock()

◆ setEPSG()

◆ setGeoTransform() [1/3]

◆ setGeoTransform() [2/3]

◆ setGeoTransform() [3/3]

◆ setLine()

◆ setValue()