Packages

c

geotrellis.raster

DelegatingTile

abstract class DelegatingTile extends Tile

A tile that wraps another tile. Originally intended for delayed reading, but useful in other special use cases.

Since

8/22/18

Linear Supertypes
Tile, MappableTile[Tile], MacroMappableTile[Tile], IterableTile, MacroIterableTile, CellGrid[Int], GridIntegral[Int], Grid[Int], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DelegatingTile
  2. Tile
  3. MappableTile
  4. MacroMappableTile
  5. IterableTile
  6. MacroIterableTile
  7. CellGrid
  8. GridIntegral
  9. Grid
  10. Serializable
  11. Serializable
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DelegatingTile()

Concrete Value Members

  1. def cellType: CellType
    Definition Classes
    DelegatingTile → CellGrid
  2. def 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
    DelegatingTile → Tile → Grid
  3. def combine(r2: Tile)(f: (Int, Int) ⇒ Int): Tile

    Combine the given Tile with the present one using the given function.

    Combine the given Tile with the present one using the given function.

    Definition Classes
    DelegatingTile → Tile
  4. def combineDouble(r2: Tile)(f: (Double, Double) ⇒ Double): Tile

    Combine the given Tile with the present one using the given function.

    Combine the given Tile with the present one using the given function.

    Definition Classes
    DelegatingTile → Tile
  5. def convert(cellType: CellType): Tile

    Converts the cell type of the tile.

    Converts the cell type of the tile.

    Definition Classes
    DelegatingTile → Tile
    Note

    This will immediately iterate over the tile and allocate a new copy of data; this should be a performance consideration.

  6. def dimensions: Dimensions[Int]
    Definition Classes
    GridIntegral → Grid
  7. 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
  8. 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
  9. 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
  10. 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
  11. 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
  12. 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.

  13. 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
  14. def foreach(f: (Int) ⇒ Unit): Unit

    Execute the given function at each pixel of the present Tile.

    Execute the given function at each pixel of the present Tile.

    Definition Classes
    DelegatingTile → Tile
  15. 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
  16. def foreachDouble(f: (Double) ⇒ Unit): Unit

    Execute the given function at each pixel of the present Tile.

    Execute the given function at each pixel of the present Tile.

    Definition Classes
    DelegatingTile → Tile
  17. 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
  18. def foreachDoubleVisitor(visitor: DoubleTileVisitor): Unit
    Definition Classes
    DelegatingTile → MacroIterableTile
  19. def foreachIntVisitor(visitor: IntTileVisitor): Unit
    Definition Classes
    DelegatingTile → MacroIterableTile
  20. def get(col: Int, row: Int): Int

    Get value at given coordinates.

    Get value at given coordinates.

    Definition Classes
    DelegatingTile → Tile
  21. def getDouble(col: Int, row: Int): Double

    Get value at given coordinates.

    Get value at given coordinates.

    Definition Classes
    DelegatingTile → Tile
  22. 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
    DelegatingTile → Tile
  23. def isNoDataTile: Boolean
    Definition Classes
    Tile
  24. def map(f: (Int) ⇒ Int): Tile

    Map the given function across the present Tile.

    Map the given function across the present Tile. The result is another Tile.

    Values can also be mapped with "class-break logic":

    import geotrellis.raster.render.BreakMap

// Maps break values to result values
val m: Map[Int, Int] = ...
val t: Tile = ...

// BreakMap extends `Function1`
t.map(BreakMap.i2i(m))

    If Tile above had an underlying floating CellType, then the transformation would effectively be from Double => Int.

    Definition Classes
    DelegatingTile → Tile
  25. 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
  26. def mapDouble(f: (Double) ⇒ Double): Tile

    Map the given function across the present Tile.

    Map the given function across the present Tile. The result is another Tile.

    Values can also be mapped with "class-break logic":

    import geotrellis.raster.render.BreakMap

// Maps break values to result values
val m: Map[Double, Double] = ...
val t: Tile = ...

// BreakMap extends `Function1`
t.mapDouble(BreakMap.i2i(m))

    If Tile above had an underlying integer CellType, then the transformation would effectively be from Int => Double.

    Definition Classes
    DelegatingTile → Tile
  27. 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
  28. def mapDoubleMapper(mapper: DoubleTileMapper): Tile
    Definition Classes
    DelegatingTile → MacroMappableTile
  29. 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
  30. 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
  31. def mapIntMapper(mapper: IntTileMapper): Tile
    Definition Classes
    DelegatingTile → MacroMappableTile
  32. def mutable: MutableArrayTile

    Returns a mutable instance of this tile.

    Returns a mutable instance of this tile.

    Definition Classes
    DelegatingTile → Tile
    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.

  33. 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
  34. 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
  35. 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
  36. 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
  37. def rows: Int
    Definition Classes
    DelegatingTile → Tile → Grid
  38. def size: Int
    Definition Classes
    GridIntegral → Grid
  39. def toArray(): Array[Int]

    Return the data behind this Tile, or a copy, as an Array of integers.

    Return the data behind this Tile, or a copy, as an Array of integers.

    Definition Classes
    DelegatingTile → Tile
  40. def toArrayDouble(): Array[Double]

    Return the data behind this Tile, or a copy, as an Array of doubles.

    Return the data behind this Tile, or a copy, as an Array of doubles.

    Definition Classes
    DelegatingTile → Tile
  41. def toArrayTile(): ArrayTile

    Convert the present Tile to an ArrayTile.

    Convert the present Tile to an ArrayTile.

    Definition Classes
    DelegatingTile → Tile
  42. def toBytes(): Array[Byte]

    Return the data behind this Tile, or a copy, as an Array of bytes.

    Return the data behind this Tile, or a copy, as an Array of bytes.

    Definition Classes
    DelegatingTile → Tile
  43. def toString(): String
    Definition Classes
    DelegatingTile → AnyRef → Any
  44. def withNoData(noDataValue: Option[Double]): Tile
    Definition Classes
    DelegatingTile → Tile