IRasterBand is a single raster band for an IRaster.
More...
#include <hydrocouplespatial.h>
|
| virtual | ~IRasterBand ()=default |
| | IRasterBand 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 IRaster * | raster () const =0 |
| | Parent IRaster of this IRasterBand.
|
| |
| virtual IRaster::RasterDataType | dataType () const =0 |
| | Raster data type.
|
| |
| virtual bool | read (int64_t xOffset, int64_t yOffset, int64_t xSize, int64_t ySize, const BufferDescriptor &destination, std::string *message=nullptr) const =0 |
| | Reads a window of the band into a caller-described buffer.
|
| |
| virtual bool | write (int64_t xOffset, int64_t yOffset, int64_t xSize, int64_t ySize, const BufferDescriptor &source, std::string *message=nullptr)=0 |
| | Writes a caller-described buffer into a window of the band.
|
| |
| virtual double | noData () const =0 |
| | The nodata value for this IRasterBand.
|
| |
| virtual | ~IIdentity ()=default |
| | IIdentity::~IIdentity is a virtual destructor.
|
| |
| virtual const std::string & | id () const =0 |
| | Gets a unique identifier for the entity.
|
| |
| 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.
|
| |
| virtual | ~IPropertyChanged ()=default |
| | IPropertyChanged::~IPropertyChanged is a virtual destructor.
|
| |
| 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.
|
| |
|
| virtual void | emit (Args... args)=0 |
| | emit is used to emit the signal.
|
| |
IRasterBand is a single raster band for an IRaster.
◆ ~IRasterBand()
| virtual HydroCouple::Spatial::IRasterBand::~IRasterBand |
( |
| ) |
|
|
virtualdefault |
◆ dataType()
◆ noData()
| virtual double HydroCouple::Spatial::IRasterBand::noData |
( |
| ) |
const |
|
nodiscardpure virtual |
◆ raster()
| virtual IRaster * HydroCouple::Spatial::IRasterBand::raster |
( |
| ) |
const |
|
nodiscardpure virtual |
◆ read()
| virtual bool HydroCouple::Spatial::IRasterBand::read |
( |
int64_t | xOffset, |
|
|
int64_t | yOffset, |
|
|
int64_t | xSize, |
|
|
int64_t | ySize, |
|
|
const BufferDescriptor & | destination, |
|
|
std::string * | message = nullptr ) const |
|
nodiscardpure virtual |
Reads a window of the band into a caller-described buffer.
The same data plane as IComponentDataItem::getValuesInto(): the destination is a rank-2 descriptor of shape {ySize, xSize} whose kind is the DataKind this band's dataType() maps to (see RasterDataType), and the same memory-space and contiguity rules apply.
- Parameters
-
| [in] | xOffset | is the pixel offset to the top left corner of the window; zero starts at the left edge. |
| [in] | yOffset | is the line offset to the top left corner of the window; zero starts at the top. |
| [in] | xSize | is the width of the window in pixels. |
| [in] | ySize | is the height of the window in lines. |
| [in] | destination | describes the buffer receiving the window. |
| [out] | message | optionally receives a failure description. |
- Returns
- True on success.
◆ write()
| virtual bool HydroCouple::Spatial::IRasterBand::write |
( |
int64_t | xOffset, |
|
|
int64_t | yOffset, |
|
|
int64_t | xSize, |
|
|
int64_t | ySize, |
|
|
const BufferDescriptor & | source, |
|
|
std::string * | message = nullptr ) |
|
nodiscardpure virtual |
Writes a caller-described buffer into a window of the band.
Rules as for read().
- Parameters
-
| [in] | xOffset | is the pixel offset to the top left corner of the window. |
| [in] | yOffset | is the line offset to the top left corner of the window. |
| [in] | xSize | is the width of the window in pixels. |
| [in] | ySize | is the height of the window in lines. |
| [in] | source | describes the buffer providing the window. |
| [out] | message | optionally receives a failure description. |
- Returns
- True on success.
◆ xSize()
| virtual int64_t HydroCouple::Spatial::IRasterBand::xSize |
( |
| ) |
const |
|
nodiscardpure virtual |
Number of pixels in the x direction.
◆ ySize()
| virtual int64_t HydroCouple::Spatial::IRasterBand::ySize |
( |
| ) |
const |
|
nodiscardpure virtual |
Number of pixels in y direction.
The documentation for this class was generated from the following file: