object Rasterizer
An object holding rasterizer functions.
- Alphabetic
- By Inheritance
- Rasterizer
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
case class
Options(includePartial: Boolean, sampleType: PixelSampleType) extends Product with Serializable
A type encoding rasterizer options.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
foreachCellByGeometry(extent: Extent, re: RasterExtent, options: Options)(f: (Int, Int) ⇒ Unit): Unit
Perform a zonal summary by invoking a function on each cell under provided features.
Perform a zonal summary by invoking a function on each cell under provided features.
This function is a closure that returns Unit; all results are a side effect of this function.
Note: the function f should modify a mutable variable as a side effect. While not ideal, this avoids the unavoidable boxing that occurs when a Function3 returns a primitive value.
- extent
Feature for calculation
- re
RasterExtent to use for iterating through cells
- options
Options for the (Multi)Polygon and Extent rasterizers
- f
A function that takes (col: Int, row: Int) and produces nothing
-
def
foreachCellByGeometry(geom: Geometry, re: RasterExtent, options: Options)(f: (Int, Int) ⇒ Unit): Unit
Perform a zonal summary by invoking a function on each cell under provided features.
Perform a zonal summary by invoking a function on each cell under provided features.
This function is a closure that returns Unit; all results are a side effect of this function.
Note: the function f should modify a mutable variable as a side effect. While not ideal, this avoids the unavoidable boxing that occurs when a Function3 returns a primitive value.
- geom
Feature for calculation
- re
RasterExtent to use for iterating through cells
- options
Options for the (Multi)Polygon and Extent rasterizers
- f
A function that takes (col: Int, row: Int) and produces nothing
-
def
foreachCellByGeometry(geom: Geometry, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Given a Geometry and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry.
Given a Geometry and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry. The two arguments to the function 'f' are the column and row.
-
def
foreachCellByLineString(line: LineString, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Iterates over the cells determined by the segments of a LineString.
Iterates over the cells determined by the segments of a LineString. The iteration happens in the direction from the first point to the last point.
-
def
foreachCellByLineString(line: LineString, re: RasterExtent, c: Connectivity)(f: (Int, Int) ⇒ Unit): Unit
Iterates over the cells determined by the segments of a LineString.
Iterates over the cells determined by the segments of a LineString. The iteration happens in the direction from the first point to the last point.
-
def
foreachCellByLineStringDouble(line: LineString, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Iterates over the cells determined by the segments of a LineString.
Iterates over the cells determined by the segments of a LineString. The iteration happens in the direction from the first point to the last point.
-
def
foreachCellByMultiLineString(g: MultiLineString, re: RasterExtent, c: Connectivity)(f: (Int, Int) ⇒ Unit): Unit
Apply function f to every cell contained within MultiLineString.
Apply function f to every cell contained within MultiLineString.
- g
MultiLineString used to define zone
- re
RasterExtent used to determine cols and rows
- c
Desired connectivity of the line
- f
Function to apply: f(cols, row, feature)
-
def
foreachCellByMultiLineString(g: MultiLineString, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Apply function f to every cell contained within MultiLineString.
Apply function f to every cell contained within MultiLineString.
- g
MultiLineString used to define zone
- re
RasterExtent used to determine cols and rows
- f
Function to apply: f(cols, row, feature)
-
def
foreachCellByMultiPoint(p: MultiPoint, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Given a MultiPoint and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry.
Given a MultiPoint and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry. The two arguments to the function 'f' are the column and row.
-
def
foreachCellByMultiPolygon[D](p: MultiPolygon, re: RasterExtent, options: Options)(f: (Int, Int) ⇒ Unit): Unit
Apply function f to every cell contained with MultiPolygon.
Apply function f to every cell contained with MultiPolygon.
- p
MultiPolygon used to define zone
- re
RasterExtent used to determine cols and rows
- options
The options parameter controls whether to treat pixels as points or areas and whether to report partially-intersected areas.
- f
Function to apply: f(cols, row, feature)
-
def
foreachCellByMultiPolygon[D](p: MultiPolygon, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Given a MultiPolygon and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry.
Given a MultiPolygon and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry. The two arguments to the function 'f' are the column and row.
-
def
foreachCellByPoint(geom: Point, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Invoke a function on raster cells under a point feature.
Invoke a function on raster cells under a point feature.
The function f is a closure that should alter a mutable variable by side effect (to avoid boxing).
-
def
foreachCellByPointSeq(pSet: Seq[Point], re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Invoke a function on each point in a sequences of Points.
-
def
foreachCellByPolygon(p: Polygon, re: RasterExtent, options: Options)(f: (Int, Int) ⇒ Unit): Unit
Apply function f(col, row, feature) to every cell contained within polygon.
Apply function f(col, row, feature) to every cell contained within polygon.
- p
Polygon used to define zone
- re
RasterExtent used to determine cols and rows
- options
The options parameter controls whether to treat pixels as points or areas and whether to report partially-intersected areas.
- f
Function to apply: f(cols, row, feature)
-
def
foreachCellByPolygon(p: Polygon, re: RasterExtent)(f: (Int, Int) ⇒ Unit): Unit
Given a Polygon and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry.
Given a Polygon and a RasterExtent, call the function 'f' at each pixel in the raster extent covered by the geometry. The two arguments to the function 'f' are the column and row.
-
def
foreachCellInGridLine(x0: Int, y0: Int, x1: Int, y1: Int, re: RasterExtent, skipLast: Boolean, c: Connectivity)(f: (Int, Int) ⇒ Unit): Unit
Implementation of the Bresenham line drawing algorithm.
Implementation of the Bresenham line drawing algorithm. Only calls on cell coordinates within raster extent.
The parameter 'skipLast' is a flag which is 'true' if the function should skip function calling the last cell (x1, y1) and false otherwise. This is useful for not duplicating end points when calling for multiple line segments.
- re
RasterExtent used to determine cols and rows
- skipLast
Boolean flag
- f
Function to apply: f(cols, row, feature)
-
def
foreachCellInGridLine[D](x0: Int, y0: Int, x1: Int, y1: Int, p: LineString, re: RasterExtent, skipLast: Boolean = false)(f: (Int, Int) ⇒ Unit): Unit
Implementation of the Bresenham line drawing algorithm.
Implementation of the Bresenham line drawing algorithm. Only calls on cell coordinates within raster extent.
The parameter 'skipLast' is a flag which is 'true' if the function should skip function calling the last cell (x1, y1) and false otherwise. This is useful for not duplicating end points when calling for multiple line segments.
- p
LineString used to define zone
- re
RasterExtent used to determine cols and rows
- skipLast
Boolean flag
- f
Function to apply: f(cols, row, feature)
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
rasterize(feature: Geometry, rasterExtent: RasterExtent)(f: (Int, Int) ⇒ Int): IntConstantNoDataArrayTile
Create a raster from a geometry feature.
Create a raster from a geometry feature.
- feature
Feature to rasterize
- rasterExtent
Definition of raster to create
- f
Function that takes col, row, feature and returns value to burn
-
def
rasterizeWithValue(geom: Geometry, rasterExtent: RasterExtent, value: Int): Tile
Create a raster from a geometry feature.
Create a raster from a geometry feature.
- geom
Geometry to rasterize
- rasterExtent
Definition of raster to create
- value
Single value to burn
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
object
Options extends Serializable
A companion object for the Options type.
A companion object for the Options type. Includes a function to produce the default options settings.