geotrellis.raster.op.focal

Cursor

class Cursor extends AnyRef

Represents a cursor that can be used to iterate over cells within a focal neighborhood.

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Cursor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Cursor(r: Raster, extent: Int, reOpt: Option[RasterExtent] = scala.None)

    r

    Raster that this cursor runs over

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Cursor to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Cursor, B)

    Implicit information
    This member is added by an implicit conversion from Cursor to ArrowAssoc[Cursor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. val addedCells: CellSet

    A CellSet reperesenting unmasked cells currently within the cursor bounds, that were added by the previous cursor movement.

    A CellSet reperesenting unmasked cells currently within the cursor bounds, that were added by the previous cursor movement. If the cursor has not been moved (i.e. if isReset == true) then addedCells represents the same thing as allCells.

  9. val allCells: CellSet

    A CellSet reperesenting all unmasked cells that are within the cursor bounds.

  10. val analysisArea: AnalysisArea

  11. val analysisOffsetCols: Int

  12. val analysisOffsetRows: Int

  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def centerOn(col: Int, row: Int): Unit

    Centers the cursor on a cell of the raster.

    Centers the cursor on a cell of the raster. Added\Removed cells are not kept track of between centering moves, and centering the cursor resets the state.

    col

    Column of raster to center on.

    row

    Row of raster to center on.

  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  16. def col: Int

    Cursor column relative to the analysis area.

    Cursor column relative to the analysis area.

    For example, if the analysis area starts at col 2 and the focusX is currently 3, then the col should be 1.

  17. def ensuring(cond: (Cursor) ⇒ Boolean, msg: ⇒ Any): Cursor

    Implicit information
    This member is added by an implicit conversion from Cursor to Ensuring[Cursor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (Cursor) ⇒ Boolean): Cursor

    Implicit information
    This member is added by an implicit conversion from Cursor to Ensuring[Cursor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: ⇒ Any): Cursor

    Implicit information
    This member is added by an implicit conversion from Cursor to Ensuring[Cursor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): Cursor

    Implicit information
    This member is added by an implicit conversion from Cursor to Ensuring[Cursor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  23. val extent: Int

  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  25. def foreach(f: (Int, Int) ⇒ Unit): Unit

    Iterates over all cell values of the raster which are covered by the cursor and not masked.

    Iterates over all cell values of the raster which are covered by the cursor and not masked.

    f

    Function that receives from each cell it's col and row coordinates and it's value.

    Attributes
    protected
  26. def foreachAdded(f: (Int, Int) ⇒ Unit): Unit

    Iterates over all cell values of the raster which are covered by the cursor and not masked, that were exposed as part of the last move of the cursor.

    Iterates over all cell values of the raster which are covered by the cursor and not masked, that were exposed as part of the last move of the cursor.

    For instance, if move(Movement.Up) is called, then there will potentially be a new row that is now covered by the cursor, which are now covered. These values will be included for the iterations of this function, as well any previously masked cell values that were unmasked as part of the move.

    f

    Function that receives from each cell it's col and row coordinates and it's value.

    Attributes
    protected
  27. def foreachRemoved(f: (Int, Int) ⇒ Unit): Unit

    Iterates over all cell values of the raster which are no longer covered by the cursor that were not previously masked not masked, or that were masked when previously unmasked, as part of the last move last move of the cursor.

    Iterates over all cell values of the raster which are no longer covered by the cursor that were not previously masked not masked, or that were masked when previously unmasked, as part of the last move last move of the cursor.

    For instance, if move(Movement.Up) is called, then there will potentially be a new row at the bottom of the cursor that is now uncovered by the cursor. These values will be included for the iterations of this function, as well any previously unmasked cell values that were masked as part of the move.

    f

    Function that receives from each cell it's col and row coordinates and it's value.

    Attributes
    protected
  28. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Cursor to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  29. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  31. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  32. def isReset: Boolean

    Indicates whether or not this cursor has been moved and is tracking state between the previous position and the current position

  33. def move(m: Movement): Unit

  34. var movement: Movement

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

    Definition Classes
    AnyRef
  36. final def notify(): Unit

    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  38. val removedCells: CellSet

    A CellSet reperesenting cells that were moved outside the cursor bounds, or unmasked cells that were masked, by the previous cursor movement.

    A CellSet reperesenting cells that were moved outside the cursor bounds, or unmasked cells that were masked, by the previous cursor movement. If the cursor has not been moved this will be a no-op.

  39. def row: Int

    Cursor row relative to the analysis area

  40. def setMask(f: (Int, Int) ⇒ Boolean): Unit

    Sets the mask for this cursor.

    Sets the mask for this cursor.

    f

    Function that takes a col and row of the neighborhood coordinates and returns true if that cell should be masked. The neighborhood coordinates are the size of the cursor's bounding box, with (0,0) being the top right corner.

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

    Definition Classes
    AnyRef
  42. def toString(): String

    Definition Classes
    AnyRef → Any
  43. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  46. def [B](y: B): (Cursor, B)

    Implicit information
    This member is added by an implicit conversion from Cursor to ArrowAssoc[Cursor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Cursor to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cursor: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Cursor to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cursor: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Cursor

    Implicit information
    This member is added by an implicit conversion from Cursor to ArrowAssoc[Cursor] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cursor: ArrowAssoc[Cursor]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Cursor

    Implicit information
    This member is added by an implicit conversion from Cursor to Ensuring[Cursor] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cursor: Ensuring[Cursor]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Cursor to StringAdd

Inherited by implicit conversion any2stringfmt from Cursor to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Cursor to ArrowAssoc[Cursor]

Inherited by implicit conversion any2Ensuring from Cursor to Ensuring[Cursor]

Ungrouped