Class/Object

com.rasterfoundry.backsplash

BacksplashImage

Related Docs: object BacksplashImage | package backsplash

Permalink

final case class BacksplashImage(imageId: UUID, projectLayerId: UUID, uri: String, footprint: MultiPolygon, subsetBands: List[Int], corrections: Params, singleBandOptions: Option[Params]) extends LazyLogging with Product with Serializable

An image used in a tile or export service, can be color corrected, and requested a subet of the bands from the image

If caching is enabled then reads of the source tiles are cached. The image id, uri, subset of bands, single band options, and either the z-x-y or extent is used to construct a unique key for the tile read.

NOTE: additional class parameters added to this class that will NOT affect how the source data is read need to be flagged with the @cacheKeyExclude decorator to avoid unecessarily namespacing values in the keys

imageId

UUID of the image (scene) in the database

projectLayerId

UUID of the layer this image is a part of

uri

location of the source data

footprint

extent of data the image covers

subsetBands

subset of bands to be read from source

corrections

description + operations for how to correct image

singleBandOptions

band + options of how to color a single band

Linear Supertypes
Serializable, Serializable, Product, Equals, LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BacksplashImage
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. LazyLogging
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BacksplashImage(imageId: UUID, projectLayerId: UUID, uri: String, footprint: MultiPolygon, subsetBands: List[Int], corrections: Params, singleBandOptions: Option[Params])

    Permalink

    imageId

    UUID of the image (scene) in the database

    projectLayerId

    UUID of the layer this image is a part of

    uri

    location of the source data

    footprint

    extent of data the image covers

    subsetBands

    subset of bands to be read from source

    corrections

    description + operations for how to correct image

    singleBandOptions

    band + options of how to color a single band

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. val corrections: Params

    Permalink

    description + operations for how to correct image

  7. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. implicit val flags: Flags

    Permalink
  10. val footprint: MultiPolygon

    Permalink

    extent of data the image covers

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. val imageId: UUID

    Permalink

    UUID of the image (scene) in the database

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  15. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  18. val projectLayerId: UUID

    Permalink

    UUID of the layer this image is a part of

  19. lazy val rasterSource: RasterSource

    Permalink
  20. def read(extent: Extent, cs: CellSize): Option[MultibandTile]

    Permalink

    Read tile - defers to a private method to enable disable/enabling of cache *

  21. def read(z: Int, x: Int, y: Int): Option[MultibandTile]

    Permalink

    Read ZXY tile - defers to a private method to enable disable/enabling of cache *

  22. val singleBandOptions: Option[Params]

    Permalink

    band + options of how to color a single band

  23. val subsetBands: List[Int]

    Permalink

    subset of bands to be read from source

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

    Permalink
    Definition Classes
    AnyRef
  25. implicit val tileCache: Cache[Option[MultibandTile]]

    Permalink
  26. val uri: String

    Permalink

    location of the source data

  27. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped