Band implementation for the In-Memory Raster. More...
#include <Band.h>
  
Public Member Functions | |
| Band (const Band &rhs) | |
| Band (Raster *r, te::rst::BandProperty *p, std::size_t idx, void *externalBuffer=0) | |
| Band & | callOperator (std::complex< double >(*f)(std::complex< double >, std::complex< double >), Band &rhs) | 
| It calls a parameter function f to apply in all pixels from two bands, e.g. pixel = f(lhs, rhs);.   | |
| Band & | callOperator (std::complex< double >(*f)(std::complex< double >, std::complex< double >), std::complex< double > &cvalue) | 
| It calls a parameter function f to apply in all pixels from the band, e.g. pixel = f(lhs, rhs);.   | |
| virtual void | getBlockBuffer (void *buffer, int x0, int y0, int width, int height, int outWidth, int outHeight, int dataType) | 
| It gets the buffer in just only one block that represents the region informed.   | |
| int | getBlockSize () const | 
| It returns the number of bytes ocuppied by a data block.   | |
| virtual std::map< double, unsigned > | getHistogramI (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0, unsigned int b=0) const | 
| It computes and returns the histogram occurring values (imaginary part) in a window of the band.   | |
| virtual void | getHistogramR (const unsigned int rowStart, const unsigned int colStart, const unsigned int finalRow, const unsigned int finalCol, const unsigned int histoBins, const unsigned int sampleStep, std::map< double, unsigned > &histogram) const | 
| It computes and returns the histogram occurring values (real part) in a window of the band.   | |
| virtual std::map< double, unsigned > | getHistogramR (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0, unsigned int b=0) const | 
| It computes and returns the histogram occurring values (real part) in a window of the band.   | |
| void | getIValue (unsigned int c, unsigned int r, double &value) const | 
| Returns the imaginary attribute value in a complex band of a cell.   | |
| virtual std::complex< double > | getMaxValue (bool readall=false, unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const | 
| It computes and returns the maximum occurring value in a window of the band.   | |
| virtual std::complex< double > | getMeanValue (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const | 
| It computes and returns the mean of the occurring values in a window of the band.   | |
| virtual std::complex< double > | getMinValue (bool readall=false, unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const | 
| It computes and returns the minimum occurring value in a window of the band.   | |
| std::complex< double > | getOffsetValue () const | 
| It returns the offset values (real and imaginary) to be applied to the band.   | |
| BandProperty * | getProperty () | 
| Returns the band property.   | |
| const BandProperty * | getProperty () const | 
| Returns the band property.   | |
| te::rst::Raster * | getRaster () const | 
| Returns the associated raster.   | |
| std::complex< double > | getScaleValue () const | 
| It returns the scale values (real and imaginary) to be applied to the band.   | |
| virtual std::complex< double > | getStdValue (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const | 
| It computes and returns the standard deviation of the occurring values in a window of the band.   | |
| void | getValue (unsigned int c, unsigned int r, double &value) const | 
| Returns the cell attribute value.   | |
| virtual void | getValue (unsigned int c, unsigned int r, std::complex< double > &value) const | 
| Returns the imaginary attribute value in a complex band of a cell.   | |
| virtual Band & | operator*= (Band &rhs) | 
| It returns the band product (pixel by pixel).   | |
| virtual Band & | operator*= (std::complex< double > &cvalue) | 
| It returns the product of a constant value to all pixels in the band.   | |
| virtual Band & | operator+= (Band &rhs) | 
| It returns the band sum (pixel by pixel).   | |
| virtual Band & | operator+= (std::complex< double > &cvalue) | 
| It returns the sum of a constant value to all pixels in the band.   | |
| virtual Band & | operator-= (Band &rhs) | 
| It returns the band subtraction (pixel by pixel).   | |
| virtual Band & | operator-= (std::complex< double > &cvalue) | 
| It returns the difference from all pixels in the band to a constant value (pixel - constant).   | |
| virtual Band & | operator/= (Band &rhs) | 
| It returns the band division (pixel by pixel).   | |
| virtual Band & | operator/= (std::complex< double > &cvalue) | 
| It returns the division of all pixels in the band by a constant value (pixel / constant).   | |
| Band & | operator= (const Band &rhs) | 
| void * | read (int x, int y) | 
| It reads and returns a data block.   | |
| void | read (int x, int y, void *buffer) const | 
| It reads a data block to the specified buffer.   | |
| void | setIValue (unsigned int c, unsigned int r, const double value) | 
| Sets the imaginary attribute value in a complex band of a cell.   | |
| void | setOffsetValue (const std::complex< double > o) | 
| Sets the offset values (real and imaginary) to be applied to the band.   | |
| void | setRaster (Raster *r) | 
| void | setScaleValue (const std::complex< double > s) | 
| Sets the scale values (real and imaginary) to be applied to the band.   | |
| void | setValue (unsigned int c, unsigned int r, const double value) | 
| Sets the cell attribute value.   | |
| virtual void | setValue (unsigned int c, unsigned int r, const std::complex< double > &value) | 
| Sets the imaginary attribute value in a complex band of a cell.   | |
| void | write (int x, int y, void *buffer) | 
| It writes a data block from the specified buffer.   | |
| ~Band () | |
| Virtual destructor.   | |
Protected Attributes | |
| std::size_t | m_idx | 
| The band index.   | |
| BandProperty * | m_property | 
| The band information.   | |
Private Attributes | |
| int | m_blksize | 
| The data block size.   | |
| unsigned char * | m_buff | 
| A pointer to a block buffer.   | |
| te::rst::GetBufferValueFPtr | m_getBuff | 
| A pointer to a function that helps to extract a double or complex value from a specific buffer data type (char, int16, int32, float, ...).   | |
| te::rst::GetBufferValueFPtr | m_getBuffI | 
| A pointer to a function that helps to extract the imaginary part value from a specific buffer data type (cint16, cint32, cfloat, cdouble).   | |
| int | m_ncols | 
| Buffered number of cols.   | |
| int | m_nrows | 
| Buffered number of rows.   | |
| Raster * | m_raster | 
| bool | m_releaseBuffer | 
| A flag that indicates if the buffer must be released when the band goes out of scope.   | |
| te::rst::SetBufferValueFPtr | m_setBuff | 
| A pointer to a function that helps to insert a double or complex value into a specific buffer data type (char, int16, int32, float, ...).   | |
| te::rst::SetBufferValueFPtr | m_setBuffI | 
| A pointer to a function that helps to insert the imaginary part value into a specific buffer data type (cint16, cint32, cfloat, cdouble).   | |
| te::mem::Band::Band | ( | Raster * | r, | 
| te::rst::BandProperty * | p, | ||
| std::size_t | idx, | ||
| void * | externalBuffer = 0  | 
        ||
| ) | 
| externalBuffer | If provided the band will use the referenced buffer and will not deallocate it at the end. | 
| te::mem::Band::Band | ( | const Band & | rhs | ) | 
      
  | 
  virtual | 
Virtual destructor.
Reimplemented from te::rst::Band.
      
  | 
  inherited | 
It calls a parameter function f to apply in all pixels from two bands, e.g. pixel = f(lhs, rhs);.
| (*f) | a function with the signature complex<double>(*f)(complex<double>, complex<double>) | 
| rhs | The rhs band to apply the function. | 
      
  | 
  inherited | 
It calls a parameter function f to apply in all pixels from the band, e.g. pixel = f(lhs, rhs);.
| (*f) | a function with the signature complex<double>(*f)(complex<double>, complex<double>) | 
| cvalue | The constant value that will work with the generic function. | 
      
  | 
  virtualinherited | 
It gets the buffer in just only one block that represents the region informed.
| buffer | Buffer with resampled recovered image | 
| x0 | Start point (upper left X) from input image | 
| y0 | Start point (upper left Y) from input image | 
| width | Width of input image | 
| height | Height of input image | 
| outWidth | Width of output buffer | 
| outHeight | Height of output buffer | 
\NOTE: This method was defined to increase draw speed.
Reimplemented in te::gdal::Band.
      
  | 
  virtual | 
It returns the number of bytes ocuppied by a data block.
Reimplemented from te::rst::Band.
      
  | 
  virtualinherited | 
It computes and returns the histogram occurring values (imaginary part) in a window of the band.
| rs | The starting row. | 
| cs | The starting column. | 
| rf | The final row. | 
| cf | The final column. | 
| b | The number of bins (intervals from minimum pixel to maximum). When b = 0, the histogram will be divided according to all pixel values. | 
      
  | 
  virtualinherited | 
It computes and returns the histogram occurring values (real part) in a window of the band.
| rowStart | The starting row. | 
| colStart | The starting column. | 
| finalRow | The final row. | 
| finalCol | The final column. | 
| histoBins | The number of bins (intervals from minimum pixel to maximum). When b = 0, the histogram will be divided according to all pixel values. | 
| sampleStep | The row/column step used when reading pixels (to read all pixels sampleStep=1, to read half of pixels use sampleStep=2 ); | 
| histogram | The generated histogram. | 
Reimplemented in te::gdal::Band.
      
  | 
  virtualinherited | 
It computes and returns the histogram occurring values (real part) in a window of the band.
| rs | The starting row. | 
| cs | The starting column. | 
| rf | The final row. | 
| cf | The final column. | 
| b | The number of bins (intervals from minimum pixel to maximum). When b = 0, the histogram will be divided according to all pixel values. | 
      
  | 
  virtual | 
Returns the imaginary attribute value in a complex band of a cell.
| c | The column location of the cell. | 
| r | The row location of the cell. | 
| value | The attribute value to be assigned. | 
| Exception | Subclasses may throw an exception if the data value can not be read. | 
Implements te::rst::Band.
      
  | 
  virtualinherited | 
It computes and returns the maximum occurring value in a window of the band.
| readall | Force the reading the entire image (can be slow). If false, will read up to 1000 pixels of the image, equally spaced. | 
| rs | The starting row. | 
| cs | The starting column. | 
| rf | The final row. | 
| cf | The final column. | 
Reimplemented in te::gdal::Band.
      
  | 
  virtualinherited | 
It computes and returns the mean of the occurring values in a window of the band.
| rs | The starting row. | 
| cs | The starting column. | 
| rf | The final row. | 
| cf | The final column. | 
Reimplemented in te::gdal::Band.
      
  | 
  virtualinherited | 
It computes and returns the minimum occurring value in a window of the band.
| readall | Force the reading the entire image (can be slow). If false, will read up to 1000 pixels of the image, equally spaced. | 
| rs | The starting row. | 
| cs | The starting column. | 
| rf | The final row. | 
| cf | The final column. | 
Reimplemented in te::gdal::Band.
      
  | 
  inherited | 
It returns the offset values (real and imaginary) to be applied to the band.
      
  | 
  inherited | 
Returns the band property.
Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), te::rst::BandIteratorWindow< T >::BandIteratorWindow(), te::rst::BandIterator< T >::end(), te::rst::BandIteratorWithMask< T >::end(), te::rst::BandIteratorWindow< T >::end(), and te::rst::ConstBandIterator< T >::end().
      
  | 
  inherited | 
Returns the band property.
      
  | 
  virtual | 
Returns the associated raster.
Implements te::rst::Band.
      
  | 
  inherited | 
It returns the scale values (real and imaginary) to be applied to the band.
      
  | 
  virtualinherited | 
It computes and returns the standard deviation of the occurring values in a window of the band.
| rs | The starting row. | 
| cs | The starting column. | 
| rf | The final row. | 
| cf | The final column. | 
Reimplemented in te::gdal::Band.
      
  | 
  virtual | 
Returns the cell attribute value.
| c | The column location of the cell. | 
| r | The row location of the cell. | 
| value | To return the attribute value. | 
| Exception | Subclasses may throw an exception if the data value can not be read. | 
Implements te::rst::Band.
      
  | 
  virtualinherited | 
Returns the imaginary attribute value in a complex band of a cell.
| c | The column location of the cell. | 
| r | The row location of the cell. | 
| value | The complex attribute value to be assigned (real, imaginary). | 
| Exception | Subclasses may throw an exception if the data value can not be read. | 
Reimplemented in te::gdal::Band.
It returns the band product (pixel by pixel).
| rhs | The band to be multiplied, right-hand side. | 
      
  | 
  virtualinherited | 
It returns the product of a constant value to all pixels in the band.
| cvalue | The constant value to be multiplied. | 
It returns the band sum (pixel by pixel).
| rhs | The band to be added, right-hand side. | 
      
  | 
  virtualinherited | 
It returns the sum of a constant value to all pixels in the band.
| cvalue | The constant value to be added. | 
It returns the band subtraction (pixel by pixel).
| rhs | The band to be subtracted, right-hand side. | 
      
  | 
  virtualinherited | 
It returns the difference from all pixels in the band to a constant value (pixel - constant).
| cvalue | The constant value to be subtracted. | 
It returns the band division (pixel by pixel).
| rhs | The band to be divided, right-hand side. | 
      
  | 
  virtualinherited | 
It returns the division of all pixels in the band by a constant value (pixel / constant).
| cvalue | The constant value to be divided. | 
      
  | 
  virtual | 
It reads and returns a data block.
| x | The block-id in x (or x-offset). | 
| y | The block-id in y (or y-offset). | 
Implements te::rst::Band.
      
  | 
  virtual | 
It reads a data block to the specified buffer.
| x | The block-id in x (or x-offset). | 
| y | The block-id in y (or y-offset). | 
| buffer | The buffer to be used to read from the band. | 
Implements te::rst::Band.
      
  | 
  virtual | 
Sets the imaginary attribute value in a complex band of a cell.
| c | The column location of the cell. | 
| r | The row location of the cell. | 
| value | The attribute value to be assigned. | 
| Exception | Subclasses may throw an exception if the data value can not be write. | 
Implements te::rst::Band.
      
  | 
  inherited | 
Sets the offset values (real and imaginary) to be applied to the band.
| o | The new offset. | 
| void te::mem::Band::setRaster | ( | Raster * | r | ) | 
      
  | 
  inherited | 
Sets the scale values (real and imaginary) to be applied to the band.
| s | The new scale. | 
      
  | 
  virtual | 
Sets the cell attribute value.
| c | The column location of the cell. | 
| r | The row location of the cell. | 
| value | The attribute value to be assigned. | 
| Exception | Subclasses may throw an exception if the data value can not be write. | 
Implements te::rst::Band.
      
  | 
  virtualinherited | 
Sets the imaginary attribute value in a complex band of a cell.
| c | The column location of the cell. | 
| r | The row location of the cell. | 
| value | The complex attribute value to be assigned (real, imaginary). | 
| Exception | Subclasses may throw an exception if the data value can not be write. | 
Reimplemented in te::gdal::Band.
      
  | 
  virtual | 
It writes a data block from the specified buffer.
| x | The block-id in x (or x-offset). | 
| y | The block-id in y (or y-offset). | 
| buffer | The buffer to be used to write to the band. | 
Implements te::rst::Band.
      
  | 
  private | 
      
  | 
  private | 
      
  | 
  private | 
      
  | 
  protectedinherited | 
      
  | 
  protectedinherited | 
      
  | 
  private | 
      
  | 
  private | 
      
  | 
  private |