Class/Object

geotrellis.raster

GridBounds

Related Docs: object GridBounds | package raster

Permalink

case class GridBounds(colMin: Int, rowMin: Int, colMax: Int, rowMax: Int) extends Product with Serializable

Represents grid coordinates of a subsection of a RasterExtent. These coordinates are inclusive.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GridBounds
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GridBounds(colMin: Int, rowMin: Int, colMax: Int, rowMax: Int)

    Permalink

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def -(other: GridBounds): Seq[GridBounds]

    Permalink

    Another name for the 'minus' method.

    Another name for the 'minus' method.

    other

    The other GridBounds

  4. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  6. def buffer(colBuffer: Int, rowBuffer: Int, clamp: Boolean = true): GridBounds

    Permalink

    Creates a new GridBounds using a buffer around this GridBounds.

    Creates a new GridBounds using a buffer around this GridBounds.

    colBuffer

    The amount the cols within this GridBounds should be buffered.

    rowBuffer

    The amount the rows within this GridBounds should be buffered.

    clamp

    Determines whether or not to clamp the GridBounds to the grid such that it no value will be under 0; defaults to true. If false, then the resulting GridBounds can contain negative values outside of the grid boundaries.

    Note

    This will not buffer past 0 regardless of how much the buffer falls below it.

  7. def buffer(bufferSize: Int): GridBounds

    Permalink

    Creates a new GridBounds using a buffer around this GridBounds.

    Creates a new GridBounds using a buffer around this GridBounds.

    bufferSize

    The amount this GridBounds should be buffered by.

    Note

    This will not buffer past 0 regardless of how much the buffer falls below it.

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val colMax: Int

    Permalink
  10. val colMin: Int

    Permalink
  11. def combine(other: GridBounds): GridBounds

    Permalink

    Return the union of GridBounds.

  12. def contains(other: GridBounds): Boolean

    Permalink

    Empty gridbounds contain nothing, though non empty gridbounds contains iteslf

  13. def contains(col: Int, row: Int): Boolean

    Permalink

    Return true if the present GridBounds contains the position pointed to by the given column and row, otherwise false.

    Return true if the present GridBounds contains the position pointed to by the given column and row, otherwise false.

    col

    The column

    row

    The row

  14. def coordsIter: Iterator[(Int, Int)]

    Permalink

    Return the coordinates covered by the present GridBounds.

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

    Permalink
    Definition Classes
    AnyRef
  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 height: Int

    Permalink
  19. def intersection(other: GridBounds): Option[GridBounds]

    Permalink

    Return the intersection of the present GridBounds and the given GridBounds.

    Return the intersection of the present GridBounds and the given GridBounds.

    other

    The other GridBounds

  20. def intersection(cellGrid: CellGrid): Option[GridBounds]

    Permalink

    Return the intersection of the present GridBounds and the given CellGrid.

    Return the intersection of the present GridBounds and the given CellGrid.

    cellGrid

    The cellGrid to intersect with

  21. def intersects(other: GridBounds): Boolean

    Permalink

    Returns true if the present GridBounds and the given one intersect (including their boundaries), otherwise returns false.

    Returns true if the present GridBounds and the given one intersect (including their boundaries), otherwise returns false.

    other

    The other GridBounds

  22. def isEmpty: Boolean

    Permalink
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def minus(other: GridBounds): Seq[GridBounds]

    Permalink

    Returns the difference of the present GridBounds and the given one.

    Returns the difference of the present GridBounds and the given one. This returns a sequence, because the difference may consist of more than one GridBounds.

    other

    The other GridBounds

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

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

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

    Permalink
    Definition Classes
    AnyRef
  28. def offset(colOffset: Int, rowOffset: Int): GridBounds

    Permalink

    Offsets this GridBounds to a new location relative to its current position

    Offsets this GridBounds to a new location relative to its current position

    colOffset

    The amount the cols should be shifted.

    rowOffset

    The amount the rows should be shifted.

  29. def offset(boundsOffset: Int): GridBounds

    Permalink

    Offsets this GridBounds to a new location relative to its current position

    Offsets this GridBounds to a new location relative to its current position

    boundsOffset

    The amount the GridBounds should be shifted.

  30. val rowMax: Int

    Permalink
  31. val rowMin: Int

    Permalink
  32. def size: Long

    Permalink
  33. def split(cols: Int, rows: Int): Iterator[GridBounds]

    Permalink

    Split into windows, covering original GridBounds

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

    Permalink
    Definition Classes
    AnyRef
  35. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def width: Int

    Permalink

Deprecated Value Members

  1. def sizeLong: Long

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0) Use size instead.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped