Class

software.uncharted.salt.core.generation

Series

Related Doc: package generation

Permalink

class Series[RT, DC, TC, BC, T, U, V, W, X] extends Serializable

Represents a ValueExtractor -> Projection -> binAggregator -> tileAggregator ValueExtractor --------^ Multiple series are meant to be tiled by a TileGenerator simultaneously

Also used to extract its own SeriesData from a Tile

RT

the source data record type (the source data is an RDD[RT])

DC

the abstract type representing a data-space coordinate

TC

the abstract type representing a tile coordinate.

BC

the abstract type representing a bin coordinate. Must be something that can be represented in 1 dimension.

T

Input data type for bin aggregators

U

Intermediate data type for bin aggregators

V

Output data type for bin aggregators, and input for tile aggregator

W

Intermediate data type for tile aggregators

X

Output data type for tile aggregators

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Series
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Series(maxBin: BC, cExtractor: (RT) ⇒ Option[DC], projection: Projection[DC, TC, BC], vExtractor: (RT) ⇒ Option[T], binAggregator: Aggregator[T, U, V], tileAggregator: Option[Aggregator[V, W, X]] = None, spreadingFunction: Option[SpreadingFunction[TC, BC, T]] = None)

    Permalink

    maxBin

    The maximum possible bin index (i.e. if your tile is 256x256, this would be (255,255))

    cExtractor

    a mechanism for grabbing the data-space coordinates from a source record

    projection

    the projection from data to some space (i.e. 2D or 1D)

    vExtractor

    a mechanism for grabbing or synthesizing the "value" column from a source record (optional)

    binAggregator

    the desired bin analytic strategy

    tileAggregator

    the desired tile analytic strategy (optional)

    spreadingFunction

    the desired value spreading function (optional)

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. def apply(tile: Tile[TC]): Option[SeriesData[TC, BC, V, X]]

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val binAggregator: Aggregator[T, U, V]

    Permalink

    the desired bin analytic strategy

  7. val cExtractor: (RT) ⇒ Option[DC]

    Permalink

    a mechanism for grabbing the data-space coordinates from a source record

  8. def clone(): AnyRef

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  15. val maxBin: BC

    Permalink

    The maximum possible bin index (i.e.

    The maximum possible bin index (i.e. if your tile is 256x256, this would be (255,255))

  16. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  19. val projection: Projection[DC, TC, BC]

    Permalink

    the projection from data to some space (i.e.

    the projection from data to some space (i.e. 2D or 1D)

  20. val spreadingFunction: Option[SpreadingFunction[TC, BC, T]]

    Permalink

    the desired value spreading function (optional)

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

    Permalink
    Definition Classes
    AnyRef
  22. val tileAggregator: Option[Aggregator[V, W, X]]

    Permalink

    the desired tile analytic strategy (optional)

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. val vExtractor: (RT) ⇒ Option[T]

    Permalink

    a mechanism for grabbing or synthesizing the "value" column from a source record (optional)

  25. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped