Package org.gvsig.raster.lib.buffer.api

Interface Band

All Superinterfaces:
Cloneable, org.gvsig.tools.lang.Cloneable, org.gvsig.tools.observer.ComplexObservable, org.gvsig.tools.observer.ComplexWeakReferencingObservable, org.gvsig.tools.dispose.Disposable, org.gvsig.tools.observer.Observable, org.gvsig.tools.observer.WeakReferencingObservable
All Known Subinterfaces:
Band.BandByte, Band.BandDouble, Band.BandFloat, Band.BandInt, Band.BandShort
public interface Band extends org.gvsig.tools.lang.Cloneable, org.gvsig.tools.observer.ComplexWeakReferencingObservable, org.gvsig.tools.dispose.Disposable
Author:
fdiaz

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Band.BandByte
    A Band which elements are bytes.
    static interface 
    Band.BandDouble
    A Band which elements are doubles.
    static interface 
    Band.BandFloat
    A Band which elements are floats.
    static interface 
    Band.BandInt
    A Band which elements are integers.
    static interface 
    Band.BandShort
    A Band which elements are shorts.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    copyFrom(Band source)
    Fills this band with a copy of the source data band.
    void
    copyFrom(Band source, int row, int column)
    Fills a sector of this band with a copy of the source band data from a position.
    Object
    createRowBuffer()
    Creates an array of corresponding data type.
    void
    fetchRow(int row, Object rowBuffer)
    Fills the rowBuffer Object with the row.
    void
    fill(Object value)
    Fills the band with a unique value.
    Object
    get(int row, int column)
    Gets the corresponding value to a row and column of the band
    Double
    getAsDouble(int row, int column)
    Gets the corresponding value to a row and column of the band as a Double.
    BandInfo
    getBandInfo()
    Gets information about the specified band.
    int
    getColumns()
    Gets the number of columns of the band
    int
    getDataType()
    Gets the dataType.
    NoData
    getNoData()
    Gets the NoData value
    int
    getRows()
    Gets the number of rows of the band
    boolean
    isPaginated()
     
    boolean
    isReadOnly()
     
    void
    putRow(int row, Object rowBuffer)
    Fills the row with the rowBuffer
    void
    set(int row, int column, Object value)
    Set the value in the row and column of the band.

    Methods inherited from interface org.gvsig.tools.lang.Cloneable

    clone

    Methods inherited from interface org.gvsig.tools.observer.ComplexObservable

    beginComplexNotification, disableNotifications, enableNotifications, endComplexNotification

    Methods inherited from interface org.gvsig.tools.dispose.Disposable

    dispose

    Methods inherited from interface org.gvsig.tools.observer.Observable

    addObserver, deleteObserver, deleteObservers

  • Method Details

    • getColumns

      int getColumns()
      Gets the number of columns of the band
      Returns:
      the number of columns of the band

    • getRows

      int getRows()
      Gets the number of rows of the band
      Returns:
      the number of rows of the band

    • getDataType

      int getDataType()
      Gets the dataType. The possible data types are defined in BufferManager. The data type of the band can't be changed after being created.
      Returns:
      the data type

    • getNoData

      NoData getNoData()
      Gets the NoData value
      Returns:
      the noData of the band. Can't be null;

    • get

      Object get(int row, int column)
      Gets the corresponding value to a row and column of the band
      Parameters:
      row -
      column -
      Returns:
      value of corresponding data type.

    • getAsDouble

      Double getAsDouble(int row, int column)
      Gets the corresponding value to a row and column of the band as a Double. return null if the value is the NoData value.
      Parameters:
      row -
      column -
      Returns:

    • set

      void set(int row, int column, Object value)
      Set the value in the row and column of the band.
      Parameters:
      row -
      column -
      value -

    • fill

      void fill(Object value)
      Fills the band with a unique value. If the value is null, fills with NoData value. If NoData is undefined, do nothing.
      Parameters:
      value -

    • copyFrom

      void copyFrom(Band source) throws BandException
      Fills this band with a copy of the source data band.
      Parameters:
      source -
      Throws:
      BandException

    • copyFrom

      void copyFrom(Band source, int row, int column) throws BandException
      Fills a sector of this band with a copy of the source band data from a position.
      Parameters:
      source -
      row -
      column -
      Throws:
      BandException

    • createRowBuffer

      Object createRowBuffer()
      Creates an array of corresponding data type. The size of the array is the width of the band.
      Returns:
      an array of corresponding data type.

    • fetchRow

      void fetchRow(int row, Object rowBuffer)
      Fills the rowBuffer Object with the row.
      Parameters:
      row -
      rowBuffer -

    • putRow

      void putRow(int row, Object rowBuffer)
      Fills the row with the rowBuffer
      Parameters:
      row -
      rowBuffer -

    • isPaginated

      boolean isPaginated()
      Returns:
      true if is paginated

    • isReadOnly

      boolean isReadOnly()
      Returns:
      If supports writing or not

    • getBandInfo

      BandInfo getBandInfo()
      Gets information about the specified band. If band does not have information, it will return null
      Parameters:
      band - The specified band
      Returns:
      Returns information about specified band.