Trait

geotrellis.raster

Tile

Related Doc: package raster

Permalink

trait Tile extends CellGrid with IterableTile with MappableTile[Tile] with LazyLogging

Base trait for a Tile.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tile
  2. LazyLogging
  3. MappableTile
  4. MacroMappableTile
  5. IterableTile
  6. MacroIterableTile
  7. CellGrid
  8. Grid
  9. Serializable
  10. Serializable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cellType: CellType

    Permalink
    Definition Classes
    CellGrid
  2. abstract def cols: Int

    Permalink
    Definition Classes
    Grid
  3. abstract def combine(r2: Tile)(f: (Int, Int) ⇒ Int): Tile

    Permalink

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

  4. abstract def combineDouble(r2: Tile)(f: (Double, Double) ⇒ Double): Tile

    Permalink

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

  5. abstract def convert(cellType: CellType): Tile

    Permalink

    Converts the cell type of the tile.

    Converts the cell type of the tile.

    Note

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

  6. abstract def foreach(f: (Int) ⇒ Unit): Unit

    Permalink

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

  7. abstract def foreachDouble(f: (Double) ⇒ Unit): Unit

    Permalink

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

  8. abstract def foreachDoubleVisitor(visitor: macros.DoubleTileVisitor): Unit

    Permalink
    Definition Classes
    MacroIterableTile
  9. abstract def foreachIntVisitor(visitor: macros.IntTileVisitor): Unit

    Permalink
    Definition Classes
    MacroIterableTile
  10. abstract def get(col: Int, row: Int): Int

    Permalink

    Get value at given coordinates.

  11. abstract def getDouble(col: Int, row: Int): Double

    Permalink

    Get value at given coordinates.

  12. abstract def interpretAs(newCellType: CellType): Tile

    Permalink

    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

  13. abstract def map(f: (Int) ⇒ Int): Tile

    Permalink

    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.

  14. abstract def mapDouble(f: (Double) ⇒ Double): Tile

    Permalink

    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.

  15. abstract def mapDoubleMapper(mapper: macros.DoubleTileMapper): Tile

    Permalink
    Definition Classes
    MacroMappableTile
  16. abstract def mapIntMapper(mapper: macros.IntTileMapper): Tile

    Permalink
    Definition Classes
    MacroMappableTile
  17. abstract def mutable: MutableArrayTile

    Permalink

    Returns a mutable instance of this tile.

    Returns a mutable instance of this 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.

  18. abstract def rows: Int

    Permalink
    Definition Classes
    Grid
  19. abstract def toArray(): Array[Int]

    Permalink

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

  20. abstract def toArrayDouble(): Array[Double]

    Permalink

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

  21. abstract def toArrayTile(): ArrayTile

    Permalink

    Convert the present Tile to an ArrayTile.

  22. abstract def toBytes(): Array[Byte]

    Permalink

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

  23. abstract def withNoData(noDataValue: Option[Double]): Tile

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def dimensions: (Int, Int)

    Permalink
    Definition Classes
    Grid
  7. def downsample(newCols: Int, newRows: Int)(f: (CellSet) ⇒ Int): Tile

    Permalink

    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

  8. def dualCombine(r2: Tile)(f: (Int, Int) ⇒ Int)(g: (Double, Double) ⇒ Double): Tile

    Permalink

    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

  9. def dualForeach(f: (Int) ⇒ Unit)(g: (Double) ⇒ Unit): Unit

    Permalink

    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

  10. def dualMap(f: (Int) ⇒ Int)(g: (Double) ⇒ Double): Tile

    Permalink

    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

  11. def dualMapIfSet(f: (Int) ⇒ Int)(g: (Double) ⇒ Double): Tile

    Permalink

    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

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def findMinMax: (Int, Int)

    Permalink

    Return tuple of highest and lowest value in raster.

    Return tuple of highest and lowest value in raster.

    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.

  16. def findMinMaxDouble: (Double, Double)

    Permalink

    Return tuple of highest and lowest value in raster.

  17. macro def foreach(f: (Int, Int, Int) ⇒ Unit): Unit

    Permalink

    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
  18. macro def foreachDouble(f: (Int, Int, Double) ⇒ Unit): Unit

    Permalink

    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
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def gridBounds: GridBounds

    Permalink
    Definition Classes
    Grid
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def isNoDataTile: Boolean

    Permalink
  24. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  25. macro def map(f: (Int, Int, Int) ⇒ Int): Tile

    Permalink

    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. macro def mapDouble(f: (Int, Int, Double) ⇒ Double): Tile

    Permalink

    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
  27. def mapIfSet(f: (Int) ⇒ Int): Tile

    Permalink

    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

  28. def mapIfSetDouble(f: (Double) ⇒ Double): Tile

    Permalink

    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

  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. def normalize(oldMin: Double, oldMax: Double, newMin: Double, newMax: Double): Tile

    Permalink

    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

  31. def normalize(oldMin: Int, oldMax: Int, newMin: Int, newMax: Int): Tile

    Permalink

    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

  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. def rescale(newMin: Double, newMax: Double): Tile

    Permalink

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

  35. def rescale(newMin: Int, newMax: Int): Tile

    Permalink

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

  36. def size: Int

    Permalink

    The size of the grid, e.g.

    The size of the grid, e.g. cols * rows.

    Definition Classes
    Grid
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  39. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from LazyLogging

Inherited from MappableTile[Tile]

Inherited from MacroMappableTile[Tile]

Inherited from IterableTile

Inherited from MacroIterableTile

Inherited from CellGrid

Inherited from Grid

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped