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

Link copied to clipboard
constructor(gain: Double)
Construct a new Low-pass filter with a gain in the domain (0, 1) exclusive.

Properties

Link copied to clipboard
val gain: Double
Gain used in (0, 1), higher values of the gain are smoother but have more phase lag,

Inherited properties

Link copied to clipboard
val CUBE: UnaryFunction
A function that cubes the input value.
Link copied to clipboard
val CUBE_KEEP_SIGN: UnaryFunction
A function that cubes the input value and keeps the sign.
Link copied to clipboard
val IDENTITY: UnaryFunction
The identity function that simply returns the input value.
Link copied to clipboard
val NEGATE: UnaryFunction
A function that negates the input value.
Link copied to clipboard
val SQUARE: UnaryFunction
A function that squares the input value.
Link copied to clipboard
val SQUARE_KEEP_SIGN: UnaryFunction
A function that squares the input value and keeps the sign.

Functions

Link copied to clipboard
open fun apply(input: Double): Double
Calculate a Low-pass filter estimate.

Inherited functions

Link copied to clipboard
Link copied to clipboard
open fun applyAsDouble(operand: Double): Double
Applies this function to the input value and returns the result.
abstract fun applyAsDouble(p: Double): Double
Link copied to clipboard
Link copied to clipboard
@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).
Link copied to clipboard
@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.
Link copied to clipboard
Link copied to clipboard
@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).
Link copied to clipboard
@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.