Class/Object

geotrellis.raster

GridExtent

Related Docs: object GridExtent | package raster

Permalink

class GridExtent extends Serializable

Represents an abstract grid over geographic extent. Critically while the number of cell rows and columns is implied by the constructor arguments, they are intentionally not expressed to avoid Int overflow for large grids.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GridExtent
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GridExtent(extent: Extent, cellSize: CellSize)

    Permalink
  2. new GridExtent(extent: Extent, cellwidth: Double, cellheight: Double)

    Permalink

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
  6. val cellheight: Double

    Permalink
  7. val cellwidth: Double

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def createAlignedGridExtent(targetExtent: Extent, alignmentPoint: Point): GridExtent

    Permalink

    Returns a GridExtent that with this grid's resolution.

    Returns a GridExtent that with this grid's resolution.

    This function will generate an extent that lines up with a grid having an origin at the given point and grid cells of the size given by the cellSize of the GridExtent. The resulting GridExtent, in general, will not be equal to targetExtent, but will have the smallest extent that lines up with the grid and also covers targetExtent.

  10. def createAlignedGridExtent(targetExtent: Extent): GridExtent

    Permalink

    Returns a GridExtent that lines up with this grid's resolution and grid layout.

    Returns a GridExtent that lines up with this grid's resolution and grid layout.

    This function will generate an extent that lines up with the grid indicated by the GridExtent, having an origin at the upper-left corner of the extent, and grid cells having the size given by cellSize. The resulting GridExtent, in general, will not be equal to targetExtent, but will have the smallest extent that lines up with the grid and also covers targetExtent.

  11. def createAlignedRasterExtent(targetExtent: Extent): RasterExtent

    Permalink

    Returns a RasterExtent that lines up with this RasterExtent's resolution, and grid layout.

    Returns a RasterExtent that lines up with this RasterExtent's resolution, and grid layout.

    For example, the resulting RasterExtent will not have the given extent, but will have the smallest extent such that the whole of the given extent is covered, that lines up with the grid.

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

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

    Permalink
    Definition Classes
    GridExtent → AnyRef → Any
  14. val extent: Extent

    Permalink
  15. def extentFor(gridBounds: GridBounds, clamp: Boolean = true): Extent

    Permalink

    Gets the Extent that matches the grid bounds passed in, aligned with this RasterExtent.

    Gets the Extent that matches the grid bounds passed in, aligned with this RasterExtent.

    The 'clamp' parameter determines whether or not to clamp the Extent to the extent of this RasterExtent; defaults to true. If true, the returned extent will be contained by this RasterExtent's extent, if false, the Extent returned can be outside of this RasterExtent's extent.

    gridBounds

    The extent to get the grid bounds for

    clamp

    A boolean which controlls the clamping behvior

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Permalink
    Definition Classes
    GridExtent → AnyRef → Any
  19. def isGridExtentAligned(): Boolean

    Permalink

    Tests if the grid is aligned to the extent.

    Tests if the grid is aligned to the extent. This is true when the extent is evenly divided by cellheight and cellwidth.

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toRasterExtent(): RasterExtent

    Permalink

    Creates a RasterExtent out of this GridExtent.

    Creates a RasterExtent out of this GridExtent.

    Note

    Use with caution: if the number of columns or rows are larger than Int.MaxValue, this will throw an exception. Also, if columns * rows > Int.MaxValue, this will create a RasterExtent for a raster that could not be backed by any of the Array-backed tile types.

  26. def toString(): String

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped