ImgRasterGdal Class Reference

#include <ImgRasterGdal.h>

Inheritance diagram for ImgRasterGdal:

Collaboration diagram for ImgRasterGdal:

Public Member Functions
	ImgRasterGdal (void)
	default constructor
virtual	~ImgRasterGdal (void)
	destructor
void	setScale (double theScale, int band=0)
	Set scale for a specific band when writing the raster data values. The scaling and offset are applied on a per band basis. You need to set the scale for each band.
void	setOffset (double theOffset, int band=0)
	Set offset for a specific band when writing the raster data values. The scaling and offset are applied on a per band basis. You need to set the offset for each band.
virtual void	close (void)
	Close the image.
std::string	getFileName () const
	Get the filename of this dataset.
int	nrOfCol (void) const
	Get the number of columns of this dataset.
int	nrOfRow (void) const
	Get the number of rows of this dataset.
int	nrOfBand (void) const
	Get the number of bands of this dataset.
bool	isGeoRef () const
	Is this dataset georeferenced (pixel size in y must be negative) ?
std::string	getProjection (void) const
	Get the projection string (deprecated, use getProjectionRef instead) More...
std::string	getProjectionRef (void) const
	Get the projection reference. More...
std::string	getGeoTransform () const
	Get the geotransform data for this dataset as a string. More...
void	getGeoTransform (double *gt) const
	Get the geotransform data for this dataset. More...
CPLErr	setGeoTransform (double *gt)
	Set the geotransform data for this dataset. More...
void	copyGeoTransform (const ImgRasterGdal &imgSrc)
	Copy geotransform information from another georeferenced image. More...
CPLErr	setProjection (const std::string &projection)
	Set the projection for this dataset in well known text (wkt) format. More...
CPLErr	setProjectionProj4 (const std::string &projection)
	Set the projection for this dataset from user input (supports epsg:<number> format) More...
bool	getBoundingBox (double &ulx, double &uly, double &lrx, double &lry) const
	Get the bounding box of this dataset in georeferenced coordinates. More...
bool	getCenterPos (double &x, double &y) const
	Get the center position of this dataset in georeferenced coordinates. More...
double	getUlx () const
	Get the upper left corner x (georeferenced) coordinate of this dataset.
double	getUly () const
	Get the upper left corner y (georeferenced) coordinate of this dataset.
double	getLrx () const
	Get the lower right corner x (georeferenced) coordinate of this dataset.
double	getLry () const
	Get the lower right corner y (georeferenced) coordinate of this dataset.
int	getNoDataValues (std::vector< double > &noDataValues) const
	Get the no data values of this dataset as a standard template library (stl) vector. More...
bool	isNoData (double value) const
	Check if value is nodata in this dataset.
int	pushNoDataValue (double noDataValue)
	Push a no data value for this dataset. More...
int	setNoData (const std::vector< double > nodata)
	Set the no data values of this dataset using a standard template library (stl) vector as input.
CPLErr	GDALSetNoDataValue (double noDataValue, int band=0)
	Set the GDAL (internal) no data value for this data set. Only a single no data value per band is supported.
bool	covers (double x, double y) const
	Check if a geolocation is covered by this dataset. Only the bounding box is checked, irrespective of no data values. More...
bool	covers (double ulx, double uly, double lrx, double lry) const
	Check if a region of interest is (partially) covered by this dataset. Only the bounding box is checked, irrespective of no data values. More...
bool	geo2image (double x, double y, double &i, double &j) const
	Convert georeferenced coordinates (x and y) to image coordinates (column and row) More...
bool	image2geo (double i, double j, double &x, double &y) const
	Convert image coordinates (column and row) to georeferenced coordinates (x and y) More...
double	getDeltaX (void) const
	Get the pixel cell spacing in x.
double	getDeltaY (void) const
	Get the pixel cell spacing in y.
GDALDataType	getDataType (int band=0) const
	Get the GDAL datatype for this dataset. More...
GDALRasterBand *	getRasterBand (int band=0) const
	Get the GDAL rasterband for this dataset. More...
GDALColorTable *	getColorTable (int band=0) const
	Get the GDAL color table for this dataset as an instance of the GDALColorTable class. More...
