Loading...
Searching...
No Matches
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 class  RasterDataType {
  Unknown ,
  Byte ,
  UInt16 ,
  Int16 ,
  UInt32 ,
  Int32 ,
  Float32 ,
  Float64 ,
  CInt16 ,
  CInt32 ,
  CFloat32 ,
  CFloat64 ,
  ARGB32 ,
  ARGB32_Premultiplied
}
 The data type associated with a raster band. More...
 

Public Member Functions

virtual ~IRaster ()=default
 IRaster destructor.
 
virtual int64_t xSize () const =0
 Number of pixels in the x direction.
 
virtual int64_t ySize () const =0
 Number of pixels in y direction.
 
virtual int64_t rasterBandCount () const =0
 Number of raster bands.
 
virtual void addRasterBand (RasterDataType dataType)=0
 Adds a new IRasterBand.
 
virtual ISpatialReferenceSystem * spatialReferenceSystem () const =0
 The ISpatialReferenceSystem represents the spatial reference system of this raster.
 
virtual void geoTransformation (double *transformationMatrix) const =0
 Fetches the affine transformation coefficients.
 
virtual IRasterBand * getRasterBand (int64_t bandIndex) const =0
 Gets the IRasterBand for the band with index bandIndex (non-owning).
 
- Public Member Functions inherited from HydroCouple::IIdentity
virtual ~IIdentity ()=default
 IIdentity::~IIdentity is a virtual destructor.
 
virtual const std::string & id () const =0
 Gets a unique identifier for the entity.
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()=default
 IDescription::~IDescription is a virtual destructor.
 
virtual const std::string & caption () const =0
 Gets caption for the entity.
 
virtual void setCaption (const std::string &caption)=0
 Sets caption for the entity.
 
virtual const std::string & description () const =0
 Gets additional descriptive information for the entity.
 
virtual void setDescription (const std::string &description)=0
 Gets additional descriptive information for the entity.
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()=default
 IPropertyChanged::~IPropertyChanged is a virtual destructor.
 
- Public Member Functions inherited from HydroCouple::ISignal< std::string >
virtual ~ISignal ()=default
 ISignal::~ISignal is a virtual destructor.
 
virtual void connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
 connect is used to connect a slot to the signal.
 
virtual void disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0
 disconnect is used to disconnect a slot from the signal.
 
virtual void blockSignals (bool block)=0
 blockSignals is used to block signals from being emitted.
 

Additional Inherited Members

- Protected Member Functions inherited from HydroCouple::ISignal< std::string >
virtual void emit (Args... args)=0
 emit is used to emit the signal.
 

Detailed Description

A Raster spatial feature.

Member Enumeration Documentation

◆ RasterDataType

The data type associated with a raster band.

Mirrors GDAL's band types. The mapping to the data plane is fixed: Byte→UInt8, UInt16/Int16/UInt32/Int32/Float32/Float64→the DataKind of the same name; the complex and colour kinds have no DataKind and are carried as DataKind::Opaque with itemSizeBytes of 4, 8, 8, 16, 4 and 4 respectively. An IRasterComponentDataItem holds one DataKind for all its bands, so bands of mixed type belong in separate items.

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.

ARGB32 

Colour: alpha, red, green, blue, one byte each, most significant byte first.

ARGB32_Premultiplied 

Colour as ARGB32 with red, green and blue premultiplied by alpha.

Constructor & Destructor Documentation

◆ ~IRaster()

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

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) const
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 ( int64_t bandIndex) const
nodiscardpure virtual

Gets the IRasterBand for the band with index bandIndex (non-owning).

◆ rasterBandCount()

virtual int64_t HydroCouple::Spatial::IRaster::rasterBandCount ( ) const
nodiscardpure virtual

Number of raster bands.

◆ spatialReferenceSystem()

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

The ISpatialReferenceSystem represents the spatial reference system of this raster.

◆ xSize()

virtual int64_t HydroCouple::Spatial::IRaster::xSize ( ) const
nodiscardpure virtual

Number of pixels in the x direction.

◆ ySize()

virtual int64_t HydroCouple::Spatial::IRaster::ySize ( ) const
nodiscardpure virtual

Number of pixels in y direction.


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