Trait

org.locationtech.rasterframes

RasterFunctions

Related Doc: package rasterframes

Permalink

trait RasterFunctions extends AnyRef

UDFs for working with Tiles in Spark DataFrames.

Since

4/3/17

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RasterFunctions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. def rf_abs(tileCol: Column): Column

    Permalink

    Compute the absolute value of each cell.

  16. def rf_agg_approx_histogram(col: Column): TypedColumn[Any, CellHistogram]

    Permalink

    Compute the full column aggregate floating point histogram.

  17. def rf_agg_data_cells(col: Column): TypedColumn[Any, Long]

    Permalink

    Computes the number of non-NoData cells in a column.

  18. def rf_agg_local_data_cells(col: Column): TypedColumn[Any, Tile]

    Permalink

    Compute the cellwise/local count of non-NoData cells for all Tiles in a column.

  19. def rf_agg_local_max(col: Column): TypedColumn[Any, Tile]

    Permalink

    Compute the cell-wise/local max operation between Tiles in a column.

  20. def rf_agg_local_mean(col: Column): TypedColumn[Any, Tile]

    Permalink

    Compute the cellwise/local mean operation between Tiles in a column.

  21. def rf_agg_local_min(col: Column): TypedColumn[Any, Tile]

    Permalink

    Compute the cellwise/local min operation between Tiles in a column.

  22. def rf_agg_local_no_data_cells(col: Column): TypedColumn[Any, Tile]

    Permalink

    Compute the cellwise/local count of NoData cells for all Tiles in a column.

  23. def rf_agg_local_stats(col: Column): TypedColumn[Any, LocalCellStatistics]

    Permalink

    Compute cell-local aggregate descriptive statistics for a column of Tiles.

  24. def rf_agg_mean(col: Column): TypedColumn[Any, Double]

    Permalink

    Computes the column aggregate mean.

  25. def rf_agg_no_data_cells(col: Column): TypedColumn[Any, Long]

    Permalink

    Computes the number of NoData cells in a column.

  26. def rf_agg_stats(col: Column): TypedColumn[Any, CellStatistics]

    Permalink

    Compute the full column aggregate floating point statistics.

  27. def rf_array_to_tile(arrayCol: Column, cols: Int, rows: Int): TypedColumn[Any, Tile]

    Permalink
    Annotations
    @Experimental()
  28. def rf_assemble_tile(columnIndex: Column, rowIndex: Column, cellData: Column, tileCols: Column, tileRows: Column): TypedColumn[Any, Tile]

    Permalink

    Create a Tile from a column of cell data with location indexes.

  29. def rf_assemble_tile(columnIndex: Column, rowIndex: Column, cellData: Column, tileCols: Int, tileRows: Int): TypedColumn[Any, Tile]

    Permalink

    Create a Tile from a column of cell data with location indexes and perform cell conversion.

  30. def rf_assemble_tile(columnIndex: Column, rowIndex: Column, cellData: Column, tileCols: Int, tileRows: Int, ct: CellType): TypedColumn[Any, Tile]

    Permalink

    Create a Tile from a column of cell data with location indexes and preform cell conversion.

  31. def rf_cell_type(col: Column): TypedColumn[Any, CellType]

    Permalink

    Extract the Tile's cell type

  32. def rf_convert_cell_type(col: Column, cellType: Column): Column

    Permalink

    Change the Tile's cell type

  33. def rf_convert_cell_type(col: Column, cellTypeName: String): Column

    Permalink

    Change the Tile's cell type

  34. def rf_convert_cell_type(col: Column, cellType: CellType): Column

    Permalink

    Change the Tile's cell type

  35. def rf_crs(col: Column): TypedColumn[Any, CRS]

    Permalink

    Extracts the CRS from a RasterSource or ProjectedRasterTile

  36. def rf_data_cells(tile: Column): TypedColumn[Any, Long]

    Permalink

    Counts the number of non-NoData cells per Tile.

  37. def rf_dimensions(col: Column): TypedColumn[Any, TileDimensions]

    Permalink

    Query the number of (cols, rows) in a Tile.

  38. def rf_exists(tile: Column): TypedColumn[Any, Boolean]

    Permalink

    Returns true if any cells in the tile are true (non-zero and not NoData).

  39. def rf_exp(tileCol: Column): Column

    Permalink

    Exponential of cell values

  40. def rf_exp10(tileCol: Column): Column

    Permalink

    Ten to the power of cell values

  41. def rf_exp2(tileCol: Column): Column

    Permalink

    Two to the power of cell values

  42. def rf_explode_tiles(cols: Column*): Column

    Permalink

    Create a row for each cell in Tile.

  43. def rf_explode_tiles_sample(sampleFraction: Double, cols: Column*): Column

    Permalink

    Create a row for each cell in Tile with random sampling (no seed).

  44. def rf_explode_tiles_sample(sampleFraction: Double, seed: Option[Long], cols: Column*): Column

    Permalink

    Create a row for each cell in Tile with random sampling and optional seed.

  45. def rf_expm1(tileCol: Column): Column

    Permalink

    Exponential of cell values, less one

  46. def rf_extent(col: Column): TypedColumn[Any, Extent]

    Permalink

    Extracts the bounding box from a RasterSource or ProjectedRasterTile

  47. def rf_for_all(tile: Column): TypedColumn[Any, Boolean]

    Permalink

    Returns true if all cells in the tile are true (non-zero and not NoData).

  48. def rf_geometry(raster: Column): TypedColumn[Any, Geometry]

    Permalink

    Extract the extent of a RasterSource or ProjectedRasterTile as a Geometry type.

  49. def rf_identity(tileCol: Column): Column

    Permalink

    Return the incoming tile untouched.

  50. def rf_interpret_cell_type_as(col: Column, cellType: Column): Column

    Permalink

    Change the interpretation of the Tile's cell values according to specified CellType

  51. def rf_interpret_cell_type_as(col: Column, cellTypeName: String): Column

    Permalink

    Change the interpretation of the Tile's cell values according to specified CellType

  52. def rf_interpret_cell_type_as(col: Column, cellType: CellType): Column

    Permalink

    Change the interpretation of the Tile's cell values according to specified CellType

  53. def rf_inverse_mask(sourceTile: Column, maskTile: Column): TypedColumn[Any, Tile]

    Permalink

    Where the maskTile does **not** contain NoData, replace values in the source tile with NoData

  54. def rf_inverse_mask_by_value(sourceTile: Column, maskTile: Column, maskValue: Column): TypedColumn[Any, Tile]

    Permalink

    Where the maskTile does **not** equal maskValue, replace values in the source tile with NoData

  55. def rf_is_no_data_tile(tile: Column): TypedColumn[Any, Boolean]

    Permalink

    Returns true if all cells in the tile are NoData.

  56. def rf_local_add[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise addition of a scalar value to a tile.

  57. def rf_local_add(left: Column, right: Column): Column

    Permalink

    Cellwise addition between two Tiles or Tile and scalar column.

  58. def rf_local_algebra(op: LocalTileBinaryOp, left: Column, right: Column): TypedColumn[Any, Tile]

    Permalink

    Perform an arbitrary GeoTrellis LocalTileBinaryOp between two Tile columns.

  59. def rf_local_data(tileCol: Column): Column

    Permalink

    Return a tile with zeros where the input is NoData, otherwise one

  60. def rf_local_divide[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise division of a tile by a scalar value.

  61. def rf_local_divide(left: Column, right: Column): Column

    Permalink

    Cellwise division between two Tiles.

  62. def rf_local_equal[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise equal to value comparison between a tile and a scalar.

  63. def rf_local_equal(left: Column, right: Column): Column

    Permalink

    Cellwise equal to value comparison between two tiles.

  64. def rf_local_greater[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise greater than value comparison between a tile and a scalar.

  65. def rf_local_greater(left: Column, right: Column): Column

    Permalink

    Cellwise greater than value comparison between two tiles.

  66. def rf_local_greater_equal[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise greater than or equal to value comparison between a tile and a scalar.

  67. def rf_local_greater_equal(left: Column, right: Column): Column

    Permalink

    Cellwise greater than or equal to value comparison between two tiles.

  68. def rf_local_less[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise less than value comparison between a tile and a scalar.

  69. def rf_local_less(left: Column, right: Column): Column

    Permalink

    Cellwise less than value comparison between two tiles.

  70. def rf_local_less_equal[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise less than or equal to value comparison between a tile and a scalar.

  71. def rf_local_less_equal(left: Column, right: Column): Column

    Permalink

    Cellwise less than or equal to value comparison between a tile and a scalar.

  72. def rf_local_multiply[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise multiplication of a tile by a scalar value.

  73. def rf_local_multiply(left: Column, right: Column): Column

    Permalink

    Cellwise multiplication between two Tiles.

  74. def rf_local_no_data(tileCol: Column): Column

    Permalink

    Return a tile with ones where the input is NoData, otherwise zero

  75. def rf_local_subtract[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise subtraction of a scalar value from a tile.

  76. def rf_local_subtract(left: Column, right: Column): Column

    Permalink

    Cellwise subtraction between two Tiles.

  77. def rf_local_unequal[T](tileCol: Column, value: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Cellwise inequality comparison between a tile and a scalar.

  78. def rf_local_unequal(left: Column, right: Column): Column

    Permalink

    Cellwise inequality comparison between two tiles.

  79. def rf_log(tileCol: Column): Column

    Permalink

    Take natural logarithm of cell values.

  80. def rf_log10(tileCol: Column): Column

    Permalink

    Take base 10 logarithm of cell values.

  81. def rf_log1p(tileCol: Column): Column

    Permalink

    Natural logarithm of one plus cell values.

  82. def rf_log2(tileCol: Column): Column

    Permalink

    Take base 2 logarithm of cell values.

  83. def rf_make_constant_tile(value: Number, cols: Int, rows: Int, cellTypeName: String): TypedColumn[Any, Tile]

    Permalink

    Constructor for tile column with a single cell value.

  84. def rf_make_constant_tile(value: Number, cols: Int, rows: Int, cellType: CellType): TypedColumn[Any, Tile]

    Permalink

    Constructor for tile column with a single cell value.

  85. def rf_make_ones_tile(cols: Int, rows: Int, cellTypeName: String): TypedColumn[Any, Tile]

    Permalink

    Creates a column of tiles containing all ones

  86. def rf_make_ones_tile(cols: Int, rows: Int, cellType: CellType): TypedColumn[Any, Tile]

    Permalink

    Creates a column of tiles containing all ones

  87. def rf_make_zeros_tile(cols: Int, rows: Int, cellTypeName: String): TypedColumn[Any, Tile]

    Permalink

    Create a column constant tiles of zero

  88. def rf_make_zeros_tile(cols: Int, rows: Int, cellType: CellType): TypedColumn[Any, Tile]

    Permalink

    Create a column constant tiles of zero

  89. def rf_mask(sourceTile: Column, maskTile: Column): TypedColumn[Any, Tile]

    Permalink

    Where the rf_mask tile contains NODATA, replace values in the source tile with NODATA

  90. def rf_mask_by_value(sourceTile: Column, maskTile: Column, maskValue: Column): TypedColumn[Any, Tile]

    Permalink

    Where the maskTile equals maskValue, replace values in the source tile with NoData

  91. def rf_no_data_cells(tile: Column): TypedColumn[Any, Long]

    Permalink

    Counts the number of NoData cells per Tile.

  92. def rf_normalized_difference(left: Column, right: Column): TypedColumn[Any, Tile]

    Permalink

    Compute the normalized difference of two tile columns

  93. def rf_rasterize(geometry: Column, bounds: Column, value: Column, cols: Column, rows: Column): TypedColumn[Any, Tile]

    Permalink
  94. def rf_rasterize(geometry: Column, bounds: Column, value: Column, cols: Int, rows: Int): TypedColumn[Any, Tile]

    Permalink

    Create a tile where cells in the grid defined by cols, rows, and bounds are filled with the given value.

  95. def rf_render_ascii(tile: Column): TypedColumn[Any, String]

    Permalink

    Render Tile as ASCII string, for debugging purposes.

  96. def rf_render_matrix(tile: Column): TypedColumn[Any, String]

    Permalink

    Render Tile cell values as numeric values, for debugging purposes.

  97. def rf_render_png(red: Column, green: Column, blue: Column): TypedColumn[Any, Array[Byte]]

    Permalink

    Converts columns of tiles representing RGB channels into a PNG encoded byte array.

  98. def rf_render_png(tile: Column, colors: ColorRamp): TypedColumn[Any, Array[Byte]]

    Permalink

    Converts tiles in a column into PNG encoded byte array, using given ColorRamp to assign values to colors.

  99. def rf_resample(tileCol: Column, factorCol: Column): Column

    Permalink

    Resample tile to different size based on scalar factor or tile whose dimension to match.

    Resample tile to different size based on scalar factor or tile whose dimension to match. Scalar less than one will downsample tile; greater than one will upsample. Uses nearest-neighbor.

  100. def rf_resample[T](tileCol: Column, factorValue: T)(implicit arg0: Numeric[T]): Column

    Permalink

    Resample tile to different size based on scalar factor or tile whose dimension to match.

    Resample tile to different size based on scalar factor or tile whose dimension to match. Scalar less than one will downsample tile; greater than one will upsample. Uses nearest-neighbor.

  101. def rf_rgb_composite(red: Column, green: Column, blue: Column): Column

    Permalink

    Converts columns of tiles representing RGB channels into a single RGB packaged tile.

  102. def rf_round(tileCol: Column): Column

    Permalink

    Round cell values to nearest integer without chaning cell type.

  103. def rf_tile(col: Column): TypedColumn[Any, Tile]

    Permalink

    Extracts the tile from a ProjectedRasterTile, or passes through a Tile.

  104. def rf_tile_histogram(col: Column): TypedColumn[Any, CellHistogram]

    Permalink

    Compute TileHistogram of Tile values.

  105. def rf_tile_max(col: Column): TypedColumn[Any, Double]

    Permalink

    Compute the maximum cell value in tile.

  106. def rf_tile_mean(col: Column): TypedColumn[Any, Double]

    Permalink

    Compute the Tile-wise mean

  107. def rf_tile_min(col: Column): TypedColumn[Any, Double]

    Permalink

    Compute the minimum cell value in tile.

  108. def rf_tile_stats(col: Column): TypedColumn[Any, CellStatistics]

    Permalink

    Compute statistics of Tile values.

  109. def rf_tile_sum(col: Column): TypedColumn[Any, Double]

    Permalink

    Compute the Tile-wise sum

  110. def rf_tile_to_array_double(col: Column): TypedColumn[Any, Array[Double]]

    Permalink

    Flattens Tile into a double array.

  111. def rf_tile_to_array_int(col: Column): TypedColumn[Any, Array[Double]]

    Permalink

    Flattens Tile into an integer array.

  112. def rf_with_no_data(col: Column, nodata: Column): Column

    Permalink

    Assign a NoData value to the tile column.

  113. def rf_with_no_data(col: Column, nodata: Int): Column

    Permalink

    Assign a NoData value to the tile column.

  114. def rf_with_no_data(col: Column, nodata: Double): Column

    Permalink

    Assign a NoData value to the tile column.

  115. def st_extent(col: Column): TypedColumn[Any, Extent]

    Permalink

    Extracts the bounding box of a geometry as an Extent

  116. def st_geometry(extent: Column): TypedColumn[Any, Geometry]

    Permalink

    Convert a bounding box structure to a Geometry type.

    Convert a bounding box structure to a Geometry type. Intented to support multiple schemas.

  117. def st_reproject(sourceGeom: Column, srcCRSCol: Column, dstCRSCol: Column): TypedColumn[Any, Geometry]

    Permalink

    Reproject a column of geometry from one CRS to another.

    Reproject a column of geometry from one CRS to another.

    sourceGeom

    Geometry column to reproject

    srcCRSCol

    Native CRS of sourceGeom as a column

    dstCRSCol

    Destination CRS as a column

  118. def st_reproject(sourceGeom: Column, srcCRS: CRS, dstCRS: CRS): TypedColumn[Any, Geometry]

    Permalink

    Reproject a column of geometry from one CRS to another.

    Reproject a column of geometry from one CRS to another.

    sourceGeom

    Geometry column to reproject

    srcCRS

    Native CRS of sourceGeom as a literal

    dstCRS

    Destination CRS as a literal

  119. def st_reproject(sourceGeom: Column, srcCRSCol: Column, dstCRS: CRS): TypedColumn[Any, Geometry]

    Permalink

    Reproject a column of geometry from one CRS to another.

    Reproject a column of geometry from one CRS to another.

    sourceGeom

    Geometry column to reproject

    srcCRSCol

    Native CRS of sourceGeom as a column

    dstCRS

    Destination CRS as a literal

  120. def st_reproject(sourceGeom: Column, srcCRS: CRS, dstCRSCol: Column): TypedColumn[Any, Geometry]

    Permalink

    Reproject a column of geometry from one CRS to another.

    Reproject a column of geometry from one CRS to another.

    sourceGeom

    Geometry column to reproject

    srcCRS

    Native CRS of sourceGeom as a literal

    dstCRSCol

    Destination CRS as a column

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

    Permalink
    Definition Classes
    AnyRef
  122. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped