Namespace for the TerraLib GDAL driver implementation. More...

Classes
class	Band
	This class represents raster band description. More...

class	DataSet
	A GDAL data set gives access to a raster file. More...

class	DataSetsManager
	GDAL data set manager. More...

class	DataSetUseCounter
	GDAL data set use counter. More...

class	DataSource
	A driver to access raster data using the GDAL library. More...

struct	DriverMetadata
	GDAL driver metadata. More...

class	Globals
	An static class with global definitions for the TerraLib GDAL driver. More...

class	Raster
	This class represents Raster data. More...

class	RasterFactory
	This is the concrete factory for GDAL rasters. More...

class	ScopedDataSetHandle
	This encapsulates a GDAL dataSet and closes it when it runs out of scope. It also creates a wrapper to the dataSet in the cases which the file has a RPC metadata. More...

class	Transactor

Typedefs
typedef boost::shared_ptr< DataSet >	DataSetPtr

using	ScopedDataSetHandlePtr = std::unique_ptr< ScopedDataSetHandle >

Functions
te::da::DataSource *	Build (const te::core::URI &uri)

GDALDataset *	CreateRaster (const std::string &name, te::rst::Grid g, const std::vector< te::rst::BandProperty > &bands, const std::map< std::string, std::string > &optParams, const std::map< std::string, std::string > &metaData)
	Creates a raster data using GDAL. More...

GDALDataset *	CreateRaster (te::rst::Grid g, const std::vector< te::rst::BandProperty > &bands, const std::map< std::string, std::string > &optParams, const std::map< std::string, std::string > &metadata)
	Creates a raster data using GDAL. More...

void	GDALErrorHandler (CPLErr eErrClass, int errNo, const char *msg)

TEGDALEXPORT void	GetBandProperties (GDALDataset gds, std::vector< te::rst::BandProperty > &bprops)
	Gets the list of bands definition from a GDAL dataset. More...

te::rst::BandProperty *	GetBandProperty (GDALRasterBand *gband, const unsigned int bandIndex)
	Gets the properties of a single band from a GDAL dataset. More...

bool	GetBands (te::gdal::Raster rst, int multiResLevel, std::vector< te::gdal::Band > &bands)
	Gets the list of bands from a GDAL dataset. More...

void	GetBands (te::gdal::Raster rst, std::vector< te::gdal::Band > &bands)
	Gets the list of bands from a GDAL dataset. More...

std::string	GetDriverName (const std::string &dsName)
	It returns the GDAL driver name associated to a data source name. More...

te::gm::Envelope *	GetExtent (std::string strAccessInfo)
	Gets the extent of a raster data decoded by GDAL. More...

std::multimap< std::string, std::string >	GetGDALAllDriversUCaseExt2DriversMap (const bool creationSupport)
	Returns a map of all GDAL supported Upper-case ( vector and raster ) extensions to their respective driver names. More...

GDALColorInterp	GetGDALColorInterpretation (te::rst::ColorInterp ci)
	It translates a TerraLib ColorInterpretation to a GDAL ColorInterpretation. More...

std::string	GetGDALConnectionInfo (const std::map< std::string, std::string > &connInfo)
	It returns a GDAL connection string from the given map. More...

GDALDataType	GetGDALDataType (int tet)
	It translates a TerraLib DataType to a GDAL DataType. More...

std::map< std::string, DriverMetadata > &	GetGDALDriversMetadata ()
	Returns metadata from all registered GDAL drivers (key: driver name). More...

std::multimap< std::string, std::string >	GetGDALRasterDriversUCaseExt2DriversMap (const bool creationSupport)
	Returns a map of all GDAL supported Upper-case raster extensions to their respective driver names. More...

std::string	GetGDALRessamplingMethod (te::rst::InterpolationMethod interpolationMethod)
	It translates a TerraLib interpolation method into a GDAL ressampling method name string. More...

