CSOSmooth

MLModule

genre	CSOModificator
author	Frank Heckel
package	FMEstable/ReleaseMeVis
dll	MLCSOMiscModulesStable
definition	MLCSOMiscModulesStable.def
see also	CSOAffineTransformationModificator, CSOReduce
keywords	CSO, contour, segmentation, modification, reduction

Purpose

The module CSOSmooth smooths all CSOs of a subset or CSOs in a CSO list with a Laplacian smoothing algorithm.

The module can either modify the subset of chosen CSOs directly or generate copies of them before smoothing them.

Details

The module changes the type of the CSO so it cannot be further processed using the CSOProcessor that might have been used for generating the CSO.

Windows

Default Panel

Input Fields

inCSOList

name: inCSOList, type: MLBase

Output Fields

outCSOList

name: outCSOList, type: MLBase

Parameter Fields

Field Index

addCSOToGroupMode: Enum	isProcessing: Bool	Smoothing Amount: Integer
addCSOToGroupWithId: Integer	Level: Bool	Smoothing Mode: Enum
addCSOToGroupWithLabel: String	Mode (updateMode): Enum	Style: Enum
Auto apply: Bool	Mode (seedPointStyle): Enum	Update: Trigger
Change settings of modified CSOs: Bool	Num Smooth Passes: Integer	Use Displacement Adjustment: Bool
Color (pathPointColor): Color	Path Point Alpha: Float	Use Smooth: Bool
Color (seedPointColor): Color	Point Mode: Enum	Use Undo Redo: Bool
CSO Ids: String	Seed Point Alpha: Float	Value: Float
done: Trigger	Selection: Bool	Width: Float
emptyGroupBeforeGeneration: Bool	Size: Float	Work directly on input CSOList: Bool
Finishing: Bool	Smooth Factor: Float	Write Mode: Enum
id: Integer	Smooth Range: Integer

Visible Fields

Mode (updateMode)

name: updateMode, type: Enum, default: Off

Defines the update mode.

Values:

Title	Name	Description
Off	Off	Nothing happens on input change.
Auto Update	AutoUpdate	The module computes anew on input change.

Auto apply

name: autoApply, type: Bool, default: FALSE

If checked, the module computes anew on any field change.

Update

name: apply, type: Trigger

If pressed, the module computes anew.

Style

name: pathPointStyle, type: Enum, default: LineStyleSolid, deprecated name: pathPointLineStyle

Defines the path point style.

Available if Change settings of modified CSOs is checked.

Values:

Title	Name
None	LineStyleNone
Solid	LineStyleSolid
Dashed	LineStyleDashed
Dotted	LineStyleDotted
Short Dashed	LineStyleShortDashed

Width

name: pathPointWidth, type: Float, default: 1, deprecated name: pathPointLineWidth

Sets the line width of the path.

Available if Change settings of modified CSOs is checked.

Color (pathPointColor)

name: pathPointColor, type: Color, default: 1 1 0

Sets the color of the path points.

Available if Change settings of modified CSOs is checked.

Path Point Alpha

name: pathPointAlpha, type: Float, default: 1, minimum: 0, maximum: 1

Sets the alpha value of the path points.

Available if Change settings of modified CSOs is checked.

Mode (seedPointStyle)

name: seedPointStyle, type: Enum, default: MarkerModeRect, deprecated name: markerMode

Defines the style of the seed points.

Available if Change settings of modified CSOs is checked.

Values:

Title	Name
None	MarkerModeNone
Rect	MarkerModeRect
Circle	MarkerModeCircle

Size

name: seedPointSize, type: Float, default: 2, deprecated name: markerSize

Sets the size of the seed points.

Available if Change settings of modified CSOs is checked.

Color (seedPointColor)

name: seedPointColor, type: Color, default: 0 1 0, deprecated name: markerColor

Sets the color of the seed points.

Available if Change settings of modified CSOs is checked.

Seed Point Alpha

name: seedPointAlpha, type: Float, default: 1, minimum: 0, maximum: 1, deprecated name: markerAlpha

Sets the alpha value of the path points.

