HydroCouple  2.0.0
HydroCouple Interface Definitions
HydroCouple::Spatial::IRaster Class Referenceabstract

A Raster spatial feature. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IRaster:
Collaboration diagram for HydroCouple::Spatial::IRaster:

Public Types

enum  RasterDataType {
  Unknown ,
  Byte ,
  UInt16 ,
  Int16 ,
  UInt32 ,
  Int32 ,
  Float32 ,
  Float64 ,
  CInt16 ,
  CInt32 ,
  CFloat32 ,
  CFloat64
}
 The data type associated with a raster. More...
 

Public Member Functions

virtual ~IRaster ()=0
 IRaster destructor. More...
 
virtual int xSize () const =0
 Number of pixels in the x direction. More...
 
virtual int ySize () const =0
 Number of pixels in y direction. More...
 
virtual int rasterBandCount () const =0
 Number of raster bands. More...
 
virtual void addRasterBand (RasterDataType dataType)=0
 Adds a new IRasterBand. More...
 
virtual ISpatialReferenceSystemspatialReferenceSystem () const =0
 The ISpatialReferenceSystem represents the spatial reference system of goemetric object. More...
 
virtual void geoTransformation (double *transformationMatrix)=0
 Fetches the affine transformation coefficients. It is an array of size 6. More...
 
virtual IRasterBandgetRasterBand (int bandIndex) const =0
 Gets the IRasterBand for the band with index bandIndex. More...
 
- Public Member Functions inherited from HydroCouple::IIdentity
virtual ~IIdentity ()=0
 IIdentity::~IIdentity is a virtual destructor. More...
 
virtual string id () const =0
 Gets a unique identifier for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()=0
 IDescription::~IDescription is a virtual destructor. More...
 
virtual string caption () const =0
 Gets caption for the entity. More...
 
virtual void setCaption (const string &caption)=0
 Sets caption for the entity. More...
 
virtual string description () const =0
 Gets additional descriptive information for the entity. More...
 
virtual void setDescription (const string &description)=0
 Gets additional descriptive information for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()=0
 IPropertyChanged::~IPropertyChanged is a virtual destructor. More...
 
virtual void registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
 IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...
 
virtual void deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
 IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...
 

Detailed Description

A Raster spatial feature.

Member Enumeration Documentation

◆ RasterDataType

The data type associated with a raster.

Enumerator
Unknown 

Unknown or unspecified type.

Byte 

Eight bit unsigned integer.

UInt16 

Sixteen bit unsigned integer.

Int16 

Sixteen bit signed integer.

UInt32 

Thirty two bit unsigned integer.

Int32 

Thirty two bit signed integer.

Float32 

Thirty two bit floating point.

Float64 

Sixty four bit floating point.

CInt16 

Complex Int16.

CInt32 

Complex Int32.

CFloat32 

Complex Float32.

CFloat64 

Complex Float64.

Constructor & Destructor Documentation

◆ ~IRaster()

virtual HydroCouple::Spatial::IRaster::~IRaster ( )
pure virtual

IRaster destructor.

Member Function Documentation

◆ addRasterBand()

virtual void HydroCouple::Spatial::IRaster::addRasterBand ( RasterDataType  dataType)
pure virtual

Adds a new IRasterBand.

◆ geoTransformation()

virtual void HydroCouple::Spatial::IRaster::geoTransformation ( double *  transformationMatrix)
pure virtual

Fetches the affine transformation coefficients. It is an array of size 6.

Fetches the coefficients for transforming between pixel/line (P,L) raster space, and projection coordinates (Xp,Yp) space. Xp = transformationMatrix[0] + P*transformationMatrix[1] + L*transformationMatrix[2]; Yp = transformationMatrix[3] + P*transformationMatrix[4] + L*transformationMatrix[5]; In a north up image, transformationMatrix[1] is the pixel width, and transformationMatrix[5] is the pixel height. The upper left corner of the upper left pixel is at position (transformationMatrix[0],transformationMatrix[3]).

◆ getRasterBand()

virtual IRasterBand* HydroCouple::Spatial::IRaster::getRasterBand ( int  bandIndex) const
pure virtual

Gets the IRasterBand for the band with index bandIndex.

◆ rasterBandCount()

virtual int HydroCouple::Spatial::IRaster::rasterBandCount ( ) const
pure virtual

Number of raster bands.

◆ spatialReferenceSystem()

virtual ISpatialReferenceSystem* HydroCouple::Spatial::IRaster::spatialReferenceSystem ( ) const
pure virtual

The ISpatialReferenceSystem represents the spatial reference system of goemetric object.

◆ xSize()

virtual int HydroCouple::Spatial::IRaster::xSize ( ) const
pure virtual

Number of pixels in the x direction.

◆ ySize()

virtual int HydroCouple::Spatial::IRaster::ySize ( ) const
pure virtual

Number of pixels in y direction.


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