std::string	getDriverDescription () const
	Get the GDAL driver description of this dataset. More...
std::string	getImageType () const
	Get the image type (implemented as the driver description)
std::string	getInterleave () const
	Get the band coding (interleave) More...
std::string	getCompression () const
	Get the compression from the metadata of this dataset. More...
GDALDataset *	getDataset ()
char **	getMetadata ()
	Get the metadata of this dataset. More...
char **	getMetadata () const
	Get the metadata of this dataset (const version) More...
void	getMetadata (std::list< std::string > &metadata) const
	Get the metadata of this dataset in the form of a list of strings (const version) More...
std::string	getDescription () const
	Get the image description from the driver of this dataset. More...
std::string	getMetadataItem () const
	Get metadata item of this dataset. More...
std::string	getImageDescription () const
	Get the image description from the metadata of this dataset. More...
int	nrOfBlockX (int band=0)
int	nrOfBlockY (int band=0)

Protected Attributes
std::string	m_filename
	filename of this dataset
GDALDataset *	m_gds
	instance of the GDAL dataset of this dataset
int	m_ncol
	number of columns in this dataset
int	m_nrow
	number of rows in this dataset
int	m_nband
	number of bands in this dataset
GDALDataType	m_dataType
	GDAL data type for this dataset.
double	m_gt [6]
	geotransform information of this dataset
std::string	m_projection
std::vector< double >	m_noDataValues
	no data values for this dataset
std::vector< double >	m_scale
	Vector containing the scale factor to be applied (one scale value for each band)
std::vector< double >	m_offset
	Vector containing the offset factor to be applied (one offset value for each band)

Friends
class	ImgReaderGdal
class	ImgWriterGdal

Detailed Description

Base class for raster dataset (read and write) in a format supported by GDAL. This general raster class is used to store e.g., filename, number of columns, rows and bands of the dataset.

Definition at line 67 of file ImgRasterGdal.h.

Member Function Documentation

copyGeoTransform()

void ImgRasterGdal::copyGeoTransform

(

const ImgRasterGdal &

imgSrc

)

Copy geotransform information from another georeferenced image.

Parameters

imgSrc

Use this source image as a template to copy geotranform information

Definition at line 166 of file ImgRasterGdal.cc.

{
  setProjection(imgSrc.getProjection());
  double gt[6];
  imgSrc.getGeoTransform(gt);
  setGeoTransform(gt);
}

covers() [1/2]

bool ImgRasterGdal::covers	(	double	x,
		double	y
	)		const

Check if a geolocation is covered by this dataset. Only the bounding box is checked, irrespective of no data values.

assuming adfGeotransform[0]: ULX (upper left X coordinate) adfGeotransform[1]: $cos(){Xres}$ adfGeotransform[2]: $-sin(){Xres}$ adfGeotransform[3]: ULY (upper left Y coordinate) adfGeotransform[4]: $-sin(){Yres}$ adfGeotransform[5]: $-cos(){Yres}$

Parameters

x,y	georeferenced coordinates in x and y

Returns

true if image covers the georeferenced location

Definition at line 443 of file ImgRasterGdal.cc.

{
  double theULX, theULY, theLRX, theLRY;
  getBoundingBox(theULX,theULY,theLRX,theLRY);
  return((x > theULX)&&
         (x < theLRX)&&
         (y < theULY)&&
         (y >theLRY));
}

covers() [2/2]

bool ImgRasterGdal::covers	(	double	ulx,
		double	uly,
		double	lrx,
		double	lry
	)		const

Check if a region of interest is (partially) covered by this dataset. Only the bounding box is checked, irrespective of no data values.

assuming adfGeotransform[0]: ULX (upper left X coordinate) adfGeotransform[1]: $cos(){Xres}$ adfGeotransform[2]: $-sin(){Xres}$ adfGeotransform[3]: ULY (upper left Y coordinate) adfGeotransform[4]: $-sin(){Yres}$ adfGeotransform[5]: $-cos(){Yres}$

Parameters

ulx	upper left coordinate in x
uly	upper left coordinate in y
lrx	lower left coordinate in x
lry	lower left coordinate in y

Returns

true if image (partially) covers the bounding box

Definition at line 467 of file ImgRasterGdal.cc.

{
  double theULX, theULY, theLRX, theLRY;
  getBoundingBox(theULX,theULY,theLRX,theLRY);
  return((ulx < theLRX)&&(lrx > theULX)&&(lry < theULY)&&(uly > theLRY));
}

geo2image()

bool ImgRasterGdal::geo2image	(	double	x,
		double	y,
		double &	i,
		double &	j
	)		const

Convert georeferenced coordinates (x and y) to image coordinates (column and row)

assuming adfGeotransform[0]: ULX (upper left X coordinate) adfGeotransform[1]: $cos(){Xres}$ adfGeotransform[2]: $-sin(){Xres}$ adfGeotransform[3]: ULY (upper left Y coordinate) adfGeotransform[4]: $-sin(){Yres}$ adfGeotransform[5]: $-cos(){Yres}$

Parameters

x,y	georeferenced coordinates in x and y
i,j	image coordinates (can be fraction of pixels)

Returns

true if image is georeferenced

Definition at line 387 of file ImgRasterGdal.cc.

{
  double gt[6];// { 444720, 30, 0, 3751320, 0, -30 };
  getGeoTransform(gt);

  double denom=(gt[1]-gt[2]*gt[4]/gt[5]);
  double eps=0.00001;
  if(fabs(denom)>eps){
    i=(x-gt[0]-gt[2]/gt[5]*(y-gt[3]))/denom;
    j=(y-gt[3]-gt[4]*(x-gt[0]-gt[2]/gt[5]*(y-gt[3]))/denom)/gt[5];
  }
  if(isGeoRef())
    return true;
  else
    return false;
}

getBoundingBox()

bool ImgRasterGdal::getBoundingBox	(	double &	ulx,
		double &	uly,
		double &	lrx,
		double &	lry
	)		const

Get the bounding box of this dataset in georeferenced coordinates.

assuming adfGeotransform[0]: ULX (upper left X coordinate) adfGeotransform[1]: $cos(){Xres}$ adfGeotransform[2]: $-sin(){Xres}$ adfGeotransform[3]: ULY (upper left Y coordinate) adfGeotransform[4]: $-sin(){Yres}$ adfGeotransform[5]: $-cos(){Yres}$

Parameters

ulx	upper left coordinate in x
uly	upper left coordinate in y
lrx	lower left coordinate in x
lry	lower left coordinate in y

Returns

true if image is georeferenced

Definition at line 333 of file ImgRasterGdal.cc.

{
  double gt[6];// { 444720, 30, 0, 3751320, 0, -30 };
  getGeoTransform(gt);

  ulx=gt[0];
  uly=gt[3];
  lrx=gt[0]+nrOfCol()*gt[1]+nrOfRow()*gt[2];
  lry=gt[3]+nrOfCol()*gt[4]+nrOfRow()*gt[5];
  if(isGeoRef())
    return true;
  else
    return false;
}

getCenterPos()

bool ImgRasterGdal::getCenterPos	(	double &	x,
		double &	y
	)		const

Get the center position of this dataset in georeferenced coordinates.

assuming adfGeotransform[0]: ULX (upper left X coordinate) adfGeotransform[1]: $cos(){Xres}$ adfGeotransform[2]: $-sin(){Xres}$ adfGeotransform[3]: ULY (upper left Y coordinate) adfGeotransform[4]: $-sin(){Yres}$ adfGeotransform[5]: $-cos(){Yres}$

Parameters

x,y	centre coordinates in x and y

Returns

true if image is georeferenced

Definition at line 359 of file ImgRasterGdal.cc.

{
  double gt[6];// { 444720, 30, 0, 3751320, 0, -30 };
  getGeoTransform(gt);

  x=gt[0]+(nrOfCol()/2.0)*gt[1]+(nrOfRow()/2.0)*gt[2];
  y=gt[3]+(nrOfCol()/2.0)*gt[4]+(nrOfRow()/2.0)*gt[5];
  if(isGeoRef()){
    // x=m_ulx+(nrOfCol()/2.0)*m_delta_x;
    // y=m_uly-(nrOfRow()/2.0)*m_delta_y;
    return true;
  }
  else
    return false;
}

getColorTable()

GDALColorTable * ImgRasterGdal::getColorTable

(

int

band = 0

)

const

Get the GDAL color table for this dataset as an instance of the GDALColorTable class.

Parameters

band	get GDAL color table for this band (start counting from 0)

Returns

the GDAL color table of this data set for the selected band

Definition at line 118 of file ImgRasterGdal.cc.

{
  assert(band<m_nband+1);
  GDALRasterBand* theRasterBand=getRasterBand(band);
  if(theRasterBand)
    return(theRasterBand->GetColorTable());
  else
    return(0);
}

getCompression()

std::string ImgRasterGdal::getCompression

(

)

const

Get the compression from the metadata of this dataset.

Returns

the compression meta data of this data set in string format

Definition at line 308 of file ImgRasterGdal.cc.

{
  if(m_gds){
    if(m_gds->GetMetadataItem( "COMPRESSION", "IMAGE_STRUCTURE"))
      return m_gds->GetMetadataItem( "COMPRESSION", "IMAGE_STRUCTURE");
  }
  else
    return("NONE");
}

getDataType()

GDALDataType ImgRasterGdal::getDataType

(

int

band = 0

)

const

Get the GDAL datatype for this dataset.

Parameters

band	get data type for this band (start counting from 0)

Returns

the GDAL data type of this data set for the selected band

Definition at line 92 of file ImgRasterGdal.cc.

{
  assert(band<m_nband+1);
  if(getRasterBand(band))
    return((getRasterBand(band)->GetRasterDataType()));
  else
    return(m_dataType);
}

getDescription()

std::string ImgRasterGdal::getDescription

(

)

const

Get the image description from the driver of this dataset.

Returns

the description of this data set in string format

Definition at line 254 of file ImgRasterGdal.cc.

{
  if(m_gds){
    if(m_gds->GetDriver()->GetDescription()!=NULL)
      return m_gds->GetDriver()->GetDescription();
  }
  else
    return("");
}

getDriverDescription()

std::string ImgRasterGdal::getDriverDescription

(

)

const

Get the GDAL driver description of this dataset.

Returns

the driver description of this data set in string format

Definition at line 131 of file ImgRasterGdal.cc.

{
  std::string driverDescription;
  if(m_gds)
    driverDescription=m_gds->GetDriver()->GetDescription();
  return(driverDescription);
}

getGeoTransform() [1/2]

std::string ImgRasterGdal::getGeoTransform

(

)

const

Get the geotransform data for this dataset as a string.

Returns

the geotransform of this data set in string format

Definition at line 200 of file ImgRasterGdal.cc.

{
  std::string gtString;
  double gt[6];// { 444720, 30, 0, 3751320, 0, -30 };
  getGeoTransform(gt);
  std::ostringstream s;
  s << "[" << gt[0] << "," << gt[1] << "," << gt[2] << "," << gt[3] << "," << gt[4] << "," << gt[5] << "]";
  gtString=s.str();
  return(s.str());
}

getGeoTransform() [2/2]

void ImgRasterGdal::getGeoTransform

(

double *

gt

)

const

Get the geotransform data for this dataset.

Parameters

gt	pointer to the six geotransform parameters:
adfGeoTransform[0]	top left x
GeoTransform[1]	w-e pixel resolution
GeoTransform[2]	rotation, 0 if image is "north up"
GeoTransform[3]	top left y
GeoTransform[4]	rotation, 0 if image is "north up"
GeoTransform[5]	n-s pixel resolution

Definition at line 183 of file ImgRasterGdal.cc.

                                                   {
  // if(m_gds){
  //   m_gds->GetGeoTransform(gt);
  // }
  // else{
    gt[0]=m_gt[0];
    gt[1]=m_gt[1];
    gt[2]=m_gt[2];
    gt[3]=m_gt[3];
    gt[4]=m_gt[4];
    gt[5]=m_gt[5];
  // }
}

getImageDescription()

std::string ImgRasterGdal::getImageDescription

(

)

const

Get the image description from the metadata of this dataset.

Returns

the image description (TIFFTAG) of this data set in string format

Definition at line 280 of file ImgRasterGdal.cc.