std::multimap< std::string, std::string >	GetGDALVectorDriversUCaseExt2DriversMap (const bool creationSupport)
	Returns a map of all GDAL supported Upper-case vector extensions to their respective driver names. More...

TEGDALEXPORT te::rst::Grid *	GetGrid (GDALDataset *gds)
	Gets the grid definition from a GDAL dataset. More...

TEGDALEXPORT te::rst::Grid *	GetGrid (GDALDataset *gds, const int multiResLevel)
	Gets the grid definition from a GDAL dataset. More...

bool	GetMetaData (GDALDataset &dataset, std::map< std::string, std::string > &metadata)
	Returns metadata read from the given dataset. More...

std::string	GetParentDataSetName (const std::string &subDataSetName)
	It returns the parent dataset name from a Sub DataSet name. More...

ScopedDataSetHandlePtr	GetRasterHandle (std::string strAccessInfo, te::common::AccessPolicy policy=te::common::RAccess)
	Get a handle to a raster file. More...

te::rst::RasterProperty *	GetRasterProperty (std::string strAccessInfo)
	Gets the complete description from a GDAL dataset. More...

TEGDALEXPORT boost::mutex &	getStaticMutex ()
	Returns a reference to a static mutex initialized when this module is initialized. More...

std::string	GetSubDataSetName (const std::string &name, const std::string &driverName)
	It returns the Sub DataSet name from the given name or the same name. More...

te::rst::ColorInterp	GetTeColorInterpretation (GDALColorInterp gci)
	It translates a GDAL ColorInterpretation to a TerraLib ColorInterpretation. More...

int	GetTeDataType (GDALDataType gt)
	It translates a GDAL DataType to a TerraLib DataType. More...

te::rst::PaletteInterpretation	GetTePaletteInterpretation (GDALPaletteInterp gpi)
	It translates a GDAL Pallete Interpretation to a TerraLib Pallete Interpretation. More...

bool	IsSubDataSet (const std::string &uri)
	Returns true if the given URI is related to a sub-dataset. More...

std::string	MakePGConnectionStr (const te::core::URI &connInfo)
	Returns a PostGIS connection string from the URI connection information. The connection string is to be used as a dataset name in GDAL data model. See also http://trac.osgeo.org/gdal/wiki/frmts_wtkraster.html. More...

TEGDALEXPORT void	Rasterize (std::vector< te::gm::Geometry * > geometries, GDALDataset *outraster)
	Rasterizes a given vector of geometries, using GDALRasterizeGeometries function. More...

bool	RecognizesSRID (unsigned int srid)
	It returns true if GDAL recognizes the given SRS id. More...

bool	ReprojectRaster (te::rst::Raster const const rin, te::rst::Raster rout)
	Reprojects a raster to another SRS. More...

TEGDALEXPORT void	Vectorize (GDALRasterBand band, std::vector< te::gm::Geometry > &geometries)
	Vectorizes a given raster band, using GDALPolygonize function. More...

Detailed Description

Namespace for the TerraLib GDAL driver implementation.

Typedef Documentation

◆ DataSetPtr

typedef boost::shared_ptr<DataSet> te::gdal::DataSetPtr

Definition at line 174 of file DataSet.h.

◆ ScopedDataSetHandlePtr

using te::gdal::ScopedDataSetHandlePtr = typedef std::unique_ptr<ScopedDataSetHandle>

Definition at line 67 of file ScopedDataSetHandle.h.

Function Documentation

◆ Build()

te::da::DataSource* te::gdal::Build ( const te::core::URI & uri )

◆ CreateRaster() [1/2]

GDALDataset* te::gdal::CreateRaster	(	const std::string &	name,
		te::rst::Grid *	g,
		const std::vector< te::rst::BandProperty * > &	bands,
		const std::map< std::string, std::string > &	optParams,
		const std::map< std::string, std::string > &	metaData
	)

Creates a raster data using GDAL.

Parameters

name	The name of the dataset to create. UTF-8 encoded.
g	Raster grid info.
bands	Band info.
optParams	A vector of optional parameters that are valid only for some data formats.
optParams	A vector of optional raster metadata (KEY,VALUE) to be saved (when applicable).

Returns: A pointer to a GDALDataset if it succeeds or a NULL pointer otherwise. Caller is responsible for closing it.

Exceptions

Exception It throws an exception if the raster can not be created.

◆ CreateRaster() [2/2]

GDALDataset* te::gdal::CreateRaster	(	te::rst::Grid *	g,
		const std::vector< te::rst::BandProperty * > &	bands,
		const std::map< std::string, std::string > &	optParams,
		const std::map< std::string, std::string > &	metadata
	)

Creates a raster data using GDAL.

Parameters

g	Raster grid info.
bands	Band info.
optParams	A vector of optional parameters that are valid only for some data formats.
metadadata	Raster metadata in a form [meta data name, value].

Returns: A pointer to a GDALDataset if it succeeds or a NULL pointer otherwise. Caller is responsible for closing it.

Exceptions

Exception It throws an exception if the raster can not be created.

◆ GDALErrorHandler()

void te::gdal::GDALErrorHandler	(	CPLErr	eErrClass,
		int	errNo,
		const char *	msg
	)

◆ GetBandProperties()

TEGDALEXPORT void te::gdal::GetBandProperties	(	GDALDataset *	gds,
		std::vector< te::rst::BandProperty * > &	bprops
	)

Gets the list of bands definition from a GDAL dataset.

Parameters

gds	A pointer to a GDAL dataset.
bprops	A reference to a vector to be filled with the bands description extracted from a dataset.

Note: The caller of this method must take the ownership of the returned properties.

◆ GetBandProperty()

te::rst::BandProperty* te::gdal::GetBandProperty	(	GDALRasterBand *	gband,
		const unsigned int	bandIndex
	)

Gets the properties of a single band from a GDAL dataset.

Parameters

gband	A pointer to a GDAL Raster Band.
bandIndex	The band index (starting from 0).

Returns: A band property.

Note: The caller of this method must take the ownership of the returned properties.

◆ GetBands() [1/2]

bool te::gdal::GetBands	(	te::gdal::Raster *	rst,
		int	multiResLevel,
		std::vector< te::gdal::Band * > &	bands
	)

Gets the list of bands from a GDAL dataset.

Parameters

rst	A pointer to the raster.
multiResLevel	Multi-resolution pyramid level (value -1 -> overviews disabled).
bands	A reference to a vector to be filled with the bands extracted from a dataset.

Note: The caller of this method must take the ownership of the returned properties.

◆ GetBands() [2/2]

void te::gdal::GetBands	(	te::gdal::Raster *	rst,
		std::vector< te::gdal::Band * > &	bands
	)

Gets the list of bands from a GDAL dataset.

Parameters

rst	A pointer to the raster.
bands	A reference to a vector to be filled with the bands extracted from a dataset.

Note: The caller of this method must take the ownership of the returned properties.

◆ GetDriverName()

std::string te::gdal::GetDriverName ( const std::string & dsName )

It returns the GDAL driver name associated to a data source name.

Parameters

dsName the name of the file that represents the data source.

Returns: the GDAL driver name, or its identifier if succeeds and a null string otherwise.

◆ GetExtent()

te::gm::Envelope* te::gdal::GetExtent ( std::string strAccessInfo )

Gets the extent of a raster data decoded by GDAL.

Parameters

strAccessInfo A a string to be used by GDAL to access the raster.

Returns: A pointer to raster extent. Caller takes its ownership.

◆ GetGDALAllDriversUCaseExt2DriversMap()

std::multimap< std::string, std::string > te::gdal::GetGDALAllDriversUCaseExt2DriversMap ( const bool creationSupport )

Returns a map of all GDAL supported Upper-case ( vector and raster ) extensions to their respective driver names.

Parameters

creationSupport Return only those extensions with dataset creation support.

Returns: Returns the result map.

Note: To get only vector extensiones use GetGDALVectorDriversUCaseExt2DriversMap(().; To get only raster extensiones use GetGDALRasterDriversUCaseExt2DriversMap(().

◆ GetGDALColorInterpretation()

GDALColorInterp te::gdal::GetGDALColorInterpretation ( te::rst::ColorInterp ci )

inline

It translates a TerraLib ColorInterpretation to a GDAL ColorInterpretation.

Definition at line 154 of file Utils.h.

References te::rst::AlphaCInt, te::rst::BlueCInt, te::rst::CbCInt, te::rst::CrCInt, te::rst::CyanCInt, te::rst::GrayIdxCInt, te::rst::GreenCInt, te::rst::HueCInt, te::rst::KeyCInt, te::rst::LigCInt, te::rst::MagentaCInt, te::rst::PaletteIdxCInt, te::rst::RedCInt, te::rst::SatCInt, te::rst::YCInt, and te::rst::YellowCInt.

◆ GetGDALConnectionInfo()

std::string te::gdal::GetGDALConnectionInfo ( const std::map< std::string, std::string > & connInfo )

It returns a GDAL connection string from the given map.

Parameters

connInfo An associative conteiner with data source connection info.

Returns: a GDAL connection string from the given map.

Exceptions

Exception It throws an exception if no connection info exists in the input map.

◆ GetGDALDataType()

GDALDataType te::gdal::GetGDALDataType ( int tet )

inline

It translates a TerraLib DataType to a GDAL DataType.

Definition at line 102 of file Utils.h.

References te::dt::CDOUBLE_TYPE, te::dt::CFLOAT_TYPE, te::dt::CHAR_TYPE, te::dt::CINT16_TYPE, te::dt::CINT32_TYPE, te::dt::DOUBLE_TYPE, te::dt::FLOAT_TYPE, te::dt::INT16_TYPE, te::dt::INT32_TYPE, te::dt::UCHAR_TYPE, te::dt::UINT16_TYPE, and te::dt::UINT32_TYPE.

◆ GetGDALDriversMetadata()

std::map< std::string, DriverMetadata >& te::gdal::GetGDALDriversMetadata ( )

Returns metadata from all registered GDAL drivers (key: driver name).

Returns: Metadata from all registered GDAL drivers (key: driver name).

◆ GetGDALRasterDriversUCaseExt2DriversMap()

std::multimap< std::string, std::string > te::gdal::GetGDALRasterDriversUCaseExt2DriversMap ( const bool creationSupport )

Returns a map of all GDAL supported Upper-case raster extensions to their respective driver names.

Parameters

creationSupport Return only those extensions with dataset creation support.

Returns: Returns the result map.

◆ GetGDALRessamplingMethod()

std::string te::gdal::GetGDALRessamplingMethod ( te::rst::InterpolationMethod interpolationMethod )

inline

It translates a TerraLib interpolation method into a GDAL ressampling method name string.

Definition at line 196 of file Utils.h.

References te::rst::Bicubic, te::rst::Bilinear, te::rst::MeanInterpolation, te::rst::ModeInterpolation, and te::rst::NearestNeighbor.

◆ GetGDALVectorDriversUCaseExt2DriversMap()

std::multimap< std::string, std::string > te::gdal::GetGDALVectorDriversUCaseExt2DriversMap ( const bool creationSupport )

Returns a map of all GDAL supported Upper-case vector extensions to their respective driver names.

Parameters

creationSupport Return only those extensions with dataset creation support.

Returns: Returns the result map.

◆ GetGrid() [1/2]

TEGDALEXPORT te::rst::Grid* te::gdal::GetGrid ( GDALDataset * gds )

Gets the grid definition from a GDAL dataset.

Parameters

gds	A pointer to a GDAL dataset.

Returns: A pointer to the grid definition from a GDAL dataset. Caller takes its ownership.

◆ GetGrid() [2/2]

TEGDALEXPORT te::rst::Grid* te::gdal::GetGrid	(	GDALDataset *	gds,
		const int	multiResLevel
	)

Gets the grid definition from a GDAL dataset.

Parameters

gds	A pointer to a GDAL dataset.
multiResLevel	Multi resolution level (use -1 to use the original resolution).

Returns: A pointer to the grid definition from a GDAL dataset. Caller takes its ownership.

◆ GetMetaData()

bool te::gdal::GetMetaData	(	GDALDataset &	dataset,
		std::map< std::string, std::string > &	metadata
	)

Returns metadata read from the given dataset.

Parameters

creationSupport Return only those extensions with dataset creation support.

Returns: Returns true if the dataset has metadadata and it was read, false otherwise.

◆ GetParentDataSetName()

std::string te::gdal::GetParentDataSetName ( const std::string & subDataSetName )

It returns the parent dataset name from a Sub DataSet name.

Parameters

subDataSetName The Full SubDataSet string name.

Returns: the parent dataset name from a Sub DataSet name.

Note: If the given name does not refers to a sub-dataset it will be returned.

◆ GetRasterHandle()

ScopedDataSetHandlePtr te::gdal::GetRasterHandle	(	std::string	strAccessInfo,
		te::common::AccessPolicy	policy = `te::common::RAccess`
	)

Get a handle to a raster file.

Parameters

filename	File name (path included).
policy	The access permission requested.

Returns: A pointer to GDAL dataset if it succeeds or a NULL pointer otherwise.

◆ GetRasterProperty()

te::rst::RasterProperty* te::gdal::GetRasterProperty ( std::string strAccessInfo )

Gets the complete description from a GDAL dataset.

Parameters

strAccessInfo A a string to be used by GDAL to access the raster.

Returns: A pointer to the raster description from a GDAL dataset. Caller takes its ownership.

◆ getStaticMutex()

TEGDALEXPORT boost::mutex& te::gdal::getStaticMutex ( )

Returns a reference to a static mutex initialized when this module is initialized.

Returns: Returns a reference to a static mutex initialized when this module is initialized.

◆ GetSubDataSetName()

std::string te::gdal::GetSubDataSetName	(	const std::string &	name,
		const std::string &	driverName
	)

It returns the Sub DataSet name from the given name or the same name.

Parameters

name	The Full SubDataSet string name.
driverName	The driver name.

Returns: The Sub DataSet name from the given name.

◆ GetTeColorInterpretation()

te::rst::ColorInterp te::gdal::GetTeColorInterpretation ( GDALColorInterp gci )

inline

It translates a GDAL ColorInterpretation to a TerraLib ColorInterpretation.

Definition at line 127 of file Utils.h.

References te::rst::AlphaCInt, te::rst::BlueCInt, te::rst::CbCInt, te::rst::CrCInt, te::rst::CyanCInt, te::rst::GrayIdxCInt, te::rst::GreenCInt, te::rst::HueCInt, te::rst::KeyCInt, te::rst::LigCInt, te::rst::MagentaCInt, te::rst::PaletteIdxCInt, te::rst::RedCInt, te::rst::SatCInt, te::rst::UndefCInt, te::rst::YCInt, and te::rst::YellowCInt.

◆ GetTeDataType()

int te::gdal::GetTeDataType ( GDALDataType gt )

inline

It translates a GDAL DataType to a TerraLib DataType.

Definition at line 78 of file Utils.h.

References te::dt::CDOUBLE_TYPE, te::dt::CFLOAT_TYPE, te::dt::CINT16_TYPE, te::dt::CINT32_TYPE, te::dt::DOUBLE_TYPE, te::dt::FLOAT_TYPE, te::dt::INT16_TYPE, te::dt::INT32_TYPE, te::dt::UCHAR_TYPE, te::dt::UINT16_TYPE, te::dt::UINT32_TYPE, and te::dt::UNKNOWN_TYPE.

◆ GetTePaletteInterpretation()

te::rst::PaletteInterpretation te::gdal::GetTePaletteInterpretation ( GDALPaletteInterp gpi )

inline

It translates a GDAL Pallete Interpretation to a TerraLib Pallete Interpretation.

Definition at line 181 of file Utils.h.

References te::rst::CMYKPalInt, te::rst::GrayPalInt, te::rst::HSLPalInt, te::rst::RGBPalInt, and te::rst::UndefPalInt.

◆ IsSubDataSet()

bool te::gdal::IsSubDataSet ( const std::string & uri )

Returns true if the given URI is related to a sub-dataset.

Parameters

uri	The given URI.

Returns: true if the given URI is related to a sub-dataset.

◆ MakePGConnectionStr()

std::string te::gdal::MakePGConnectionStr ( const te::core::URI & connInfo )

Returns a PostGIS connection string from the URI connection information. The connection string is to be used as a dataset name in GDAL data model. See also http://trac.osgeo.org/gdal/wiki/frmts_wtkraster.html.

Parameters

connInfo The URI parameters.

Returns: Returns a PostGIS connection string from the set connection information.

◆ Rasterize()

TEGDALEXPORT void te::gdal::Rasterize	(	std::vector< te::gm::Geometry * >	geometries,
		GDALDataset *	outraster
	)

Rasterizes a given vector of geometries, using GDALRasterizeGeometries function.

Parameters

geometries	A vector of geometries to be rasterized.
outraster	A reference to the GDAL dataset where the rasterized geometries will be drawn.

◆ RecognizesSRID()

bool te::gdal::RecognizesSRID ( unsigned int srid )

It returns true if GDAL recognizes the given SRS id.

Parameters

srid	The SRS identifier.

Returns: true if GDAL recognizes the given SRS id or false otherwise.

◆ ReprojectRaster()

bool te::gdal::ReprojectRaster	(	te::rst::Raster const *const	rin,
		te::rst::Raster *	rout
	)

Reprojects a raster to another SRS.

Parameters

rin	The input raster file. Do not pass a null pointer.
rout	The new output raster. Do not pass a null pointer.

Returns: true If the reprojection was done or false otherwise.

◆ Vectorize()

TEGDALEXPORT void te::gdal::Vectorize	(	GDALRasterBand *	band,
		std::vector< te::gm::Geometry * > &	geometries
	)

Vectorizes a given raster band, using GDALPolygonize function.

Parameters

band	The band to vectorize.
geometries	A reference to a vector of geometries. Will be filled with geometries found in band.

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ DataSetPtr

◆ ScopedDataSetHandlePtr

Function Documentation

◆ Build()

◆ CreateRaster() [1/2]

◆ CreateRaster() [2/2]

◆ GDALErrorHandler()

◆ GetBandProperties()

◆ GetBandProperty()

◆ GetBands() [1/2]

◆ GetBands() [2/2]

◆ GetDriverName()

◆ GetExtent()

◆ GetGDALAllDriversUCaseExt2DriversMap()

◆ GetGDALColorInterpretation()

◆ GetGDALConnectionInfo()

◆ GetGDALDataType()

◆ GetGDALDriversMetadata()

◆ GetGDALRasterDriversUCaseExt2DriversMap()

◆ GetGDALRessamplingMethod()

◆ GetGDALVectorDriversUCaseExt2DriversMap()

◆ GetGrid() [1/2]

◆ GetGrid() [2/2]

◆ GetMetaData()

◆ GetParentDataSetName()

◆ GetRasterHandle()

◆ GetRasterProperty()

◆ getStaticMutex()

◆ GetSubDataSetName()

◆ GetTeColorInterpretation()

◆ GetTeDataType()

◆ GetTePaletteInterpretation()

◆ IsSubDataSet()

◆ MakePGConnectionStr()

◆ Rasterize()

◆ RecognizesSRID()

◆ ReprojectRaster()

◆ Vectorize()