CreateRandomXMarkers

MacroModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
definition	CreateRandomXMarkers.def
see also	JitterXMarkerList
keywords	random, marker, position, list, pattern, test, example

Purpose

This module creates a list of random XMarkers.

Usage

Set the number of desired markers, the jitter/randomness parameters, and press Update.

Details

All marker coordinates are internally generated as floating-point numbers, with C/T/U coordinates rounded to integers to be useful. The mean/sigma parameters for these dimensions have to be set accordingly.

Windows

Default Panel

Output Fields

outMarkerList

name: outMarkerList, type: XMarkerList(MLBase)

An XMarkerList with N randomly placed markers.

For accessing this object via scripting, see the Scripting Reference: MLXMarkerListWrapper.

Parameter Fields

Field Index

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

Visible Fields

Update

name: update, type: Trigger

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: shouldAutoUpdate,shouldUpdateAutomatically

Declares how the module should react if a value of an input field changes.

Values:

Title	Name	Deprecated Name
​Update	​Update	​TRUE
​Clear	​Clear	​FALSE

[]

name: updateDone, type: Trigger, persistent: no

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

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

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

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.

Number of Markers

name: inNumberOfMarkers, type: Integer, default: 1, minimum: 1

The number of markers to create.

X

name: inXMean, type: Float, default: 0

Sets the mean value for jittering in X-direction.

Y

name: inYMean, type: Float, default: 0

Sets the mean value for jittering in Y-direction.

Z

name: inZMean, type: Float, default: 0

Sets the mean value for jittering in Z-direction.

C

name: inCMean, type: Float, default: 0

Sets the mean value for jittering in C-direction.

T

name: inTMean, type: Float, default: 0

Sets the mean value for jittering in T-direction.

U

name: inUMean, type: Float, default: 0

Sets the mean value for jittering in U-direction.

In XSigma

name: inXSigma, type: Float, default: 1

Sets the sigma value for jittering in X-direction.

In YSigma

name: inYSigma, type: Float, default: 1

Sets the sigma value for jittering in Y-direction.

In ZSigma

name: inZSigma, type: Float, default: 1

Sets the sigma value for jittering in Z-direction.

In CSigma

name: inCSigma, type: Float, default: 0

Sets the sigma value for jittering in C-direction.

In TSigma

name: inTSigma, type: Float, default: 0

Sets the sigma value for jittering in T-direction.

In USigma

name: inUSigma, type: Float, default: 0

Sets the sigma value for jittering in U-direction.

Random Seed

name: inRandomSeed, type: Integer, default: 0

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.