CSOCompare¶

MLModule¶

genre	`CSO`
author	`Jan Hendrik Moltz`
package	`FMEstable/ReleaseMeVis`
dll	`MLCSOCompare`
definition	MLCSOCompare.def
see also	`ImageCompare`, `CurveCompare`, `DicomTreeCompare`, `CompareInventorSceneSampling`, `CompareScreenshotsStable`, `PCLCompare`, `CompareNetworks`, `XMarkerListCompare`
keywords	`csolist`, `comparison`, `equal`, `different`

Purpose¶

Compares two CSOLists according to selectable criteria.

Usage¶

Connect two CSOLists, select the criteria to compare, and press Update. Look at CSOLists are equal to see whether the CSOLists are equal. If it is False, First difference shows you the first criterion for which the comparison failed.

Details¶

Three kinds of criteria are used, relating to the CSOLists as whole, to CSOs, and to CSOGroups. Criteria for CSOs and CSOGroups are fulfilled if the number of CSOs or CSOGroups is equal and the criteria are fulfilled for all corresponding pairs of CSOs or CSOGroups. Pairs can be formed by indices or by ids. When a difference is found for any criterion, the whole comparison stops. Therefore only the first difference is reported.

Windows¶

Default Panel¶

../../../Projects/MLCSOCompare/Modules/mhelp/Images/Screenshots/CSOCompare._default.png

Input Fields¶

inCSOList0¶

name: inCSOList0, type: MLBase¶: The first CSOList to be compared.

inCSOList1¶

name: inCSOList1, type: MLBase¶: The second CSOList to be compared.

Parameter Fields¶

Field Index¶

`[]`: `Trigger`	`Number of seed points`: `Bool`	`Time point index (inCompareCSOTimePointIndex)`: `Bool`
`Clear`: `Trigger`	`On Input Change Behavior`: `Enum`	`Time point index (inCompareCSOGroupTimePointIndex)`: `Bool`
`Compare CSOs and CSOGroups by id rather than by index`: `Bool`	`Path point alpha (inCompareCSOPathPointAlpha)`: `Bool`	`Type`: `Bool`
`Creator id`: `Bool`	`Path point alpha (inCompareCSOGroupPathPointAlpha)`: `Bool`	`Update`: `Trigger`
`CSO ids`: `Bool`	`Path point color (inCompareCSOPathPointColor)`: `Bool`	`Use editable state`: `Bool`
`CSOLists are equal`: `Bool`	`Path point color (inCompareCSOGroupPathPointColor)`: `Bool`	`Use path point alpha`: `Bool`
`CSOs in groups`: `Bool`	`Path point style (inCompareCSOPathPointStyle)`: `Bool`	`Use path point color`: `Bool`
`Description (inCompareCSODescription)`: `Bool`	`Path point style (inCompareCSOGroupPathPointStyle)`: `Bool`	`Use path point style`: `Bool`
`Description (inCompareCSOGroupDescription)`: `Bool`	`Path point width (inCompareCSOPathPointWidth)`: `Bool`	`Use path point width`: `Bool`
`doNotClearOnFailedUpdate`: `Bool`	`Path point width (inCompareCSOGroupPathPointWidth)`: `Bool`	`Use seed point alpha`: `Bool`
`Editable state (inCompareCSOEditableState)`: `Bool`	`Path points`: `Bool`	`Use seed point color`: `Bool`
`Editable state (inCompareCSOGroupEditableState)`: `Bool`	`Seed point alpha (inCompareCSOSeedPointAlpha)`: `Bool`	`Use seed point size`: `Bool`
`Epsilon for float comparisons`: `Double`	`Seed point alpha (inCompareCSOGroupSeedPointAlpha)`: `Bool`	`Use seed point style`: `Bool`
`First difference`: `String`	`Seed point color (inCompareCSOSeedPointColor)`: `Bool`	`Use show state`: `Bool`
`Group ids`: `Bool`	`Seed point color (inCompareCSOGroupSeedPointColor)`: `Bool`	`Use time point index`: `Bool`
`Has Valid Output`: `Bool`	`Seed point size (inCompareCSOSeedPointSize)`: `Bool`	`Use voxel write mode`: `Bool`
`Id (inCompareCSOId)`: `Bool`	`Seed point size (inCompareCSOGroupSeedPointSize)`: `Bool`	`Use voxel write value`: `Bool`
`Id (inCompareCSOGroupId)`: `Bool`	`Seed point style (inCompareCSOSeedPointStyle)`: `Bool`	`Use voxelize state`: `Bool`
`Index (inCompareCSOIndex)`: `Bool`	`Seed point style (inCompareCSOGroupSeedPointStyle)`: `Bool`	`User data (inCompareCSOUserData)`: `Bool`
`Index (inCompareCSOGroupIndex)`: `Bool`	`Seed points`: `Bool`	`User data (inCompareCSOGroupUserData)`: `Bool`
`Label (inCompareCSOLabel)`: `Bool`	`Selected state (inCompareCSOSelectedState)`: `Bool`	`Voxel write mode (inCompareCSOVoxelWriteMode)`: `Bool`
`Label (inCompareCSOGroupLabel)`: `Bool`	`Selected state (inCompareCSOGroupSelectedState)`: `Bool`	`Voxel write mode (inCompareCSOGroupVoxelWriteMode)`: `Bool`
`Number of CSOs (inCompareNumCSOs)`: `Bool`	`Show state (inCompareCSOShowState)`: `Bool`	`Voxel write value (inCompareCSOVoxelWriteValue)`: `Bool`
`Number of CSOs (inCompareCSOGroupNumCSOs)`: `Bool`	`Show state (inCompareCSOGroupShowState)`: `Bool`	`Voxel write value (inCompareCSOGroupVoxelWriteValue)`: `Bool`
`Number of groups (inCompareNumGroups)`: `Bool`	`Status Code`: `Enum`	`Voxelize state (inCompareCSOVoxelizeState)`: `Bool`
`Number of groups (inCompareCSONumGroups)`: `Bool`	`Status Message`: `String`	`Voxelize state (inCompareCSOGroupVoxelizeState)`: `Bool`
`Number of path points`: `Bool`	`Subtype`: `Bool`

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

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).

