LSLProcessingOptions enum

Automatic post-processing an inlet applies to incoming time stamps.

The default is no post-processing at all: the inlet returns ground-truth time stamps in the sender's clock domain, which you synchronize yourself with LSLInlet.getTimeCorrection.

Warning: once post-processing is enabled the original time stamps are neither delivered nor recoverable.

Inheritance
Available extensions

Values

none → const LSLProcessingOptions

No automatic post-processing; ground-truth time stamps, for manual synchronization. This is the inlet default.

const LSLProcessingOptions(lsl_processing_options_t.proc_none)
clockSync → const LSLProcessingOptions

Automatic clock synchronization: equivalent to adding the LSLInlet.getTimeCorrection value to every received time stamp.

Do not enable this under liblsl_coordinator. Its MessageTiming treats the sample time stamp as the sender's clock and adds the offset itself, so a pre-corrected time stamp would be corrected twice and every reported transit time would be wrong by roughly one offset.

const LSLProcessingOptions(lsl_processing_options_t.proc_clocksync)
dejitter → const LSLProcessingOptions

Remove jitter from time stamps by smoothing them.

Needs to see a minimum number of samples (30-120 seconds worst case) before the residual jitter is consistently below 1 ms. See LSLInlet.setSmoothingHalftime to tune the smoothing window.

const LSLProcessingOptions(lsl_processing_options_t.proc_dejitter)
monotonize → const LSLProcessingOptions

Force time stamps to ascend monotonically. Only meaningful together with dejitter.

const LSLProcessingOptions(lsl_processing_options_t.proc_monotonize)
threadSafe → const LSLProcessingOptions

Make post-processing thread-safe, so one inlet can be read from multiple threads. Uses somewhat more CPU.

const LSLProcessingOptions(lsl_processing_options_t.proc_threadsafe)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
nativeType → lsl_processing_options_t
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → int
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromNative(lsl_processing_options_t native) → LSLProcessingOptions
Converts a native lsl_processing_options_t value to the corresponding LSLProcessingOptions enum value.
fromValue(int value) → LSLProcessingOptions
Converts an integer value to the corresponding LSLProcessingOptions enum value.

Constants

values → const List<LSLProcessingOptions>
A constant List of the values in this enum, in order of their declaration.