Class

com.salesforce.op.stages.impl.feature

DateToUnitCircleTransformer

Related Doc: package feature

Permalink

class DateToUnitCircleTransformer[T <: Date] extends SequenceTransformer[T, OPVector] with DateToUnitCircleParams

Following: http://webspace.ship.edu/pgmarr/geo441/lectures/lec%2016%20-%20directional%20statistics.pdf Transforms a Date or DateTime field into a cartesian coordinate representation of an extracted time period on the unit circle

parameter timePeriod The time period to extract from the timestamp enum from: DayOfMonth, DayOfWeek, DayOfYear, HourOfDay, MonthOfYear, WeekOfMonth, WeekOfYear

We extract the timePeriod from the timestamp and map this onto the unit circle containing the number of time periods equally spaced. For example, when timePeriod = HourOfDay, the timestamp 01/01/2018 6:37 maps to the point on the circle with angle radians = 2*math.Pi*6/24 We return the cartesian coordinates of this point: (math.cos(radians), math.sin(radians))

The first time period always has angle 0.

Note: We use the ISO week date format https://en.wikipedia.org/wiki/ISO_week_date#First_week Monday is the first day of the week & the first week of the year is the week wit the first Monday after Jan 1.

Linear Supertypes
DateToUnitCircleParams, SequenceTransformer[T, OPVector], OpTransformerN[T, OPVector], OpTransformer, OpPipelineStageN[T, OPVector], HasInN, OpPipelineStage[OPVector], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DateToUnitCircleTransformer
  2. DateToUnitCircleParams
  3. SequenceTransformer
  4. OpTransformerN
  5. OpTransformer
  6. OpPipelineStageN
  7. HasInN
  8. OpPipelineStage
  9. OpPipelineStageBase
  10. MLWritable
  11. OpPipelineStageParams
  12. InputParams
  13. Transformer
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DateToUnitCircleTransformer(uid: String = UID[DateToUnitCircleTransformer[_]])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[T], ttiv: scala.reflect.api.JavaUniverse.TypeTag[Option[Long]])

    Permalink

Type Members

  1. final type InputFeatures = Array[FeatureLike[T]]

    Permalink
    Definition Classes
    OpPipelineStageN → OpPipelineStage → InputParams

  2. type KeyValue = (String) ⇒ Any

    Permalink
    Definition Classes
    OpTransformer

  3. final type OutputFeatures = FeatureLike[OPVector]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase

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 $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. final def checkInputLength(features: Array[_]): Boolean

    Permalink
    Definition Classes
    OpPipelineStageN → InputParams

  7. final def checkSerializable: Try[Unit]

    Permalink
    Definition Classes
    OpTransformerN → OpPipelineStageBase

  8. final def clear(param: Param[_]): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    Params

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. final def copy(extra: ParamMap): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    OpPipelineStageBase → Params

  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  12. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  16. def explainParams(): String

    Permalink
    Definition Classes
    Params

  17. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  18. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  23. final def getInputFeature[T <: FeatureType](i: Int): Option[FeatureLike[T]]

    Permalink
    Definition Classes
    InputParams

  24. final def getInputFeatures(): Array[OPFeature]

    Permalink
    Definition Classes
    InputParams

  25. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams

  26. final def getMetadata(): Metadata

    Permalink
    Definition Classes
    OpPipelineStageParams

  27. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  28. def getOutput(): FeatureLike[OPVector]

    Permalink
    Definition Classes
    OpPipelineStageN → OpPipelineStageBase

  29. final def getOutputFeatureName: String

    Permalink
    Definition Classes
    OpPipelineStage

  30. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  31. final def getTimePeriod: TimePeriod

    Permalink

    Definition Classes
    DateToUnitCircleParams

  32. final def getTransientFeature(i: Int): Option[TransientFeature]

    Permalink
    Definition Classes
    InputParams

  33. final def getTransientFeatures(): Array[TransientFeature]

    Permalink
    Definition Classes
    InputParams

  34. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  35. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  36. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  37. final def inN: Array[TransientFeature]

    Permalink
    Attributes
    protected
    Definition Classes
    HasInN

  38. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  39. final def inputAsArray(in: InputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStageN → InputParams

  40. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  41. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  42. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  43. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  44. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  45. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  46. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  47. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  48. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  49. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  50. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  53. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  54. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  55. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Definition Classes
    AnyRef

  57. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  58. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  59. def onGetMetadata(): Unit

    Permalink
    Definition Classes
    DateToUnitCircleTransformer → OpPipelineStageParams

  60. def onSetInput(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    OpPipelineStageBase

  61. val operationName: String

    Permalink
    Definition Classes
    SequenceTransformer → OpPipelineStageBase

  62. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase

  63. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStageN → OpPipelineStage

  64. def outputIsResponse: Boolean

    Permalink
    Definition Classes
    OpPipelineStage

  65. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  66. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  67. final def set(paramPair: ParamPair[_]): DateToUnitCircleTransformer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  68. final def set(param: String, value: Any): DateToUnitCircleTransformer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  69. final def set[T](param: Param[T], value: T): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    Params

  70. final def setDefault(paramPairs: ParamPair[_]*): DateToUnitCircleTransformer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  71. final def setDefault[T](param: Param[T], value: T): DateToUnitCircleTransformer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  72. final def setInput(features: FeatureLike[T]*): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    OpPipelineStageN

  73. final def setInput(features: InputFeatures): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    OpPipelineStageBase

  74. final def setInputFeatures[S <: OPFeature](features: Array[S]): DateToUnitCircleTransformer.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    InputParams

  75. final def setMetadata(m: Metadata): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams

  76. def setOutputFeatureName(name: String): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    OpPipelineStage

  77. final def setTimePeriod(value: TimePeriod): DateToUnitCircleTransformer.this.type

    Permalink
    Definition Classes
    DateToUnitCircleParams

  78. final def stageName: String

    Permalink
    Definition Classes
    OpPipelineStageBase

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

    Permalink
    Definition Classes
    AnyRef

  80. final val timePeriod: Param[String]

    Permalink
    Definition Classes
    DateToUnitCircleParams

  81. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  82. def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    OpTransformerN → Transformer

  83. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )

  84. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()

  85. def transformFn: (Seq[T]) ⇒ OPVector

    Permalink
    Definition Classes
    DateToUnitCircleTransformer → OpTransformerN

  86. lazy val transformKeyValue: (KeyValue) ⇒ Any

    Permalink
    Definition Classes
    OpTransformerN → OpTransformer

  87. def transformMap: (Map[String, Any]) ⇒ Any

    Permalink
    Definition Classes
    OpTransformer

  88. def transformRow: (Row) ⇒ Any

    Permalink
    Definition Classes
    OpTransformer

  89. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    OpPipelineStageBase

  90. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  91. implicit val tti: scala.reflect.api.JavaUniverse.TypeTag[T]

    Permalink
    Definition Classes
    SequenceTransformer → OpTransformerN

  92. implicit val ttiv: scala.reflect.api.JavaUniverse.TypeTag[Option[Long]]

    Permalink

  93. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[OPVector]

    Permalink
    Definition Classes
    SequenceTransformer → OpPipelineStageN

  94. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Value]

    Permalink
    Definition Classes
    SequenceTransformer → OpPipelineStageN

  95. val uid: String

    Permalink
    Definition Classes
    SequenceTransformer → Identifiable

  96. final def wait(): Unit

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

  97. final def wait(arg0: Long, arg1: Int): Unit

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

  98. final def wait(arg0: Long): Unit

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

  99. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from DateToUnitCircleParams

Inherited from SequenceTransformer[T, OPVector]

Inherited from OpTransformerN[T, OPVector]

Inherited from OpTransformer

Inherited from OpPipelineStageN[T, OPVector]

Inherited from HasInN

Inherited from OpPipelineStage[OPVector]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

setParam

Ungrouped