JitterXMarkerList

MLModule

genre	Marker
author	Ola Friman
package	FMEwork/ReleaseMeVis
dll	MLXMarkerUtils
definition	MLXMarkerUtils.def
keywords	jitter, perturb, dither, noise, random, normal, gaussian, points, positions, marker, xmarker

Purpose

The module JitterXMarkerList adds Gaussian noise to the positions in an XMarkerList.

Usage

Connect a marker list, set the desired jitter parameters, and press Update.

Details

Gaussian noise with user-defined mean and sigma will be added to the (x,y,z,c,t,u)-vector. C, T and U components will be rounded to be useful as indices.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase, deprecated name: inputXMarkerList

An XMarkerList with at least one marker.

Output Fields

outMarkerList

name: outMarkerList, type: MLBase, deprecated name: outputXMarkerList

An XMarkerList with noise added to the marker positions.

Parameter Fields

Field Index

[]: Trigger	In XSigma: Float	U: Float
C: Float	In YSigma: Float	Update: Trigger
Clear: Trigger	In ZSigma: Float	X: Float
doNotClearOnFailedUpdate: Bool	On Input Change Behavior: Enum	Y: Float
Has Valid Output: Bool	Random Seed: Integer	Z: Float
In CSigma: Float	Status Code: Enum
In TSigma: Float	Status Message: String
In USigma: Float	T: Float

Visible Fields

Update

name: update, type: Trigger, deprecated name: update

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: autoUpdateToggle,shouldAutoUpdate,shouldUpdateAutomatically

If checked, the module computes anew on any parameter or input change.

Values:

Title	Name	Deprecated Name
Update	Update	True,TRUE
Clear	Clear	FALSE,False

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title	Name
Ok	Ok
Invalid input object	Invalid input object
Invalid input parameter	Invalid input parameter
Internal error	Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

In XSigma

name: inXSigma, type: Float, default: 1, deprecated name: xSigma

Sets the sigma for jittering in x-direction.

In YSigma

name: inYSigma, type: Float, default: 1, deprecated name: ySigma

Sets the sigma for jittering in y-direction.

In ZSigma

name: inZSigma, type: Float, default: 1, deprecated name: zSigma

Sets the sigma for jittering in z-direction.

In CSigma

name: inCSigma, type: Float, default: 0, deprecated name: cSigma

Sets the sigma for jittering in c-direction.

In TSigma

name: inTSigma, type: Float, default: 0, deprecated name: tSigma

Sets the sigma for jittering in t-direction.

In USigma

name: inUSigma, type: Float, default: 0, deprecated name: uSigma

Sets the sigma for jittering in u-direction.

X

name: inXMean, type: Float, default: 0, deprecated name: xMean

Sets the mean value for jittering in x-direction.

Y

name: inYMean, type: Float, default: 0, deprecated name: yMean

Sets the mean value for jittering in y-direction.

Z

name: inZMean, type: Float, default: 0, deprecated name: zMean

Sets the mean value for jittering in z-direction.

C

name: inCMean, type: Float, default: 0, deprecated name: cMean

Sets the mean value for jittering in c-direction.

T

name: inTMean, type: Float, default: 0, deprecated name: tMean

Sets the mean value for jittering in t-direction.

U

name: inUMean, type: Float, default: 0, deprecated name: uMean

Sets the mean value for jittering in u-direction.

Random Seed

name: inRandomSeed, type: Integer, default: 0, deprecated name: randomSeed

Sets a random seed for the internal random generator.

If set to 0, a random seed will be determined from the current time.

Note that the precision is seconds so that the seed will only be different every new second. For values > 1, the random seed is fixed.

Hidden Fields

doNotClearOnFailedUpdate

name: doNotClearOnFailedUpdate, type: Bool, persistent: no

Prevents automated clear after update failed. This does not affect status fields. It enables the developer to analyze module’s state after failure.