WEMClipImagePlanesToCSOList¶
- MacroModule¶
author
package
definition
see also
keywords
Purpose¶
Converts a WEM to a CSOList with CSOs on the planes of an image.
Usage¶
Connect an image and a WEM and press Update.
Details¶
This macro calls WEMClipPlaneToCSO iteratively, clipping the WEM with each slice of the image at a time.
Windows¶
Default Panel¶
Input Fields¶
inImage¶
- name: inImage, type: Image¶
Image on whose slices the CSOs will be created
inWEM¶
- name: inWEM, type: MLBase¶
WEM that should be converted
Output Fields¶
outCSOList¶
- name: outCSOList, type: MLBase¶
CSOList that was generated from the WEM
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
|
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.