KSLCore/ksl.controls.experiments/TwoLevelFactor

TwoLevelFactor

class TwoLevelFactor(name: String, low: Double = -1.0, high: Double = 1.0) : Factor

Creates a two level factor with provided low and high values.

Parameters

name

the name of the factor

low

the low value of factor, must be strictly less than the high value

high

the high value of the factor, must be strictly greater than the low value

Constructors

constructor(name: String, low: Double = -1.0, high: Double = 1.0)

Properties

val codedLevels: List<Double>

The levels as coded values.

val halfRange: Double

The half-range of the levels.

override val id: Int

val interval: Interval

open override var label: String?

val levels: List<Double>

The levels as a list

val midPoint: Double

The mid-point of the levels.

override val name: String

Functions

fun codedLevels(): DoubleArray

The coded levels as an array.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

fun isInRange(value: Double): Boolean

True if the value is within the range limits of the factor

fun levels(): DoubleArray

The levels as an array.

fun toCodedValue(rawValue: Double): Double

Converts the original raw value to the coded measurement scale. This conversion does not check if the raw value is within the range limits of the factor.

toOriginalValue

fun toOriginalValue(codedValue: Double): Double

Converts the coded value to the original measurement scale

open override fun toString(): String