{
  if(m_gds){
    if(m_gds->GetDriver()->GetMetadataItem("TIFFTAG_IMAGEDESCRIPTION")!=NULL)
      return m_gds->GetDriver()->GetMetadataItem("TIFFTAG_IMAGEDESCRIPTION");
  }
  else
    return("");
}

getInterleave()

std::string ImgRasterGdal::getInterleave

(

)

const

Get the band coding (interleave)

Returns

the band coding interleave of this data set in string format

Definition at line 293 of file ImgRasterGdal.cc.

{
  if(m_gds){
    if(m_gds->GetMetadataItem( "INTERLEAVE", "IMAGE_STRUCTURE"))
      return m_gds->GetMetadataItem( "INTERLEAVE", "IMAGE_STRUCTURE");
    else
      return("BAND");
  }
  else
    return("");
}

getMetadata() [1/3]

char ** ImgRasterGdal::getMetadata

(

)

Get the metadata of this dataset.

Returns

the metadata of this data set in string format

Definition at line 214 of file ImgRasterGdal.cc.

{
  if(m_gds){
    if(m_gds->GetMetadata()!=NULL)
      return(m_gds->GetMetadata());
  }
  else
    return (char**)"";
}

getMetadata() [2/3]

char ** ImgRasterGdal::getMetadata

(

)

const

Get the metadata of this dataset (const version)

Returns

the metadata of this data set in C style string format (const version)

Definition at line 227 of file ImgRasterGdal.cc.

{
  if(m_gds){
    if(m_gds->GetMetadata()!=NULL)
      return(m_gds->GetMetadata());
  }
  else 
    return (char**)"";
}

getMetadata() [3/3]

void ImgRasterGdal::getMetadata

(

std::list< std::string > &

metadata

)

const

Get the metadata of this dataset in the form of a list of strings (const version)

Returns

the metadata of this data set in standard template library (stl) string format

Definition at line 240 of file ImgRasterGdal.cc.

{
  if(m_gds){
    char** cmetadata=m_gds->GetMetadata();
    while(*cmetadata!=NULL){
      metadata.push_back(*(cmetadata));
      ++cmetadata;
    }
  }
}

getMetadataItem()

std::string ImgRasterGdal::getMetadataItem

(

)

const

Get metadata item of this dataset.

Returns

the meta data item of this data set in string format

Definition at line 267 of file ImgRasterGdal.cc.

{
  if(m_gds){
    if(m_gds->GetDriver()->GetMetadataItem( GDAL_DMD_LONGNAME )!=NULL)
      return m_gds->GetDriver()->GetMetadataItem( GDAL_DMD_LONGNAME );
  }
  else
    return("");
}

getNoDataValues()

int ImgRasterGdal::getNoDataValues

(

std::vector< double > &

noDataValues

)

const

Get the no data values of this dataset as a standard template library (stl) vector.

Parameters

noDataValues

standard template library (stl) vector containing no data values

Returns

number of no data values in this dataset

Definition at line 478 of file ImgRasterGdal.cc.

{
  if(m_noDataValues.size()){
    noDataValues=m_noDataValues;
    return m_noDataValues.size();
  }
  else
    return 0;
}

getProjection()

std::string ImgRasterGdal::getProjection

(

void

)

const

Get the projection string (deprecated, use getProjectionRef instead)

Returns

the projection of this data set in string format

Definition at line 40 of file ImgRasterGdal.cc.

{
  // if(m_gds)
  //   return(m_gds->GetProjectionRef());
  // else
  return(m_projection);
}

getProjectionRef()

std::string ImgRasterGdal::getProjectionRef

(

void

)

const

Get the projection reference.

Returns

the projection of this data set in string format

Definition at line 51 of file ImgRasterGdal.cc.

{
  // if(m_gds)
  //   return(m_gds->GetProjectionRef());
  // else
  return(m_projection);
}

getRasterBand()

GDALRasterBand * ImgRasterGdal::getRasterBand

(

int

band = 0

)

const

Get the GDAL rasterband for this dataset.

Parameters

band	get GDAL raster band for this band (start counting from 0)

Returns

the GDAL raster band of this data set for the selected band

Definition at line 105 of file ImgRasterGdal.cc.

