Class/Object

geotrellis.raster

RasterSource

Related Docs: object RasterSource | package raster

Permalink

abstract class RasterSource extends CellGrid[Long] with RasterMetadata

Single threaded instance of a reader that is able to read windows from larger raster. Some initilization step is expected to provide metadata about source raster

Linear Supertypes
RasterMetadata, CellGrid[Long], Grid[Long], Serializable, Serializable, AnyRef, Any
Known Subclasses
GeoTiffRasterSource, GeoTiffReprojectRasterSource, GeoTiffResampleRasterSource, MosaicRasterSource
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RasterSource
  2. RasterMetadata
  3. CellGrid
  4. Grid
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RasterSource()

    Permalink

Abstract Value Members

  1. abstract def attributes: Map[String, String]

    Permalink

    Return the "base" metadata, usually it is a zero band metadata, a metadata that is valid for the entire source and for the zero band

    Return the "base" metadata, usually it is a zero band metadata, a metadata that is valid for the entire source and for the zero band

    Definition Classes
    RasterMetadata

  2. abstract def attributesForBand(band: Int): Map[String, String]

    Permalink

    Return a per band metadata

    Return a per band metadata

    Definition Classes
    RasterMetadata

  3. abstract def bandCount: Int

    Permalink
    Definition Classes
    RasterMetadata

  4. abstract def cellType: CellType

    Permalink
    Definition Classes
    RasterMetadata

  5. abstract def convert(targetCellType: TargetCellType): RasterSource

    Permalink

  6. abstract def crs: CRS

    Permalink
    Definition Classes
    RasterMetadata

  7. abstract def gridExtent: GridExtent[Long]

    Permalink
    Definition Classes
    RasterMetadata

  8. abstract def metadata: RasterMetadata

    Permalink

    All available RasterSource metadata

  9. abstract def name: SourceName

    Permalink

    Source name, that can be a path or any name that is associated with Raster

    Source name, that can be a path or any name that is associated with Raster

    Definition Classes
    RasterMetadata

  10. abstract def read(bounds: GridBounds[Long], bands: Seq[Int]): Option[Raster[MultibandTile]]

    Permalink

    Reads a window for pixel bounds.

    Reads a window for pixel bounds. Return extent may be smaller than requested extent around raster edges. May return None if the requested extent does not overlap the raster extent.

    Annotations
    @throws( "if requested bands do not exist" )

  11. abstract def read(extent: Extent, bands: Seq[Int]): Option[Raster[MultibandTile]]

    Permalink

    Reads a window for the extent.

    Reads a window for the extent. Return extent may be smaller than requested extent around raster edges. May return None if the requested extent does not overlap the raster extent.

    Annotations
    @throws( "if requested bands do not exist" )

  12. abstract def reprojection(targetCRS: CRS, resampleTarget: ResampleTarget = DefaultTarget, method: ResampleMethod = ResampleMethod.DEFAULT, strategy: OverviewStrategy = OverviewStrategy.DEFAULT): RasterSource

    Permalink
    Attributes
    protected

  13. abstract def resample(resampleTarget: ResampleTarget, method: ResampleMethod, strategy: OverviewStrategy): RasterSource

    Permalink

  14. abstract def resolutions: List[CellSize]

    Permalink

    All available overview resolutions for this raster source

    All available overview resolutions for this raster source

    • For base RasterSource instance this will be resolutions of available overviews including the base resolution.
    • For reprojected RasterSource these resolutions represent an estimate where each cell in target CRS has approximately the same geographic coverage as a cell in the source CRS.

    For compatibility with OverviewStrategy, this list should be sorted from the most resolute cell size to the least resolute cell size, as determined by _.resolution.

    When reading raster data the underlying implementation will have to sample from one of these resolutions. It is possible that a read request for a small bounding box will results in significant IO request when the target cell size is much larger than closest available resolution.

    Definition Classes
    RasterMetadata

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 cellSize: CellSize

    Permalink

    Cell size at which rasters will be read when using this RasterSource

    Cell size at which rasters will be read when using this RasterSource

    Note: some re-sampling of underlying raster data may be required to produce this cell size.

    Definition Classes
    RasterMetadata

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. def cols: Long

    Permalink

    Raster pixel column count

    Raster pixel column count

    Definition Classes
    RasterMetadata

  8. def convert(targetCellType: CellType): RasterSource

    Permalink

    Converts the values within the RasterSource from one CellType to another.

    Converts the values within the RasterSource from one CellType to another.

    Note:

    GDALRasterSource differs in how it converts data from the other RasterSources. Please see the convert docs for GDALRasterSource for more information.

  9. lazy val convertRaster: (Raster[MultibandTile]) ⇒ Raster[MultibandTile]

    Permalink
    Attributes
    protected

  10. def dimensions: Dimensions[Long]

    Permalink
    Definition Classes
    Grid

  11. lazy val dstCellType: Option[CellType]

    Permalink
    Attributes
    protected

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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def extent: Extent

    Permalink
    Definition Classes
    RasterMetadata

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. def interpretAs(targetCellType: CellType): RasterSource

    Permalink

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. def read(bands: Seq[Int]): Option[Raster[MultibandTile]]

    Permalink

  24. def read(): Option[Raster[MultibandTile]]

    Permalink

  25. def read(bounds: GridBounds[Long]): Option[Raster[MultibandTile]]

    Permalink

  26. def read(extent: Extent): Option[Raster[MultibandTile]]

    Permalink

  27. def readBounds(bounds: Traversable[GridBounds[Long]]): Iterator[Raster[MultibandTile]]

    Permalink

  28. def readBounds(bounds: Traversable[GridBounds[Long]], bands: Seq[Int]): Iterator[Raster[MultibandTile]]

    Permalink

  29. def readExtents(extents: Traversable[Extent]): Iterator[Raster[MultibandTile]]

    Permalink

  30. def readExtents(extents: Traversable[Extent], bands: Seq[Int]): Iterator[Raster[MultibandTile]]

    Permalink

  31. def reproject(targetCRS: CRS, resampleTarget: ResampleTarget = DefaultTarget, method: ResampleMethod = ResampleMethod.DEFAULT, strategy: OverviewStrategy = OverviewStrategy.DEFAULT): RasterSource

    Permalink

    Reproject to different CRS with explicit sampling reprojectOptions.

    Reproject to different CRS with explicit sampling reprojectOptions.

    See also

    geotrellis.raster.reproject.Reproject

  32. def reprojectToGrid(targetCRS: CRS, grid: GridExtent[Long], method: ResampleMethod = ResampleMethod.DEFAULT, strategy: OverviewStrategy = OverviewStrategy.DEFAULT): RasterSource

    Permalink

    Sampling grid and resolution is defined by given GridExtent.

    Sampling grid and resolution is defined by given GridExtent. Resulting extent is the extent of the minimum enclosing pixel region of the data footprint in the target grid.

  33. def reprojectToRegion(targetCRS: CRS, region: RasterExtent, method: ResampleMethod = ResampleMethod.DEFAULT, strategy: OverviewStrategy = OverviewStrategy.DEFAULT): RasterSource

    Permalink

    Sampling grid and resolution is defined by given RasterExtent region.

    Sampling grid and resolution is defined by given RasterExtent region. The extent of the result is also taken from given RasterExtent, this region may be larger or smaller than the footprint of the data

  34. def resample(targetCols: Long, targetRows: Long, method: ResampleMethod = ResampleMethod.DEFAULT, strategy: OverviewStrategy = OverviewStrategy.DEFAULT): RasterSource

    Permalink

    Sampling grid is defined of the footprint of the data with resolution implied by column and row count.

  35. def resampleToGrid(grid: GridExtent[Long], method: ResampleMethod = ResampleMethod.DEFAULT, strategy: OverviewStrategy = OverviewStrategy.DEFAULT): RasterSource

    Permalink

    Sampling grid and resolution is defined by given GridExtent.

    Sampling grid and resolution is defined by given GridExtent. Resulting extent is the extent of the minimum enclosing pixel region of the data footprint in the target grid.

  36. def resampleToRegion(region: GridExtent[Long], method: ResampleMethod = ResampleMethod.DEFAULT, strategy: OverviewStrategy = OverviewStrategy.DEFAULT): RasterSource

    Permalink

    Sampling grid and resolution is defined by given RasterExtent region.

    Sampling grid and resolution is defined by given RasterExtent region. The extent of the result is also taken from given RasterExtent, this region may be larger or smaller than the footprint of the data

  37. def rows: Long

    Permalink

    Raster pixel row count

    Raster pixel row count

    Definition Classes
    RasterMetadata

  38. def size: Long

    Permalink
    Definition Classes
    Grid

  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  40. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  41. final def wait(): Unit

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

  42. final def wait(arg0: Long, arg1: Int): Unit

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

  43. final def wait(arg0: Long): Unit

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

Inherited from RasterMetadata

Inherited from CellGrid[Long]

Inherited from Grid[Long]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

convert

Read

Functions to read windows of data from a raster source.

reproject a

Resample

Functions to resample raster data in native projection.

Reproject

Functions to resample raster data in target projection.

Ungrouped