package focal

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class Annulus(innerRadius: Double, outerRadius: Double) extends Neighborhood with Product with Serializable

    Annulus neighborhood.

    Annulus neighborhood.

    innerRadius

    The radius of the inner circle of the Annulus.

    outerRadius

    The radius of the outer circle of the Annulus.

    Note

    Cells who's distance from the center is exactly the inner or outer radius are included in the neighborhood.

  2. trait ArrayTileResult extends Resulting[Tile]
  3. trait BitArrayTileResult extends Resulting[Tile]

    Defines a focal calculation as returning a Tile with BitArrayTile, and defines the Initialization.init function for setting up the tile.

  4. trait BufferTileFocalMethods extends MethodExtensions[BufferTile]
  5. trait ByteArrayTileResult extends Resulting[Tile]

    Defines a focal calculation as returning a Tile with ByteArrayTile, and defines the Initialization.init function for setting up the tile.

  6. abstract class CellwiseCalculation[T] extends FocalCalculation[T]

    A focal calculation that uses the Cellwise focal strategy

  7. class CellwiseDoubleSumCalc extends CellwiseCalculation[Tile] with ArrayTileResult
  8. class CellwiseMeanCalc extends CellwiseCalculation[Tile] with DoubleArrayTileResult
  9. class CellwiseMeanCalcDouble extends CellwiseCalculation[Tile] with DoubleArrayTileResult
  10. class CellwiseMedianCalc extends CellwiseCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
  11. class CellwiseModeCalc extends CellwiseCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
  12. trait CellwiseStrategyCalculation extends AnyRef
  13. class CellwiseSumCalc extends CellwiseCalculation[Tile] with ArrayTileResult
  14. case class Circle(radius: Double) extends Neighborhood with Product with Serializable

    A circle neighborhood.

    A circle neighborhood.

    radius

    Radius of the circle that defines which cells inside the bounding box will be considered part of the neighborhood.

    Note

    Cells who's distance from the center is exactly the radius are included in the neighborhood.

  15. class Cursor extends AnyRef

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

  16. abstract class CursorCalculation[T] extends FocalCalculation[T]

    A focal calculation that uses the Cursor focal strategy.

  17. class CursorDoubleSumCalc extends CursorCalculation[Tile] with ArrayTileResult
  18. class CursorMask extends AnyRef

    A mask over a cursor.

    A mask over a cursor. The CursorMask helps the cursor keep track of the state of masking and unmasking of cells between moves.

  19. class CursorMeanCalc extends CursorCalculation[Tile] with DoubleArrayTileResult
  20. class CursorMeanCalcDouble extends CursorCalculation[Tile] with DoubleArrayTileResult
  21. class CursorMedianCalc extends CursorCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
  22. class CursorModeCalc extends CursorCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
  23. class CursorSumCalc extends CursorCalculation[Tile] with ArrayTileResult
  24. trait DoubleArrayTileResult extends Resulting[Tile]

    Defines a focal calculation as returning a Tile with DoubleArrayTile, and defines the Initialization.init function for setting up the tile.

  25. trait FloatArrayTileResult extends Resulting[Tile]

    Defines a focal calculation as returning a Tile with FloatArrayTile, and defines the Initialization.init function for setting up the tile.

  26. abstract class FocalCalculation[T] extends Resulting[T]

    A calculation that a FocalStrategy uses to complete a focal operation.

  27. trait FocalMethods extends MethodExtensions[Tile]
  28. trait Implicits extends AnyRef
  29. trait IntArrayTileResult extends Resulting[Tile]

    Defines a focal calculation as returning a Tile with IntArrayTile, and defines the Initialization.init function for setting up the tile.

  30. case class Kernel(tile: Tile) extends Neighborhood with Product with Serializable

    Kernel

    Kernel

    Represents a neighborhood that is represented by a tile.

  31. abstract class KernelCalculation[T] extends FocalCalculation[T]

    A focal calculation that uses the Cursor focal strategy.

  32. class KernelCursor extends Cursor with MacroIterableTile with Serializable
  33. trait MedianModeCalculation extends AnyRef
  34. sealed trait Movement extends AnyRef
  35. trait Neighborhood extends Serializable

    A definition of the shape and size of the neighborhood (or kernel) to be used in a focal operation.

  36. case class Nesw(extent: Int) extends Neighborhood with Product with Serializable

    A neighborhood that includes a column and row intersectin the focus.

    A neighborhood that includes a column and row intersectin the focus.

    extent

    Extent of the neighborhood. The extent is how many cells past the focus the bounding box goes. (e.g., 1 for 3x3 square)

  37. trait Resulting[T] extends AnyRef
  38. trait ShortArrayTileResult extends Resulting[Tile]

    Defines a focal calculation as returning a Tile with ShortArrayTile, and defines the Initialization.init function for setting up the tile.

  39. case class Square(extent: Int) extends Neighborhood with Product with Serializable

    A square neighborhood.

    A square neighborhood.

    extent

    Extent of the neighborhood. The extent is how many cells past the focus the bounding box goes. (e.g., 1 for 3x3 square)

  40. sealed trait TargetCell extends Serializable
  41. sealed trait TraversalStrategy extends AnyRef
  42. case class Wedge(radius: Double, startAngle: Double, endAngle: Double) extends Neighborhood with Product with Serializable

    Wedge neighborhood.

    Wedge neighborhood.

    radius

    The radius of the wedge, in raster cell units.

    startAngle

    The starting angle of the wedge (in degrees).

    endAngle

    The ending angle of the wedge (in degrees).

    Note

    Cells who's distance from the center is exactly the radius are included in the neighborhood.

  43. class ZFactor extends Serializable

    Produces a ZFactor for a given point using the prescribed conversion method.

Value Members

  1. object Angles
  2. object Aspect

    Calculates the aspect of each cell in a raster.

    Calculates the aspect of each cell in a raster.

    Aspect is the direction component of a gradient vector. It is the direction in degrees of which direction the maximum change in direction is pointing. It is defined as the directional component of the gradient vector and is the direction of maximum gradient of the surface at a given point. It uses Horn's method for computing aspect.

    As with slope, aspect is calculated from estimates of the partial derivatives dz / dx and dz / dy.

    If Aspect operations encounters NoData in its neighborhood, that neighborhood cell well be treated as having the same elevation as the focal cell.

    Aspect is computed in degrees from due north, i.e. as an azimuth in degrees not radians. The expression for aspect is:

    val aspect = 360 / (2 * Pi) * atan2(`dz / dy`, `dz / dx`) - 90
  3. object CellwiseStrategy

    Focal strategy that implements a more strict mechanism that informs the user what cells have been added or removed.

    Focal strategy that implements a more strict mechanism that informs the user what cells have been added or removed. This strategy is more performant, but can only be used for Square or Circle neighborhoods.

  4. object Convolve

    Computes the convolution of a raster with a kernel.

  5. object Conway
  6. object Cursor
  7. object CursorStrategy

    Focal strategy which moves a Cursor across the raster, allowing a calculation to be done on each cell using the Cursor to determine what neighboring cells are inside the focus's neighborhood, what cells have been added since the last move, and what cells have been removed since the last move.

  8. object Implicits extends Implicits
  9. object Kernel extends Serializable
  10. object Max

    Computes the maximum value of a neighborhood for a given raster.

    Computes the maximum value of a neighborhood for a given raster.

    Note

    Maximum does not currently support Double raster data. If you use a Tile with a Double CellType (FloatConstantNoDataCellType, DoubleConstantNoDataCellType) the data values will be rounded to integers.

  11. object Mean
  12. object Median
  13. object Min

    Computes the minimum value of a neighborhood for a given raster

  14. object Mode

    Computes the mode of a neighborhood for a given raster

    Computes the mode of a neighborhood for a given raster

    Note

    Mode does not currently support Double raster data. If you use a Tile with a Double CellType (FloatConstantNoDataCellType, DoubleConstantNoDataCellType) the data values will be rounded to integers.

  15. object Movement

    Movements used to move a Cursor around, and to track it's movements.

  16. object ScalarMoransICalculation

    Calculates global spatial autocorrelation of a raster based on the similarity to neighboring values.

    Calculates global spatial autocorrelation of a raster based on the similarity to neighboring values.

    The resulting statistic is such that the more positive the number, the greater the similarity of values in the raster, and the more negative the number, the more dissimilar the raster values are.

    Note

    This operation requires that the whole raster be passed in; it does not work over tiles.

    ,

    Since mean and standard deviation are based off of an Int based Histogram, those values will come from rounded values of a double typed Tile (FloatConstantNoDataCellType, DoubleConstantNoDataCellType).

  17. object ScanLineTraversalStrategy extends TraversalStrategy with Product with Serializable
  18. object Slope

    Calculates the slope of each cell in a raster.

    Calculates the slope of each cell in a raster.

    Slope is the magnitude portion of the gradient vector. It is the maximum change of elevation from a raster cell to any immediate neighbor. It uses Horn's method for computing slope.

    As with aspect, slope is calculated from estimates of the partial derivatives dz / dx and dz / dy.

    Slope is computed in degrees from horizontal.

    The use of a z-factor is essential for correct slope calculations when the surface z units are expressed in units different from the ground x,y units.

    If Slope operations encounters NoData in its neighborhood, that neighborhood cell well be treated as having the same elevation as the focal cell.

    The expression for slope is:

    val slope = atan(sqrt(pow(`dz / dy`, 2) * pow(`dz / dx`, 2)))
  19. object SpiralZagTraversalStrategy extends TraversalStrategy with Product with Serializable
  20. object StandardDeviation

    Computes the standard deviation of a neighborhood for a given raster.

    Computes the standard deviation of a neighborhood for a given raster. Returns a raster of DoubleConstantNoDataCellType.

    Note

    StandardDeviation does not currently support Double raster data inputs. If you use a Tile with a Double CellType (FloatConstantNoDataCellType, DoubleConstantNoDataCellType) the data values will be rounded to integers.

  21. object Sum
  22. object TargetCell extends Serializable
  23. object TileMoransICalculation

    Calculates spatial autocorrelation of cells based on the similarity to neighboring values.

    Calculates spatial autocorrelation of cells based on the similarity to neighboring values.

    The statistic for each focus in the resulting raster is such that the more positive the number, the greater the similarity between the focus value and it's neighboring values, and the more negative the number, the more dissimilar the focus value is with it's neighboring values.

    Note

    This operation requires that the whole raster be passed in; it does not work over tiles.

    ,

    Since mean and standard deviation are based off of an Int based Histogram, those values will come from rounded values of a double typed Tile (FloatConstantNoDataCellType, DoubleConstantNoDataCellType).

  24. object TileWithNeighbors
  25. object TraversalStrategy
  26. object ZFactor extends Serializable

    When creating a ZFactor instance, the projection of the target Tile(s) needs to be taken into account.

    When creating a ZFactor instance, the projection of the target Tile(s) needs to be taken into account. If the Tiles are in LatLng, then the conversion between Latitude and ZFactor can already be calculated. Otherwise, one will need to supply the transformation required to produce the ZFactor.

  27. object ZigZagTraversalStrategy extends TraversalStrategy with Product with Serializable

Ungrouped