Compare CSOs and CSOGroups by id rather than by index¶

name: inCompareById, type: Bool, default: FALSE¶: If true, comparison pairs of CSOs and CSOGroups in the CSOLists are formed by id, otherwise by index.

Number of CSOs (inCompareNumCSOs)¶

name: inCompareNumCSOs, type: Bool, default: TRUE¶: If true, the number of CSOs must be equal for CSOLists are equal to be true.

Number of groups (inCompareNumGroups)¶

name: inCompareNumGroups, type: Bool, default: TRUE¶: If true, the number of CSOGroups must be equal for CSOLists are equal to be true.

CSO ids¶

name: inCompareCSOIds, type: Bool, default: TRUE¶: If true, the set of CSO ids must be equal for CSOLists are equal to be true.

Group ids¶

name: inCompareGroupIds, type: Bool, default: TRUE¶: If true, the set of CSOGroup ids must be equal for CSOLists are equal to be true.

CSOs in groups¶

name: inCompareCSOsInGroups, type: Bool, default: TRUE¶: If true, the inclusion of CSOs in CSOGroups must be equal for CSOLists are equal to be true.

Id (inCompareCSOId)¶

name: inCompareCSOId, type: Bool, default: TRUE¶: If true, the ids of corresponding CSOs according to Compare CSOs and CSOGroups by id rather than by index must be equal for CSOLists are equal to be true.

Index (inCompareCSOIndex)¶

name: inCompareCSOIndex, type: Bool, default: TRUE¶: If true, the indices of corresponding CSOs according to Compare CSOs and CSOGroups by id rather than by index must be equal for CSOLists are equal to be true.

Number of seed points¶

name: inCompareCSONumSeedPoints, type: Bool, default: TRUE¶: If true, the number of seed points of corresponding CSOs must be equal for CSOLists are equal to be true.

Seed points¶

name: inCompareCSOSeedPoints, type: Bool, default: TRUE¶: If true, the seed points of corresponding CSOs must be equal for CSOLists are equal to be true.

Number of path points¶

name: inCompareCSONumPathPoints, type: Bool, default: TRUE¶: If true, the number of path points of corresponding CSOs must be equal for CSOLists are equal to be true.

Path points¶

name: inCompareCSOPathPoints, type: Bool, default: TRUE¶: If true, the path points of corresponding CSOs must be equal for CSOLists are equal to be true.If true, the number of CSOs must be equal for CSOLists are equal to be true.

Selected state (inCompareCSOSelectedState)¶

name: inCompareCSOSelectedState, type: Bool, default: TRUE¶: If true, the selected state of corresponding CSOs must be equal for CSOLists are equal to be true.

Number of groups (inCompareCSONumGroups)¶

name: inCompareCSONumGroups, type: Bool, default: TRUE¶: If true, the number of CSOGroups of corresponding CSOs must be equal for CSOLists are equal to be true.

Type¶

name: inCompareCSOType, type: Bool, default: TRUE¶: If true, the type of corresponding CSOs must be equal for CSOLists are equal to be true.

Subtype¶

name: inCompareCSOSubType, type: Bool, default: TRUE¶: If true, the subtype of corresponding CSOs must be equal for CSOLists are equal to be true.

Creator id¶

name: inCompareCSOCreatorId, type: Bool, default: TRUE¶: If true, the creator id of corresponding CSOs must be equal for CSOLists are equal to be true.

User data (inCompareCSOUserData)¶

name: inCompareCSOUserData, type: Bool, default: TRUE¶: If true, the user data of corresponding CSOs must be equal for CSOLists are equal to be true.

Label (inCompareCSOLabel)¶

name: inCompareCSOLabel, type: Bool, default: TRUE¶: If true, the label of corresponding CSOs must be equal for CSOLists are equal to be true.

Description (inCompareCSODescription)¶

name: inCompareCSODescription, type: Bool, default: TRUE¶: If true, the description of corresponding CSOs must be equal for CSOLists are equal to be true.

Time point index (inCompareCSOTimePointIndex)¶

name: inCompareCSOTimePointIndex, type: Bool, default: TRUE¶: If true, the time point index of corresponding CSOs must be equal for CSOLists are equal to be true.

Show state (inCompareCSOShowState)¶

name: inCompareCSOShowState, type: Bool, default: TRUE¶: If true, the show state of corresponding CSOs must be equal for CSOLists are equal to be true.

Voxelize state (inCompareCSOVoxelizeState)¶

name: inCompareCSOVoxelizeState, type: Bool, default: TRUE¶: If true, the voxelize state of corresponding CSOs must be equal for CSOLists are equal to be true.

Editable state (inCompareCSOEditableState)¶

name: inCompareCSOEditableState, type: Bool, default: TRUE¶: If true, the editable state of corresponding CSOs must be equal for CSOLists are equal to be true.

Path point style (inCompareCSOPathPointStyle)¶

name: inCompareCSOPathPointStyle, type: Bool, default: TRUE¶: If true, the path point style of corresponding CSOs must be equal for CSOLists are equal to be true.

Path point width (inCompareCSOPathPointWidth)¶

name: inCompareCSOPathPointWidth, type: Bool, default: TRUE¶: If true, the path point width of corresponding CSOs must be equal for CSOLists are equal to be true.

Path point color (inCompareCSOPathPointColor)¶

name: inCompareCSOPathPointColor, type: Bool, default: TRUE¶: If true, the path point color of corresponding CSOs must be equal for CSOLists are equal to be true.

Path point alpha (inCompareCSOPathPointAlpha)¶

name: inCompareCSOPathPointAlpha, type: Bool, default: TRUE¶: If true, the path point alpha of corresponding CSOs must be equal for CSOLists are equal to be true.

Seed point style (inCompareCSOSeedPointStyle)¶

name: inCompareCSOSeedPointStyle, type: Bool, default: TRUE¶: If true, the seed point style of corresponding CSOs must be equal for CSOLists are equal to be true.

Seed point size (inCompareCSOSeedPointSize)¶

name: inCompareCSOSeedPointSize, type: Bool, default: TRUE¶: If true, the seed point size of corresponding CSOs must be equal for CSOLists are equal to be true.

Seed point color (inCompareCSOSeedPointColor)¶

name: inCompareCSOSeedPointColor, type: Bool, default: TRUE¶: If true, the seed point color of corresponding CSOs must be equal for CSOLists are equal to be true.

Seed point alpha (inCompareCSOSeedPointAlpha)¶

name: inCompareCSOSeedPointAlpha, type: Bool, default: TRUE¶: If true, the seed point alpha of corresponding CSOs must be equal for CSOLists are equal to be true.

Voxel write mode (inCompareCSOVoxelWriteMode)¶

name: inCompareCSOVoxelWriteMode, type: Bool, default: TRUE¶: If true, the voxel write mode of corresponding CSOs must be equal for CSOLists are equal to be true.

Voxel write value (inCompareCSOVoxelWriteValue)¶

name: inCompareCSOVoxelWriteValue, type: Bool, default: TRUE¶: If true, the voxel write value of corresponding CSOs must be equal for CSOLists are equal to be true.

Id (inCompareCSOGroupId)¶

name: inCompareCSOGroupId, type: Bool, default: TRUE¶: If true, the ids of corresponding CSOGroups according to Compare CSOs and CSOGroups by id rather than by index must be equal for CSOLists are equal to be true.

Index (inCompareCSOGroupIndex)¶

name: inCompareCSOGroupIndex, type: Bool, default: TRUE¶: If true, the indices of corresponding CSOGroups according to Compare CSOs and CSOGroups by id rather than by index must be equal for CSOLists are equal to be true.

Selected state (inCompareCSOGroupSelectedState)¶

name: inCompareCSOGroupSelectedState, type: Bool, default: TRUE¶: If true, the selected state of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Number of CSOs (inCompareCSOGroupNumCSOs)¶

name: inCompareCSOGroupNumCSOs, type: Bool, default: TRUE¶: If true, the number of CSO of corresponding CSOGroups must be equal for CSOLists are equal to be true.

User data (inCompareCSOGroupUserData)¶

name: inCompareCSOGroupUserData, type: Bool, default: TRUE¶: If true, the user data of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Label (inCompareCSOGroupLabel)¶

name: inCompareCSOGroupLabel, type: Bool, default: TRUE¶: If true, the label of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Description (inCompareCSOGroupDescription)¶

name: inCompareCSOGroupDescription, type: Bool, default: TRUE¶: If true, the description of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Time point index (inCompareCSOGroupTimePointIndex)¶

name: inCompareCSOGroupTimePointIndex, type: Bool, default: TRUE¶: If true, the time point index of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Show state (inCompareCSOGroupShowState)¶

name: inCompareCSOGroupShowState, type: Bool, default: TRUE¶: If true, the show state of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Voxelize state (inCompareCSOGroupVoxelizeState)¶

name: inCompareCSOGroupVoxelizeState, type: Bool, default: TRUE¶: If true, the voxelize state of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Editable state (inCompareCSOGroupEditableState)¶

name: inCompareCSOGroupEditableState, type: Bool, default: TRUE¶: If true, the editable state of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Path point style (inCompareCSOGroupPathPointStyle)¶

name: inCompareCSOGroupPathPointStyle, type: Bool, default: TRUE¶: If true, the path point style of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Path point width (inCompareCSOGroupPathPointWidth)¶

name: inCompareCSOGroupPathPointWidth, type: Bool, default: TRUE¶: If true, the path point width of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Path point color (inCompareCSOGroupPathPointColor)¶

name: inCompareCSOGroupPathPointColor, type: Bool, default: TRUE¶: If true, the path point color of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Path point alpha (inCompareCSOGroupPathPointAlpha)¶

name: inCompareCSOGroupPathPointAlpha, type: Bool, default: TRUE¶: If true, the path point alpha of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Seed point style (inCompareCSOGroupSeedPointStyle)¶

name: inCompareCSOGroupSeedPointStyle, type: Bool, default: TRUE¶: If true, the seed point style of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Seed point size (inCompareCSOGroupSeedPointSize)¶

name: inCompareCSOGroupSeedPointSize, type: Bool, default: TRUE¶: If true, the seed point size of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Seed point color (inCompareCSOGroupSeedPointColor)¶

name: inCompareCSOGroupSeedPointColor, type: Bool, default: TRUE¶: If true, the seed point color of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Seed point alpha (inCompareCSOGroupSeedPointAlpha)¶

name: inCompareCSOGroupSeedPointAlpha, type: Bool, default: TRUE¶: If true, the seed point alpha of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Voxel write mode (inCompareCSOGroupVoxelWriteMode)¶

name: inCompareCSOGroupVoxelWriteMode, type: Bool, default: TRUE¶: If true, the voxel write mode of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Voxel write value (inCompareCSOGroupVoxelWriteValue)¶

name: inCompareCSOGroupVoxelWriteValue, type: Bool, default: TRUE¶: If true, the voxel write value of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use time point index¶

name: inCompareCSOGroupUseTimePointIndex, type: Bool, default: TRUE¶: If true, the use time point index of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use show state¶

name: inCompareCSOGroupUseShowState, type: Bool, default: TRUE¶: If true, the use show state of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use voxelize state¶

name: inCompareCSOGroupUseVoxelizeState, type: Bool, default: TRUE¶: If true, the use voxelize state of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use editable state¶

name: inCompareCSOGroupUseEditableState, type: Bool, default: TRUE¶: If true, the use editable state of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use path point style¶

name: inCompareCSOGroupUsePathPointStyle, type: Bool, default: TRUE¶: If true, the use path point style of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use path point width¶

name: inCompareCSOGroupUsePathPointWidth, type: Bool, default: TRUE¶: If true, the use path point width of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use path point color¶

name: inCompareCSOGroupUsePathPointColor, type: Bool, default: TRUE¶: If true, the use path point color of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use path point alpha¶

name: inCompareCSOGroupUsePathPointAlpha, type: Bool, default: TRUE¶: If true, the use path point alpha of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use seed point style¶

name: inCompareCSOGroupUseSeedPointStyle, type: Bool, default: TRUE¶: If true, the use seed point style of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use seed point size¶

name: inCompareCSOGroupUseSeedPointSize, type: Bool, default: TRUE¶: If true, the use seed point size of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use seed point color¶

name: inCompareCSOGroupUseSeedPointColor, type: Bool, default: TRUE¶: If true, the use seed point color of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use seed point alpha¶

name: inCompareCSOGroupUseSeedPointAlpha, type: Bool, default: TRUE¶: If true, the use seed point alpha of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use voxel write mode¶

name: inCompareCSOGroupUseVoxelWriteMode, type: Bool, default: TRUE¶: If true, the use voxel write mode of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Use voxel write value¶

name: inCompareCSOGroupUseVoxelWriteValue, type: Bool, default: TRUE¶: If true, the use voxel write value of corresponding CSOGroups must be equal for CSOLists are equal to be true.

Epsilon for float comparisons¶

name: inEpsilon, type: Double, default: 0¶: The epsilon used for float comparisons, e.g. for seed or path point positions.

CSOLists are equal¶

name: outAreEqual, type: Bool, persistent: no¶: Indicates whether the input CSOLists are equal according to the selected criteria.

First difference¶

name: outFirstDifference, type: String, persistent: no¶: The first criterion and the index or id of the first CSO or CSOGroup pair for which a difference was found.

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.