SetTileProcessorProperties¶
-
MLModule
¶ genre ML_Inference_PatchBased_Properties
author Jan-Martin Kuhnigk
package FMEstable/ReleaseMeVis
dll MLSetTileProcessorProperties
definition MLSetTileProcessorProperties.def see also ApplyTileProcessorPageWise
keywords SetProposedTileProperties
,inference
,TileProcessor
,TileProperties
,TileProcessorProperties
,modify
,change
,set
,overwrite
Purpose¶
Can be used to create or modify (proposed) tile processor properties to be used e.g. by modules ProcessTiles
and ApplyTileProcessorPageWise
.
Usage¶
- Connect your tile processor and/or properties to the input, or leave it open to create properties from scratch.
- Open the panel and verify the “original” proposed properties
- Check the ‘ORIGINAL/REMOVE/CUSTOM’ buttons to remove or overwrite the properties you don’t like. When choosing CUSTOM, enter the preferred values to their right.
- Press update to apply the changes.
Details¶
Dimensions¶
As dimensions
, use a comma-separated list describing the order in which the input data dimensions are expected by the processor, in ML order, i.e. smallest stride (X) first. On top of the data (typically spatial) dimensions provided to the processor, you can specify where the input channel and batch dimensions are located. Valid elemental values are X, Y, Z, C, T, U, as well as CHANNEL (or CHANNEL1), CHANNEL2, BATCH and UNUSED. UNUSED can be used for all dimensions not required by the processor (but it can also be omitted).
Typical examples are
X, Y, CHANNEL, BATCH
for 2D processors with a channel and batch dimension, or
X, Y, Z, CHANNEL, BATCH
for 3D processors with a channel and batch dimension.
Input Fields¶
inObject¶
-
name:
inObject
, type:
TileProcessorPropertiesSource/TileProcessorContainer/TileProcessor(MLBase)
, deprecated name:
inTileProcessor,inTileProperties
¶ Optional input that may be Null or a
TileProcessor
,TileProcessorProperties(Source)
orTileProcessorContainer
object. You can require the input to contain a valid processor viaRequire valid input processor
.
Output Fields¶
outObject¶
-
name:
outObject
, type:
CppTileProcessorProperties/TileProcessorContainer(MLBase)
, deprecated name:
outTileProcessor,outTileProperties
¶ Output TileProcessor, TilePropertiesSource or TileProcessorContainer (BaseList).
This is what to expect:
Input: Null (empty) -> Output: CppTileProperties
Input: TilePropertiesSource -> Output: CppTileProperties
Input: TileProcessor -> Output: TileProcessorContainer (containing the unmodified input tile processor and the new tile properties)
Input: TileProcessorContainer -> Output: TileProcessorContainer (with the same content as the input TileProcessorContainer, except for the modified/new tile properties)
Make sure to set
Require valid input processor
accordingly or you will wind up with an invalid output for some of these constellations.
Parameter Fields¶
Field Index¶
Visible Fields¶
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 |
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).
Require valid input processor¶
-
name:
inRequireValidProcessor
, type:
Bool
, default:
TRUE
, deprecated name:
inRequireValidTileClassifier,inRequireValidTileProcessor
¶ If enabled, the module will refuse to update if no valid input processor is connected. Enable this if you are sure the input should be/contain a processor to detect errors early.
Has Valid Input Properties¶
-
name:
outHasValidInputProperties
, type:
Bool
, persistent:
no
, deprecated name:
outHasValidInputTileProcessorProperties,outHasValidInputTileProperties
¶ Indicates if valid input properties object was detected. This also indicates whether the ‘proposed’ parameters come from a valid input properties object, or are just the default values.