WEMExtrudeCSO¶

MLModule¶

genre	`WEMProcessing`
author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`MLWEMModules`
definition	MLWEMModules.def
inherits from	`WEMGenerator`
keywords	`cone`, `shape`, `prism`, `sweep`

Purpose¶

The module WEMExtrudeCSO extrudes CSOs into surface objects, i.e., sweeps a contour along a trajectory.

Usage¶

Attach the CSO to extrude to the inCSO field. You can use a CSOFilter module to select the CSOs to extrude. Select the parameters for the extrusion, then press Apply (or use Auto Apply).

Details¶

A CSO must have a distinct plane, since Positive Offset and Negative Offset are relative to this plane. CSOs that are merely straight lines cannot be extruded.

Windows¶

Default Panel¶

../../../Modules/ML/MLWEMModules/mhelp/Images/Screenshots/WEMExtrudeCSO._default.png

Input Fields¶

inCSO¶

name: inCSO, type: CSOList(MLBase)¶: The CSOs to extrude. Each contour will be extruded separately.

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

Output Fields¶

outWEM¶

name: outWEM, type: WEM(MLBase)¶: The resulting surface.

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

Parameter Fields¶

Field Index¶

`Apply`: `Trigger`	`Generate Covers Separately`: `Bool`	`Number Of Sections`: `Integer`
`Auto Apply`: `Bool`	`Generate Edges`: `Bool`	`Overwrite label and description`: `Bool`
`clear`: `Trigger`	`Generate Top Cover`: `Bool`	`Positive Offset`: `Double`
`Description`: `String`	`Generate Walls`: `Bool`	`Rotation Degree Per MM`: `Double`
`Direction`: `Vector3`	`id`: `Integer`	`Rotation Origin`: `Vector3`
`elapsedTime`: `Float`	`isProcessing`: `Bool`	`shouldComputeNormals`: `Bool`
`Extrusion Mode`: `Enum`	`Label`: `String`	`updateMode`: `Enum`
`Generate Bottom Cover`: `Bool`	`Negative Offset`: `Double`	`validWEM`: `Bool`

Visible Fields¶

Auto Apply¶

name: autoApply, type: Bool, default: FALSE¶: If checked, the extrusion is performed automatically if the extrusion parameters change.

Apply¶

name: apply, type: Trigger¶: When pressed, the extrusion is performed.

Overwrite label and description¶

name: overwriteLabelDescription, type: Bool, default: FALSE¶: If checked, Label and Description will be used for the generated WEM.

Label¶

name: label, type: String¶: Sets the label of the generated WEM (if Overwrite label and description is on).

Description¶

name: description, type: String¶: Sets the description of the generated WEM (if Overwrite label and description is on).

Extrusion Mode¶

name: extrusionMode, type: Enum, default: RELATIVE¶: Defines the type of extrusion to perform.

Values:

Title

Name

Description

Relative

RELATIVE

:field:direction is a direction vector in this mode. The extrusion will be performed along this vector. Positive Offset and Negative Offset are absolute distances along the normal of the CSO’s plane.

Note: If Direction and the CSO’s plane normal are slanted against each other, the shape will be elongated. If they are perpendicular, the module will refuse to extrude the CSO.

Relative Times Direction

RELATIVE_TIMES_DIRECTION

:field:direction is a direction vector in this mode. The extrusion will be performed along this vector. Positive Offset and Negative Offset are simply multiplied with Direction to get the start and end offsets of the shape.

Absolute

ABSOLUTE

:field:direction is an absolute point in world space this mode. The extrusion will be performed toward this point.

Direction¶

name: direction, type: Vector3, default: 1 0 0¶

The direction of the sweep.

If Extrusion Mode is RELATIVE, this is a direction vector.
If Extrusion Mode is RELATIVE_TIMES_DIRECTION, this is the base offset of the extrusion, multiplied with Positive Offset and Negative Offset.
If Extrusion Mode is ABSOLUTE, this is a point in world space toward which the contour is extruded.

The distance to extrude is given by Positive Offset and Negative Offset.

Positive Offset¶

name: positiveOffset, type: Double, default: 10, minimum: 0¶

Sets the distance by which the contour is extruded toward the direction given by Direction.

Unless the extrusion mode is RELATIVE_TIMES_DIRECTION, the distance is measured perpendicular to the CSO’s plane, that is, along the normal vector of the plane as, e.g., returned by CSOInfo.csoPlaneNormal.

Negative Offset¶

name: negativeOffset, type: Double, default: 0, minimum: 0¶: Same as Positive Offset for the opposite direction.

Number Of Sections¶

name: numberOfSections, type: Integer, default: 1, minimum: 1¶

Sets the number of sections to generate along the sweep.

If you specify a rotation with Rotation Degree Per MM, you should specify a high number of sections to get a smooth rotation.

Rotation Degree Per MM¶

name: rotationDegreePerMM, type: Double, default: 0¶

Sets a rotation along the sweep.

The rotation will increase with distance to the original plane.

Rotation Origin¶

name: rotationOrigin, type: Vector3, default: 0 0 0¶

Sets the point around which to rotate.

This point will be projected along with the points of the extruded contour, so it should be located in the plane of the contour.

Generate Top Cover¶

name: generateTopCover, type: Bool, default: TRUE¶: If checked, the top cover of the surface is generated.

Generate Bottom Cover¶

name: generateBottomCover, type: Bool, default: TRUE¶: If checked, the bottom cover of the surface is generated.

Generate Walls¶

name: generateWalls, type: Bool, default: TRUE¶: If checked, the walls of the surface are generated.

Generate Covers Separately¶

name: generateCoversSeparately, type: Bool, default: FALSE¶: If checked, the top and bottom covers (if generated) are stored in separate patches.

Generate Edges¶

name: generateEdges, type: Bool, default: TRUE¶: If checked, the edges for the resulting WEM surface are generated. This is needed for many subsequent processing steps.

Hidden Fields¶

isProcessing¶

name: isProcessing, type: Bool, persistent: no¶

see WEMGenerator.isProcessing

elapsedTime¶

name: elapsedTime, type: Float, persistent: no¶

see WEMGenerator.elapsedTime

id¶

name: id, type: Integer, default: 0¶

see WEMGenerator.id

updateMode¶

name: updateMode, type: Enum, default: AutoUpdate¶

see WEMGenerator.updateMode

clear¶

name: clear, type: Trigger¶

see WEMGenerator.clear

shouldComputeNormals¶

name: shouldComputeNormals, type: Bool, default: FALSE¶

see WEMGenerator.shouldComputeNormals

validWEM¶

name: validWEM, type: Bool, default: TRUE¶