Packages

case class GridBounds[N](colMin: N, rowMin: N, colMax: N, rowMax: N)(implicit evidence$1: Integral[N]) 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: N, rowMin: N, colMax: N, rowMax: N)(implicit arg0: Integral[N])

Value Members

  1. def -(other: GridBounds[N]): Seq[GridBounds[N]]

    Another name for the 'minus' method.

    Another name for the 'minus' method.

    other

    The other GridBounds

  2. def buffer(colBuffer: N, rowBuffer: N, clamp: Boolean = true): GridBounds[N]

    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.

  3. def buffer(bufferSize: Int): GridBounds[N]

    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.

  4. val colMax: N
  5. val colMin: N
  6. def combine(other: GridBounds[N]): GridBounds[N]

    Return the union of GridBounds.

  7. def contains(other: GridBounds[N]): Boolean

    Empty gridbounds contain nothing, though non empty gridbounds contains iteslf

  8. def contains(col: N, row: N): Boolean

    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

  9. def coordsIter: Iterator[(N, N)]

    Return the coordinates covered by the present GridBounds.

  10. def height: N
  11. def intersection(dimensions: Dimensions[N]): Option[GridBounds[N]]

    Return the intersection of the present grid and a raster of given dimensions.

    Return the intersection of the present grid and a raster of given dimensions. The raster is treated as if its upper-left corner is at cell (0, 0) relative to this grid.

    dimensions

    The dimensions of a raster

  12. def intersection(other: GridBounds[N]): Option[GridBounds[N]]

    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

  13. def intersects(dimensions: Dimensions[N]): Boolean

    Returns true if the present grid intersects a rastser of given dimensions.

    Returns true if the present grid intersects a rastser of given dimensions. The raster is treated as if its upper-left corner is at cell (0, 0) relative to this grid.

    dimensions

    The dimensions of a raster

  14. def intersects(other: GridBounds[N]): Boolean

    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

  15. def isEmpty: Boolean
  16. def minus(other: GridBounds[N]): Seq[GridBounds[N]]

    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

  17. def offset(colOffset: N, rowOffset: N): GridBounds[N]

    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.

  18. def offset(boundsOffset: N): GridBounds[N]

    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.

  19. val rowMax: N
  20. val rowMin: N
  21. def size: N
  22. def split(cols: N, rows: N): Iterator[GridBounds[N]]

    Split into windows, covering original CellBounds

  23. def toGridType[M](implicit arg0: Integral[M]): GridBounds[M]
  24. def width: N