Packages

final case class BitArrayTile(array: Array[Byte], cols: Int, rows: Int) extends MutableArrayTile with Product with Serializable

ArrayTile based on an Array[Byte] as a bitmask; values are 0 and 1. Thus, there are 8 boolean (0 / 1) values per byte in the array. For example, Array(11, 9) corresponds to (0 0 0 0 1 0 1 1), (0 0 0 0 1 0 0 1) which means that we have 5 cells set to 1 and 11 cells set to 0.

Note that unlike the other array-based raster data objects we need to be explicitly told our size, since length=7 and length=8 will both need to allocate an Array[Byte] with length=1.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BitArrayTile
  2. Product
  3. Equals
  4. MutableArrayTile
  5. ArrayTile
  6. Tile
  7. MappableTile
  8. MacroMappableTile
  9. IterableTile
  10. MacroIterableTile
  11. CellGrid
  12. GridIntegral
  13. Grid
  14. Serializable
  15. Serializable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BitArrayTile(array: Array[Byte], cols: Int, rows: Int)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(i: Int): Int

    Get the datum at the specified index.

    Get the datum at the specified index.

    i

    The index of the datum

    returns

    The datum

    Definition Classes
    BitArrayTileArrayTile
  5. def applyDouble(i: Int): Double

    Get the datum at the specified index.

    Get the datum at the specified index.

    i

    The index of the datum

    returns

    The datum as a double

    Definition Classes
    BitArrayTileArrayTile
  6. val array: Array[Byte]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val cellType: BitCellType.type
    Definition Classes
    BitArrayTileCellGrid
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. val cols: Int

    cols and rows are explicitly defined to help with the Grid[N].{cols | rows} specialized functions dispatch.

    cols and rows are explicitly defined to help with the Grid[N].{cols | rows} specialized functions dispatch. See https://github.com/locationtech/geotrellis/issues/3427

    Definition Classes
    BitArrayTileMutableArrayTileArrayTileTileGrid
  11. def combine(other: Tile)(f: (Int, Int) ⇒ Int): Tile

    Combine the cells of an ArrayTile and a Tile into a new Tile using the given function.

    Combine the cells of an ArrayTile and a Tile into a new Tile using the given function. For every (x, y) cell coordinate, get each of the Tiles' integer value, map them to a new value, and assign it to the output's (x, y) cell.

    other

    The other Tile

    f

    A function from (Int, Int) to Int

    returns

    The result, an Tile

    Definition Classes
    ArrayTileTile
  12. def combine(other: ArrayTile)(f: (Int, Int) ⇒ Int): ArrayTile

    Combine two ArrayTiles' cells into new cells using the given integer function.

    Combine two ArrayTiles' cells into new cells using the given integer function. For every (x, y) cell coordinate, get each of the ArrayTiles' integer values, map them to a new value, and assign it to the output's (x, y) cell.

    other

    The other ArrayTile

    f

    A function from (Int, Int) to Int

    returns

    The result, an ArrayTile

    Definition Classes
    ArrayTile
  13. def combineDouble(other: Tile)(f: (Double, Double) ⇒ Double): Tile

    Combine the cells of an ArrayTile and a Tile into a new Tile using the given function.

    Combine the cells of an ArrayTile and a Tile into a new Tile using the given function. For every (x, y) cell coordinate, get tiles' double values, map them to a new value, and assign it to the output's (x, y) cell.

    other

    The other Tile

    f

    A function from (Double, Double) to Double

    returns

    The result, an Tile

    Definition Classes
    ArrayTileTile
  14. def combineDouble(other: ArrayTile)(f: (Double, Double) ⇒ Double): ArrayTile

    Combine two ArrayTiles' cells into new cells using the given double function.

    Combine two ArrayTiles' cells into new cells using the given double function. For every (x, y) cell coordinate, get each of the ArrayTiles' double values, map them to a new value, and assign it to the output's (x, y) cell.

    other

    The other ArrayTile

    f

    A function from (Double, Double) to Double

    returns

    The result, an ArrayTile

    Definition Classes
    ArrayTile
  15. def convert(targetCellType: CellType): ArrayTile

    Returns a Tile equivalent to this ArrayTile, except with cells of the given type.

    Returns a Tile equivalent to this ArrayTile, except with cells of the given type.

    targetCellType

    The type of cells that the result should have

    returns

    The new Tile

    Definition Classes
    ArrayTileTile
  16. def copy: BitArrayTile

    Return a copy of the present BitArrayTile.

    Return a copy of the present BitArrayTile.

    returns

    The copy

    Definition Classes
    BitArrayTileArrayTile
  17. def dimensions: Dimensions[Int]
    Definition Classes
    GridIntegralGrid
  18. def downsample(newCols: Int, newRows: Int)(f: (CellSet) ⇒ Int): Tile

    Reduce the resolution of the present Tile to the given number of columns and rows.

    Reduce the resolution of the present Tile to the given number of columns and rows. A new Tile is returned.

    newCols

    The number of columns in the new Tile

    newRows

    The number of rows in the new Tile

    Definition Classes
    Tile
  19. def dualCombine(r2: Tile)(f: (Int, Int) ⇒ Int)(g: (Double, Double) ⇒ Double): Tile

    Combine two Tiles together using one of two given functions.

    Combine two Tiles together using one of two given functions. If the union of the types of the two cells is floating-point, then the floating function is used, otherwise the integer function is used.

    r2

    The tile to combine with the present one

    f

    The integer function

    g

    The double function

    Definition Classes
    Tile
  20. def dualForeach(f: (Int) ⇒ Unit)(g: (Double) ⇒ Unit): Unit

    Execute a function at each pixel of a Tile.

    Execute a function at each pixel of a Tile. Two functions are given: an integer version which is used if the tile is an integer-tile, and the other in the case of a floating-tile.

    f

    A function from Int to Unit

    g

    A function from Double to Unit

    Definition Classes
    Tile
  21. def dualMap(f: (Int) ⇒ Int)(g: (Double) ⇒ Double): Tile

    Map one of the two given functions across the Tile to produce a new one.

    Map one of the two given functions across the Tile to produce a new one. One of the functions is from Int to Int, and the other from Double to Double.

    f

    A function from Int to Int

    g

    A function from Double to Double

    Definition Classes
    Tile
  22. def dualMapIfSet(f: (Int) ⇒ Int)(g: (Double) ⇒ Double): Tile

    Conditionally map across the Tile with one of two functions, depending on whether the tile is an integer- or a floating-tile.

    Conditionally map across the Tile with one of two functions, depending on whether the tile is an integer- or a floating-tile. A pixel is mapped only if it is set.

    f

    A function from Int to Int

    g

    A function from Double to Double

    Definition Classes
    Tile
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(other: Any): Boolean

    Check for equality between the present ArrayTile and any other object.

    Check for equality between the present ArrayTile and any other object.

    other

    The other object

    returns

    A boolean

    Definition Classes
    ArrayTile → AnyRef → Any
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def findMinMax: (Int, Int)

    Return tuple of highest and lowest value in raster.

    Return tuple of highest and lowest value in raster.

    Definition Classes
    Tile
    Note

    Currently does not support double valued raster data types (FloatConstantNoDataCellType, DoubleConstantNoDataCellType). Calling findMinMax on rasters of those types will give the integer min and max of the rounded values of their cells.

  27. def findMinMaxDouble: (Double, Double)

    Return tuple of highest and lowest value in raster.

    Return tuple of highest and lowest value in raster.

    Definition Classes
    Tile
  28. def foreach(f: (Int) ⇒ Unit): Unit

    Execute a function on each cell of the ArrayTile.

    Execute a function on each cell of the ArrayTile.

    f

    A function from Int to Unit. Presumably, the function is executed for side-effects.

    Definition Classes
    ArrayTileTile
  29. macro def foreach(f: (Int, Int, Int) ⇒ Unit): Unit

    Execute the given function 'f' at every location in the tile.

    Execute the given function 'f' at every location in the tile. The function 'f' takes the column, row, and value and returns nothing (presumably for side-effects).

    Definition Classes
    IterableTile
  30. def foreachDouble(f: (Double) ⇒ Unit): Unit

    Execute a function on each cell of the ArrayTile.

    Execute a function on each cell of the ArrayTile.

    f

    A function from Double to Unit. Presumably, the function is executed for side-effects.

    Definition Classes
    ArrayTileTile
  31. macro def foreachDouble(f: (Int, Int, Double) ⇒ Unit): Unit

    Execute the given function 'f' at every location in the tile.

    Execute the given function 'f' at every location in the tile. The function 'f' takes the column, row, and value, the last one as a double, and returns nothing (presumably for side-effects).

    Definition Classes
    IterableTile
  32. def foreachDoubleVisitor(visitor: DoubleTileVisitor): Unit

    Execute an DoubleTileVisitor at each cell of the ArrayTile.

    Execute an DoubleTileVisitor at each cell of the ArrayTile.

    visitor

    A DoubleTileVisitor

    Definition Classes
    ArrayTileMacroIterableTile
  33. def foreachIntVisitor(visitor: IntTileVisitor): Unit

    Execute an IntTileVisitor at each cell of the ArrayTile.

    Execute an IntTileVisitor at each cell of the ArrayTile.

    visitor

    An IntTileVisitor

    Definition Classes
    ArrayTileMacroIterableTile
  34. def get(col: Int, row: Int): Int

    Fetch the datum at the given column and row of the ArrayTile.

    Fetch the datum at the given column and row of the ArrayTile.

    col

    The column

    row

    The row

    returns

    The Int datum found at the given location

    Definition Classes
    ArrayTileTile
  35. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def getDouble(col: Int, row: Int): Double

    Fetch the datum at the given column and row of the ArrayTile.

    Fetch the datum at the given column and row of the ArrayTile.

    col

    The column

    row

    The row

    returns

    The Double datum found at the given location

    Definition Classes
    ArrayTileTile
  37. def interpretAs(newCellType: CellType): Tile

    Changes the interpretation of the tile cells through changing NoData handling and optionally cell data type.

    Changes the interpretation of the tile cells through changing NoData handling and optionally cell data type. If DataType portion of the CellType is unchanged the tile data is not duplicated through conversion. If cell DataType conversion is required it is done in a naive way, without considering NoData handling.

    newCellType

    CellType to be used in interpreting existing cells

    Definition Classes
    BitArrayTileArrayTileTile
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. def isNoDataTile: Boolean
    Definition Classes
    Tile
  40. def map(f: (Int) ⇒ Int): Tile

    Map each cell in the given raster to a new one, using the given function.

    Map each cell in the given raster to a new one, using the given function.

    f

    A function from Int to Int, executed at each point of the BitArrayTile

    returns

    The result, a Tile

    Definition Classes
    BitArrayTileArrayTileTile
  41. macro def map(f: (Int, Int, Int) ⇒ Int): Tile

    Map over the tiles using a function which accepts the column, row, and value at that position and returns an integer.

    Map over the tiles using a function which accepts the column, row, and value at that position and returns an integer.

    Definition Classes
    MappableTile
  42. def mapDouble(f: (Double) ⇒ Double): Tile

    Map each cell in the given raster to a new one, using the given function.

    Map each cell in the given raster to a new one, using the given function.

    f

    A function from Double to Double, executed at each point of the BitArrayTile

    returns

    The result, a Tile

    Definition Classes
    BitArrayTileArrayTileTile
  43. macro def mapDouble(f: (Int, Int, Double) ⇒ Double): Tile

    Map over the tiles using a function which accepts the column, row, and value at that position and returns a double.

    Map over the tiles using a function which accepts the column, row, and value at that position and returns a double.

    Definition Classes
    MappableTile
  44. def mapDoubleMapper(mapper: DoubleTileMapper): Tile

    Map an DoubleTileMapper over the present tile.

    Map an DoubleTileMapper over the present tile.

    mapper

    The mapper

    returns

    The result, a Tile

    Definition Classes
    ArrayTileMacroMappableTile
  45. def mapIfSet(f: (Int) ⇒ Int): Tile

    Conditionally execute (or don't) the given function at each pixel of a Tile, depending on whether that pixel is NODATA or not.

    Conditionally execute (or don't) the given function at each pixel of a Tile, depending on whether that pixel is NODATA or not. The result of the mapping is returned as a tile.

    f

    A function from Int to Int

    Definition Classes
    Tile
  46. def mapIfSetDouble(f: (Double) ⇒ Double): Tile

    Conditionally execute (or don't) the given function at each pixel of a Tile, depending on whether that pixel is NODATA or not.

    Conditionally execute (or don't) the given function at each pixel of a Tile, depending on whether that pixel is NODATA or not. The result of the mapping is returned as a tile.

    f

    A function from Double to Double

    Definition Classes
    Tile
  47. def mapIntMapper(mapper: IntTileMapper): Tile

    Map an IntTileMapper over the present tile.

    Map an IntTileMapper over the present tile.

    mapper

    The mapper

    returns

    The result, a Tile

    Definition Classes
    ArrayTileMacroMappableTile
  48. def mutable: MutableArrayTile

    Returns a mutable instance of this tile.

    Returns a mutable instance of this tile.

    Definition Classes
    MutableArrayTileTile
    Note

    When the underlying class is an instance of MutableArrayTile it will return itself without performing a copy. This is used internally as a performance optimization when the ownership of the tile is controlled.

  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. def normalize(oldMin: Double, oldMax: Double, newMin: Double, newMax: Double): Tile

    Normalizes the values of this raster, given the current min and max, to a new min and max.

    Normalizes the values of this raster, given the current min and max, to a new min and max.

    oldMin

    Old minimum value

    oldMax

    Old maximum value

    newMin

    New minimum value

    newMax

    New maximum value

    Definition Classes
    Tile
  51. def normalize(oldMin: Int, oldMax: Int, newMin: Int, newMax: Int): Tile

    Normalizes the values of this raster, given the current min and max, to a new min and max.

    Normalizes the values of this raster, given the current min and max, to a new min and max.

    oldMin

    Old minimum value

    oldMax

    Old maximum value

    newMin

    New minimum value

    newMax

    New maximum value

    Definition Classes
    Tile
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. def rescale(newMin: Double, newMax: Double): Tile

    Rescale the values in this Tile so that they are between the two given values.

    Rescale the values in this Tile so that they are between the two given values.

    Definition Classes
    Tile
  55. def rescale(newMin: Int, newMax: Int): Tile

    Rescale the values in this Tile so that they are between the two given values.

    Rescale the values in this Tile so that they are between the two given values.

    Definition Classes
    Tile
  56. val rows: Int
    Definition Classes
    BitArrayTileMutableArrayTileArrayTileTileGrid
  57. def set(col: Int, row: Int, value: Int): Unit

    Set the value of the raster at the given column and row with the given value.

    Set the value of the raster at the given column and row with the given value.

    col

    The column

    row

    The row

    value

    The value

    Definition Classes
    MutableArrayTile
  58. def setDouble(col: Int, row: Int, value: Double): Unit

    Set the value of the raster at the given column and row with the given value.

    Set the value of the raster at the given column and row with the given value.

    col

    The column

    row

    The row

    value

    The value

    Definition Classes
    MutableArrayTile
  59. def size: Int
    Definition Classes
    GridIntegralGrid
  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. def toArray(): Array[Int]

    Return a copy of the underlying array of the present ArrayTile.

    Return a copy of the underlying array of the present ArrayTile.

    returns

    The copy as an Array[Int]

    Definition Classes
    ArrayTileTile
  62. def toArrayDouble(): Array[Double]

    Return a copy of the underlying array of the present ArrayTile.

    Return a copy of the underlying array of the present ArrayTile.

    returns

    The copy as an Array[Double]

    Definition Classes
    ArrayTileTile
  63. def toArrayTile(): ArrayTile

    Return the ArrayTile equivalent of this ArrayTile.

    Return the ArrayTile equivalent of this ArrayTile.

    returns

    The object on which the method was invoked

    Definition Classes
    ArrayTileTile
  64. def toBytes(): Array[Byte]

    Convert the present BitArrayTile to an array of bytes and return that array.

    Convert the present BitArrayTile to an array of bytes and return that array.

    returns

    An array of bytes

    Definition Classes
    BitArrayTileTile
  65. def toList: List[Int]

    Return the underlying array of this ArrayTile as a list.

    Return the underlying array of this ArrayTile as a list.

    returns

    The list

    Definition Classes
    ArrayTile
  66. def toListDouble: List[Double]

    Return the under-laying array of this ArrayTile as a list.

    Return the under-laying array of this ArrayTile as a list.

    returns

    The list

    Definition Classes
    ArrayTile
  67. def toString(): String
    Definition Classes
    ArrayTile → AnyRef → Any
  68. def update(i: Int, z: Int): Unit

    Update the datum at the specified index.

    Update the datum at the specified index.

    i

    The index of the datum

    z

    The datum

    Definition Classes
    BitArrayTileMutableArrayTile
  69. def update(colOffset: Int, rowOffset: Int, update: Tile): Unit

    Paste the given Tile into the present one starting at the given column and row offsets.

    Paste the given Tile into the present one starting at the given column and row offsets.

    colOffset

    The column offset

    rowOffset

    The row offset

    update

    The source tile

    Definition Classes
    MutableArrayTile
  70. def updateDouble(i: Int, z: Double): Unit

    Update the datum at the specified index.

    Update the datum at the specified index.

    i

    The index of the datum

    z

    The datum

    Definition Classes
    BitArrayTileMutableArrayTile
  71. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  74. def withNoData(noDataValue: Option[Double]): Tile
    Definition Classes
    BitArrayTileArrayTileTile

Inherited from Product

Inherited from Equals

Inherited from MutableArrayTile

Inherited from ArrayTile

Inherited from Tile

Inherited from MappableTile[Tile]

Inherited from MacroMappableTile[Tile]

Inherited from IterableTile

Inherited from MacroIterableTile

Inherited from CellGrid[Int]

Inherited from GridIntegral[Int]

Inherited from Grid[Int]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped