class KernelCursor extends Cursor with MacroIterableTile with Serializable

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

Instance Constructors

  1. new KernelCursor(r: Tile, kernel: Kernel, analysisArea: GridBounds[Int])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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.

    Definition Classes
    Cursor
  5. val allCells: CellSet

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

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

    Definition Classes
    Cursor
  6. val analysisOffsetCols: Int
    Definition Classes
    Cursor
  7. val analysisOffsetRows: Int
    Definition Classes
    Cursor
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asciiDraw: String
    Definition Classes
    Cursor
  10. 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.

    Definition Classes
    Cursor
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. 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.

    Definition Classes
    Cursor
  13. def colmax: Int
    Attributes
    protected
    Definition Classes
    Cursor
  14. def colmin: Int
    Attributes
    protected
    Definition Classes
    Cursor
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. val extent: Int
    Definition Classes
    Cursor
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def focusCol: Int
    Definition Classes
    Cursor
  20. def focusRow: Int
    Definition Classes
    Cursor
  21. 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
    Definition Classes
    Cursor
  22. 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
    Definition Classes
    Cursor
  23. def foreachDoubleVisitor(f: macros.DoubleTileVisitor): Unit
    Definition Classes
    KernelCursor → MacroIterableTile
  24. def foreachIntVisitor(f: macros.IntTileVisitor): Unit
    Definition Classes
    KernelCursor → MacroIterableTile
  25. def foreachRemoved(f: (Int, Int) ⇒ Unit): Unit

    Iterates over all cell values of the raster which are no longer covered by the cursor 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 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
    Definition Classes
    Cursor
  26. macro def foreachWithWeight(f: (Int, Int, Int) ⇒ Unit): Unit
  27. macro def foreachWithWeightDouble(f: (Int, Int, Double) ⇒ Unit): Unit
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isReset: Boolean

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

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

    Definition Classes
    Cursor
  32. def move(m: Movement): Unit

    Move the cursor one cell space in a horizontal of vertical direction.

    Move the cursor one cell space in a horizontal of vertical direction. The cursor will keep track of what cells became added by this move (covered by the cursor or unmasked), and what cells became removed by this move (no longer covered by the cursor or masked when previously unmasked). The cursor will only keep the state of one move, so if two moves are done in a row, the state of the first move is forgotten. Only the difference between the cursor and it's most recent previous position are accounted for.

    param m Movement enum that represents moving the cursor Up, Down, Left or Right.

    Definition Classes
    Cursor
  33. var movement: Movement
    Definition Classes
    Cursor
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. 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.

    Definition Classes
    Cursor
  38. def row: Int

    Cursor row relative to the analysis area

    Cursor row relative to the analysis area

    Definition Classes
    Cursor
  39. def rowmax: Int
    Attributes
    protected
    Definition Classes
    Cursor
  40. def rowmin: Int
    Attributes
    protected
    Definition Classes
    Cursor
  41. 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.

    Definition Classes
    Cursor
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from MacroIterableTile

Inherited from Cursor

Inherited from AnyRef

Inherited from Any

Ungrouped