BunyipsLib/au.edu.sa.mbhs.studentrobotics.bunyipslib.util/Filter/LowPass

LowPass

open class LowPass : UnaryFunction

A Low-pass filter that uses a single gain to measure filter response time, cleaning up noisy sensor inputs.

Constructors

LowPass

constructor(gain: Double)

Construct a new Low-pass filter with a gain in the domain (0, 1) exclusive.

Inherited properties

CUBE

val CUBE: UnaryFunction

A function that cubes the input value.

CUBE_KEEP_SIGN

val CUBE_KEEP_SIGN: UnaryFunction

A function that cubes the input value and keeps the sign.

IDENTITY

val IDENTITY: UnaryFunction

The identity function that simply returns the input value.

NEGATE

val NEGATE: UnaryFunction

A function that negates the input value.

SQUARE

val SQUARE: UnaryFunction

A function that squares the input value.

SQUARE_KEEP_SIGN

val SQUARE_KEEP_SIGN: UnaryFunction

A function that squares the input value and keeps the sign.

Functions

apply

open fun apply(input: Double): Double

Calculate a Low-pass filter estimate.

Inherited functions

div

@NonNull

open fun div(@NonNull divisor: UnaryFunction): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) / g(x).

@NonNull

open fun div(divisor: Double): UnaryFunction

Creates a composite function h(x) such that h(x) = 1/k * f(x).

exp

@NonNull

open fun exp(@NonNull exponent: UnaryFunction): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) ^ g(x).

@NonNull

open fun exp(exponent: Double): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) ^ k.

mult

@NonNull

open fun mult(@NonNull multiplier: UnaryFunction): UnaryFunction

Creates a composite function h(x) such that h(x) = f(x) * g(x).

@NonNull

open fun mult(multiplier: Double): UnaryFunction

Creates a composite function h(x) such that h(x) = k * f(x).

pipeTo

@NonNull

open fun pipeTo(@NonNull next: UnaryFunction): UnaryFunction

Constructs a new function that first calls this function, then passes the result to another as input.