geotrellis.raster.Raster.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geotrellis-raster_2.11 Show documentation

GeoTrellis is an open source geographic data processing engine for high performance applications.

The newest version!

package geotrellis.raster

import geotrellis.proj4.CRS
import geotrellis.raster.reproject._
import geotrellis.raster.resample._
import geotrellis.vector._


/**
  * The companion object for the [[Raster]] type.
  */
object Raster {
  def apply[T <: CellGrid](feature: PolygonFeature[T]): Raster[T] =
    Raster(feature.data, feature.geom.envelope)

  /**
    * Implicit conversion from a [[Tile]], [[Extent]] pair to a
    * [[Raster]].
    */
  implicit def tupToRaster(tup: (Tile, Extent)): Raster[Tile] =
    Raster(tup._1, tup._2)

  /**
    * Implicit conversion from an [[Extent]], [[Tile]] pair to a
    * [[Raster]].
    */
  implicit def tupSwapToRaster(tup: (Extent, Tile)): Raster[Tile] =
    Raster(tup._2, tup._1)

  /**
    * Implicit conversion from a [[Raster]] to a [[CellGrid]].
    */
  implicit def rasterToTile[T <: CellGrid](r: Raster[T]): T =
    r.tile

  /**
    * Implicit conversion from a [[Raster]] to a [[PolygonFeature]].
    */
  implicit def rasterToFeature[T <: CellGrid](r: Raster[T]): PolygonFeature[T] =
    r.asFeature

  /**
    * Implicit conversion from a [[PolygonFeature]] to a [[Raster]].
    */
  implicit def featureToRaster[T <: CellGrid](feature: PolygonFeature[T]): Raster[T] =
     apply(feature)
}

/**
  * The [[Raster]] type.
  */
case class Raster[+T <: CellGrid](tile: T, extent: Extent) extends Product2[T, Extent] {

  /**
    * Return the [[RasterExtent]] that is correspondent to this
    * [[Raster]].
    */
  def rasterExtent: RasterExtent = RasterExtent(extent, tile.cols, tile.rows)

  /**
    * Return the [[CellSize]] of this [[Raster]].
    */
  def cellSize: CellSize = rasterExtent.cellSize

  def cols: Int = tile.cols
  def rows: Int = tile.rows
  def dimensions: (Int, Int) = tile.dimensions

  /**
    * Return the [[PolygonFeature]] associated with the extent of this
    * [[Raster]].
    */
  def asFeature(): PolygonFeature[T] = PolygonFeature(extent.toPolygon, tile: T)

  def mapTile[A <: CellGrid](f: T => A): Raster[A] = Raster(f(tile), extent)

  def _1: T = tile

  def _2: Extent = extent
}