focal

Type Members

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.
trait ArrayTileResult extends Resulting[Tile]
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.
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.
abstract class CellwiseCalculation[T] extends FocalCalculation[T]

A focal calculation that uses the Cellwise focal strategy
class CellwiseDoubleSumCalc extends CellwiseCalculation[Tile] with ArrayTileResult
class CellwiseMeanCalc extends CellwiseCalculation[Tile] with DoubleArrayTileResult
class CellwiseMeanCalcDouble extends CellwiseCalculation[Tile] with DoubleArrayTileResult
class CellwiseMedianCalc extends CellwiseCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
class CellwiseModeCalc extends CellwiseCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
trait CellwiseStrategyCalculation extends AnyRef
class CellwiseSumCalc extends CellwiseCalculation[Tile] with ArrayTileResult
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.
class Cursor extends AnyRef

Represents a cursor that can be used to iterate over cells within a focal neighborhood.
abstract class CursorCalculation[T] extends FocalCalculation[T]

A focal calculation that uses the Cursor focal strategy.
class CursorDoubleSumCalc extends CursorCalculation[Tile] with ArrayTileResult
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.
class CursorMeanCalc extends CursorCalculation[Tile] with DoubleArrayTileResult
class CursorMeanCalcDouble extends CursorCalculation[Tile] with DoubleArrayTileResult
class CursorMedianCalc extends CursorCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
class CursorModeCalc extends CursorCalculation[Tile] with IntArrayTileResult with MedianModeCalculation
class CursorSumCalc extends CursorCalculation[Tile] with ArrayTileResult
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.
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.
abstract class FocalCalculation[T] extends Resulting[T]

A calculation that a FocalStrategy uses to complete a focal operation.
trait FocalMethods extends MethodExtensions[Tile]
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.
case class Kernel(tile: Tile) extends Neighborhood with Product with Serializable

Kernel
Kernel
Represents a neighborhood that is represented by a tile.
abstract class KernelCalculation[T] extends FocalCalculation[T]

A focal calculation that uses the Cursor focal strategy.
class KernelCursor extends Cursor with MacroIterableTile with Serializable
trait MedianModeCalculation extends AnyRef
sealed trait Movement extends AnyRef
trait Neighborhood extends Serializable

A definition of the shape and size of the neighborhood (or kernel) to be used in a focal operation.
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)
trait Resulting[T] extends AnyRef
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.
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)
sealed trait TargetCell extends Serializable
sealed trait TraversalStrategy extends AnyRef
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.

Value Members

object Angles
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 = 270 - 360 / (2 * Pi) * atan2(`dz / dy`, - `dz / dx`)
```
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.
object Convolve

Computes the convolution of a raster with a kernel.
object Conway
object Cursor
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.
object Kernel extends Serializable
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.
object Mean
object Median
object Min

Computes the minimum value of a neighborhood for a given raster
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.
object Movement

Movements used to move a Cursor around, and to track it's movements.
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
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).
,
This operation requires that the whole raster be passed in; it does not work over tiles.
object ScanLineTraversalStrategy extends TraversalStrategy with Product with Serializable
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)))
```
object SpiralZagTraversalStrategy extends TraversalStrategy with Product with Serializable
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.
object Sum
object TargetCell extends Serializable
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
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).
,
This operation requires that the whole raster be passed in; it does not work over tiles.
object TileWithNeighbors
object TraversalStrategy
object ZigZagTraversalStrategy extends TraversalStrategy with Product with Serializable
package hillshade

package focal

Type Members

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

trait ArrayTileResult extends Resulting[Tile]

trait BitArrayTileResult extends Resulting[Tile]

trait ByteArrayTileResult extends Resulting[Tile]

abstract class CellwiseCalculation[T] extends FocalCalculation[T]

class CellwiseDoubleSumCalc extends CellwiseCalculation[Tile] with ArrayTileResult

class CellwiseMeanCalc extends CellwiseCalculation[Tile] with DoubleArrayTileResult

class CellwiseMeanCalcDouble extends CellwiseCalculation[Tile] with DoubleArrayTileResult

class CellwiseMedianCalc extends CellwiseCalculation[Tile] with IntArrayTileResult with MedianModeCalculation

class CellwiseModeCalc extends CellwiseCalculation[Tile] with IntArrayTileResult with MedianModeCalculation

trait CellwiseStrategyCalculation extends AnyRef

class CellwiseSumCalc extends CellwiseCalculation[Tile] with ArrayTileResult

case class Circle(radius: Double) extends Neighborhood with Product with Serializable

class Cursor extends AnyRef

abstract class CursorCalculation[T] extends FocalCalculation[T]

class CursorDoubleSumCalc extends CursorCalculation[Tile] with ArrayTileResult

class CursorMask extends AnyRef

class CursorMeanCalc extends CursorCalculation[Tile] with DoubleArrayTileResult

class CursorMeanCalcDouble extends CursorCalculation[Tile] with DoubleArrayTileResult

class CursorMedianCalc extends CursorCalculation[Tile] with IntArrayTileResult with MedianModeCalculation

class CursorModeCalc extends CursorCalculation[Tile] with IntArrayTileResult with MedianModeCalculation

class CursorSumCalc extends CursorCalculation[Tile] with ArrayTileResult

trait DoubleArrayTileResult extends Resulting[Tile]

trait FloatArrayTileResult extends Resulting[Tile]

abstract class FocalCalculation[T] extends Resulting[T]

trait FocalMethods extends MethodExtensions[Tile]

trait IntArrayTileResult extends Resulting[Tile]

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

abstract class KernelCalculation[T] extends FocalCalculation[T]

class KernelCursor extends Cursor with MacroIterableTile with Serializable

trait MedianModeCalculation extends AnyRef

sealed trait Movement extends AnyRef

trait Neighborhood extends Serializable

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

trait Resulting[T] extends AnyRef

trait ShortArrayTileResult extends Resulting[Tile]

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

sealed trait TargetCell extends Serializable

sealed trait TraversalStrategy extends AnyRef

case class Wedge(radius: Double, startAngle: Double, endAngle: Double) extends Neighborhood with Product with Serializable

Value Members

object Angles

object Aspect

object CellwiseStrategy

object Convolve

object Conway

object Cursor

object CursorStrategy

object Kernel extends Serializable

object Max

object Mean

object Median

object Min

object Mode

object Movement

object ScalarMoransICalculation

object ScanLineTraversalStrategy extends TraversalStrategy with Product with Serializable

object Slope

object SpiralZagTraversalStrategy extends TraversalStrategy with Product with Serializable

object StandardDeviation

object Sum

object TargetCell extends Serializable

object TileMoransICalculation

object TileWithNeighbors

object TraversalStrategy

object ZigZagTraversalStrategy extends TraversalStrategy with Product with Serializable

package hillshade

Ungrouped