{
  assert(band<m_nband+1);
  if(m_gds)
    return((m_gds->GetRasterBand(band+1)));
  else
    return(0);
}

image2geo()

bool ImgRasterGdal::image2geo	(	double	i,
		double	j,
		double &	x,
		double &	y
	)		const

Convert image coordinates (column and row) to georeferenced coordinates (x and y)

assuming adfGeotransform[0]: ULX (upper left X coordinate) adfGeotransform[1]: $cos(){Xres}$ adfGeotransform[2]: $-sin(){Xres}$ adfGeotransform[3]: ULY (upper left Y coordinate) adfGeotransform[4]: $-sin(){Yres}$ adfGeotransform[5]: $-cos(){Yres}$

Parameters

i,j	image coordinates (can be fraction of pixels)
x,y	georeferenced coordinates in x and y (can be fraction of pixels)

Returns

true if image is georeferenced

Definition at line 416 of file ImgRasterGdal.cc.

{
  double gt[6];// { 444720, 30, 0, 3751320, 0, -30 };
  getGeoTransform(gt);

  x=gt[0]+(0.5+i)*gt[1]+(0.5+j)*gt[2];
  y=gt[3]+(0.5+i)*gt[4]+(0.5+j)*gt[5];
  if(isGeoRef()){
    // x=m_ulx+(0.5+i)*m_delta_x;
    // y=m_uly-(0.5+j)*m_delta_y;
    return true;
  }
  else
    return false;
}

pushNoDataValue()

int ImgRasterGdal::pushNoDataValue

(

double

noDataValue

)

Push a no data value for this dataset.

Parameters

noDataValue

no data value to be pushed for this dataset

Returns

number of no data values in this dataset

Definition at line 492 of file ImgRasterGdal.cc.

{
  if(find(m_noDataValues.begin(),m_noDataValues.end(),noDataValue)==m_noDataValues.end())
    m_noDataValues.push_back(noDataValue);
  return(m_noDataValues.size());
}

setGeoTransform()

CPLErr ImgRasterGdal::setGeoTransform

(

double *

gt

)

Set the geotransform data for this dataset.

Parameters

gt	pointer to the six geotransform parameters:
adfGeoTransform[0]	top left x
GeoTransform[1]	w-e pixel resolution
GeoTransform[2]	rotation, 0 if image is "north up"
GeoTransform[3]	top left y
GeoTransform[4]	rotation, 0 if image is "north up"
GeoTransform[5]	n-s pixel resolution

Definition at line 148 of file ImgRasterGdal.cc.

                                               {
  // m_isGeoRef=true;
  m_gt[0]=gt[0];
  m_gt[1]=gt[1];
  m_gt[2]=gt[2];
  m_gt[3]=gt[3];
  m_gt[4]=gt[4];
  m_gt[5]=gt[5];
  if(m_gds)
    return(m_gds->SetGeoTransform(m_gt));
  else
    return(CE_Failure);
      
}

setProjection()

CPLErr ImgRasterGdal::setProjection

(

const std::string &

projection

)

Set the projection for this dataset in well known text (wkt) format.

Parameters

projection

projection string to be used for this dataset

Definition at line 79 of file ImgRasterGdal.cc.

{
  m_projection=projection;
  if(m_gds)
    return(m_gds->SetProjection(projection.c_str()));
  else
    return(CE_Failure);
}

setProjectionProj4()

CPLErr ImgRasterGdal::setProjectionProj4

(

const std::string &

projection

)

Set the projection for this dataset from user input (supports epsg:<number> format)

Parameters

projection

projection string to be used for this dataset

Returns

the projection of this data set in string format

Definition at line 63 of file ImgRasterGdal.cc.

{
  OGRSpatialReference theRef;
  theRef.SetFromUserInput(projection.c_str());
  char *wktString;
  theRef.exportToWkt(&wktString);
  m_projection=wktString;
  if(m_gds)
    return(m_gds->SetProjection(wktString));
  else
    return(CE_Failure);
}

---

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

• /home/kempepi/PKTOOLS-2.6.7.6/src/imageclasses/ImgRasterGdal.h
• /home/kempepi/PKTOOLS-2.6.7.6/src/imageclasses/ImgRasterGdal.cc