Available if Change settings of modified CSOs is checked.

Write Mode

name: voxelWriteMode, type: Enum, default: VoxelWriteModeModule

Defines the voxel write mode.

Available if Change settings of modified CSOs is checked.

Values:

Title	Name
Id	VoxelWriteModeId
Const	VoxelWriteModeConst
Const Plus Id	VoxelWriteModeConstPlusId
Module	VoxelWriteModeModule

Value

name: voxelWriteValue, type: Float, default: 1024

Sets the voxel write value.

Available if Change settings of modified CSOs is checked.

CSO Ids

name: csoIdList, type: String

Sets the list of ids of those CSOs that are to be smoothed. If empty, all CSOs are smoothed.

Work directly on input CSOList

name: workDirectlyOnInputList, type: Bool, default: TRUE

If checked, the module works directly on the input CSOList. Otherwise, the module copies the input CSOList and works and outputs the copy.

Change settings of modified CSOs

name: changeSettingsForModifiedCSOs, type: Bool, default: FALSE

If checked, the attributes of smoothed CSOs are changed according to the settings of this module.

Finishing

name: listenToFinishingNotifications, type: Bool, default: TRUE

If checked, the module listens to finishing notifications.

Receiving a notification counts as an input change.

Selection

name: listenToSelectionNotifications, type: Bool, default: TRUE

If checked, the module listens to selection notifications.

Receiving a notification counts as an input change.

Point Mode

name: pointMode, type: Enum, default: PathPoints

Defines on which points the module applies the smoothing to.

Values:

Title	Name	Description
Seed Points	SeedPoints	Smoothing based on the seed points.
Path Points	PathPoints	Smoothing based on the path points.

Use Smooth

name: useSmooth, type: Bool, default: TRUE

If checked, the module smooths the seed or path points.

Otherwise, only the attribute changes are applied.

Num Smooth Passes

name: numSmoothPasses, type: Integer, default: 10, minimum: 1

Sets the number of smoothing passes.

Smooth Factor

name: smoothFactor, type: Float, default: 0.1, minimum: 0, maximum: 1

Sets the smoothing factor.

Smooth Range

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

Sets the smoothing range.

The range is the window or number of consecutive points that are taken into consideration for smoothing one point in the Laplacian smoothing.

Use Displacement Adjustment

name: useDisplacementAdjustment, type: Bool, default: TRUE

If checked, the module applies a displacement adjustment that prevents the smoothed CSOs from shrinking too much.

Smoothing Mode

name: smoothingMode, type: Enum, default: SmoothingModeSplineApproximation

Defines how the path points are generated from the seed points of the CSO.

Values:

Title	Name	Description
None	SmoothingModeNone	Seed points are connected by a straight line.
Spline Approximation	SmoothingModeSplineApproximation	Uses B-Splines (path point so not necessarily pass through the seed points).
Spline Interpolation	SmoothingModeSplineInterpolation	Uses Catmull-Rom-Splines (path point pass through the seed points).

Smoothing Amount

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

Sets the smoothing strength for spline smoothing.

Level

name: level, type: Bool, default: FALSE

If checked, the smoothed CSO is also leveled, which means it is projected onto the plane that is defined by the CSO’s normal.

Use Undo Redo

name: useUndoRedo, type: Bool, default: TRUE

If checked, the smoothing operation can be undone by using the CSOList’s undo/redo manager.

Hidden Fields

isProcessing

name: isProcessing, type: Bool, default: FALSE

done

name: done, type: Trigger

emptyGroupBeforeGeneration

name: emptyGroupBeforeGeneration, type: Bool, default: FALSE

addCSOToGroupMode

name: addCSOToGroupMode, type: Enum, default: AddToGroupByLabel

Values:

Title	Name
None	AddToGroupNone
By Label	AddToGroupByLabel
By Id	AddToGroupById

addCSOToGroupWithLabel

name: addCSOToGroupWithLabel, type: String

addCSOToGroupWithId

name: addCSOToGroupWithId, type: Integer, default: -1

id

name: id, type: Integer, default: 0