Class

org.locationtech.rasterframes.extensions.Implicits

WithDataFrameMethods

Related Doc: package Implicits

Permalink

implicit class WithDataFrameMethods[D <: DataFrame] extends DataFrameMethods[D]

Linear Supertypes
DataFrameMethods[D], MetadataKeys, MethodExtensions[D], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WithDataFrameMethods
  2. DataFrameMethods
  3. MetadataKeys
  4. MethodExtensions
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WithDataFrameMethods(self: D)

    Permalink

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 asLayer: RasterFrameLayer

    Permalink

    Coerces this DataFrame to a RasterFrameLayer after ensuring it has:

    Coerces this DataFrame to a RasterFrameLayer after ensuring it has:

    • a space or space-time key column
    • one or more tile columns
    • tile layout metadata

    If any of the above are violated, and IllegalArgumentException is thrown.

    returns

    validated RasterFrameLayer

    Definition Classes
    DataFrameMethods
    Annotations
    @throws( ... )
    Exceptions thrown

    IllegalArgumentException when constraints are not met.

  6. def asLayerSafely: Option[RasterFrameLayer]

    Permalink

    Converts DataFrame to a RasterFrameLayer if the following constraints are fulfilled:

    Converts DataFrame to a RasterFrameLayer if the following constraints are fulfilled:

    • a space or space-time key column
    • one or more tile columns
    • tile layout metadata
    returns

    Some[RasterFrameLayer] if constraints fulfilled, None otherwise.

    Definition Classes
    DataFrameMethods
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def crsColumns: Seq[Column]

    Permalink

    Get the columns that look like CRSs.

    Get the columns that look like CRSs.

    Definition Classes
    DataFrameMethods
  9. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def extentColumns: Seq[Column]

    Permalink

    Get the columns that look like Extents.

    Get the columns that look like Extents.

    Definition Classes
    DataFrameMethods
  12. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. def isAlreadyLayer: Boolean

    Permalink

    Tests for the following conditions on the DataFrame:

    Tests for the following conditions on the DataFrame:

    • a space or space-time key column
    • one or more tile columns
    • tile layout metadata
    returns

    true if all constraints are fulfilled, false otherwise.

    Definition Classes
    DataFrameMethods
  16. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  18. def notTileColumns: Seq[Column]

    Permalink

    Get the columns that are not of type Tile

    Get the columns that are not of type Tile

    Definition Classes
    DataFrameMethods
  19. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  21. def projRasterColumns: Seq[Column]

    Permalink

    Get the columns that look like ProjectedRasterTiles.

    Get the columns that look like ProjectedRasterTiles.

    Definition Classes
    DataFrameMethods
  22. def rasterJoin(right: DataFrame, joinExpr: Column, leftExtent: Column, leftCRS: Column, rightExtent: Column, rightCRS: Column, resampleMethod: ResampleMethod): DataFrame

    Permalink

    Performs a jeft join on the dataframe right to this one, reprojecting and merging tiles as necessary.

    Performs a jeft join on the dataframe right to this one, reprojecting and merging tiles as necessary. The operation is logically a "left outer" join, with the left side also determining the target CRS and extents. Right side may have multiple Tile columns. This variant allows for the specific geospatial columns and join expression to be specified.

    right

    right dataframe

    joinExpr

    join expression

    leftExtent

    this (left) dataframe's Extent column

    leftCRS

    this (left) datafrasme's CRS column

    rightExtent

    right dataframe's CRS extent

    rightCRS

    right dataframe's CRS column

    resampleMethod

    string indicating method to use for resampling.

    returns

    joined dataframe

    Definition Classes
    DataFrameMethods
  23. def rasterJoin(right: DataFrame, leftExtent: Column, leftCRS: Column, rightExtent: Column, rightCRS: Column, resampleMethod: ResampleMethod): DataFrame

    Permalink

    Performs a jeft join on the dataframe right to this one, reprojecting and merging tiles as necessary.

    Performs a jeft join on the dataframe right to this one, reprojecting and merging tiles as necessary. The operation is logically a "left outer" join, with the left side also determining the target CRS and extents. Right side may have multiple Tile columns. This variant allows for the specific geospatial columns to be specified. The join expression used is:

    st_intersects(st_geometry(leftExtent), st_reproject(st_geometry(rightExtent), rightCRS, leftCRS))
    right

    right dataframe

    leftExtent

    this (left) dataframe's Extent column

    leftCRS

    this (left) datafrasme's CRS column

    rightExtent

    right dataframe's CRS extent

    rightCRS

    right dataframe's CRS column

    resampleMethod

    string indicating method to use for resampling.

    returns

    joined dataframe

    Definition Classes
    DataFrameMethods
  24. def rasterJoin(right: DataFrame, resampleMethod: ResampleMethod = NearestNeighbor): DataFrame

    Permalink

    Performs a jeft join on the dataframe right to this one, reprojecting and merging tiles as necessary.

    Performs a jeft join on the dataframe right to this one, reprojecting and merging tiles as necessary. The operation is logically a "left outer" join, with the left side also determining the target CRS and extents. Right side may have multiple Tile columns. Assumes both dataframes use the column names extent and crs for the Extent and CRS details for each row. The join expression used is:

    st_intersects(st_geometry(leftExtent), st_reproject(st_geometry(rightExtent), rightCRS, leftCRS))
    right

    Right side of the join.

    resampleMethod

    string indicating method to use for resampling.

    returns

    joined dataframe

    Definition Classes
    DataFrameMethods
  25. val self: D

    Permalink
    Definition Classes
    WithDataFrameMethods → MethodExtensions
  26. def spatialKeyColumn: Option[TypedColumn[Any, SpatialKey]]

    Permalink

    Get the spatial column.

    Get the spatial column.

    Definition Classes
    DataFrameMethods
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def temporalKeyColumn: Option[TypedColumn[Any, TemporalKey]]

    Permalink

    Get the temporal column, if any.

    Get the temporal column, if any.

    Definition Classes
    DataFrameMethods
  29. def tileColumns: Seq[Column]

    Permalink

    Get the columns that are of type Tile

    Get the columns that are of type Tile

    Definition Classes
    DataFrameMethods
  30. def toLayer(tlm: TileLayerMetadata[SpatialKey]): RasterFrameLayer

    Permalink

    Layout contents of RasterFrame to a layer.

    Layout contents of RasterFrame to a layer. Assumes CRS and extent columns exist.

    Definition Classes
    DataFrameMethods
  31. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withPrefixedColumnNames(prefix: String): D

    Permalink

    Renames all columns such that they start with the given prefix string.

    Renames all columns such that they start with the given prefix string. Useful for preparing dataframes for joins where duplicate names may arise.

    Definition Classes
    DataFrameMethods

Inherited from DataFrameMethods[D]

Inherited from MetadataKeys

Inherited from MethodExtensions[D]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped