\(\renewcommand\AA{\unicode{x212B}}\)

FindClusterFaces v1

Summary

Find faces for clusters in a cluster image.

See Also

IntegratePeaksUsingClusters

Properties

Name	Direction	Type	Default	Description
InputWorkspace	Input	IMDHistoWorkspace	Mandatory	An input image workspace consisting of cluster ids.
FilterWorkspace	Input	PeaksWorkspace		Optional filtering peaks workspace. Used to restrict face finding to clusters in image which correspond to peaks in the workspace.
LimitRows	Input	boolean	True	Limit the report output to a maximum number of rows
MaximumRows	Input	number	100000	The number of neighbours to utilise. Defaults to 100000.
OutputWorkspace	Output	TableWorkspace	Mandatory	An output table workspace containing cluster face information.
TruncatedOutput	Output	boolean		Indicates that the output results were truncated if True

Description

Algorithm takes an image workspace (a.k.a IMDHistoWorkspace) and determines the faces of the clusters contained within the image. The image is expected to be a labeled image workspace outputted from IntegratePeaksUsingClusters v1. The algorithm generates a TableWorkspace as output, which contains all the cluster edge faces required to draw the outer edge of all clusters within the workspace.

You may optionally provide a FilterWorkspace, which is a PeaksWorkspace. If provided, the Peak locations are projected onto the InputWorkspace and the center locations are used to restrict the output to only include the clusters that are the union between the peak locations and the image clusters.

If LimitRows is set to True (default), then you may specify a maximum number of rows to report. If the algorithm generates more rows that the MaximumRows that you set, then it will emit a warning, and also, set the TruncatedOutput output property to false.

Categories: AlgorithmIndex | Crystal\Integration

Source

C++ header: FindClusterFaces.h

C++ source: FindClusterFaces.cpp