mitk::LabelSetImageHelper Namespace Reference

Typedefs
using	GroupIDToLabelValueMapType = std::map< mitk::MultiLabelSegmentation::GroupIndexType, MultiLabelSegmentation::LabelValueVectorType >
using	LabelClassNameToLabelValueMapType = std::map< std::string, MultiLabelSegmentation::LabelValueVectorType >
using	SourceToTargetGroupIDToLabelValueMappingMapType = std::map< MultiLabelSegmentation::GroupIndexType, std::map< MultiLabelSegmentation::GroupIndexType, LabelValueMappingVector > >

Functions
MITKMULTILABEL_EXPORT mitk::DataNode::Pointer	CreateEmptySegmentationNode (const std::string &segmentationName=std::string())
	This function creates and returns a new empty segmentation data node. More...
MITKMULTILABEL_EXPORT mitk::DataNode::Pointer	CreateNewSegmentationNode (const DataNode *referenceNode, const Image *initialSegmentationImage=nullptr, const std::string &segmentationName=std::string(), const DataStorage *dataStorage=nullptr)
	This function creates and returns a new data node with a new empty segmentation data structure. The segmentation node is named according to the given reference data node, otherwise a name is passed explicitly. Some properties are set to ensure a proper setup segmentation and node (e.g. link the segmentation node with its parent node). More...
MITKMULTILABEL_EXPORT Label::Pointer	CreateNewLabel (const MultiLabelSegmentation *labelSetImage, const std::string &namePrefix="Label", bool hideIDIfUnique=false)
	This function creates and returns a new label. The label is automatically assigned an unused generic label name, depending on existing label names in all label sets of the given label set image. The color of the label is selected from the MULTILABEL lookup table, following the same rules of the naming to likely chose a unique color. More...
MITKMULTILABEL_EXPORT GroupIDToLabelValueMapType	SplitLabelValuesByGroup (const MultiLabelSegmentation *labelSetImage, const MultiLabelSegmentation::LabelValueVectorType &labelValues)
MITKMULTILABEL_EXPORT LabelClassNameToLabelValueMapType	SplitLabelValuesByClassName (const MultiLabelSegmentation *labelSetImage, MultiLabelSegmentation::GroupIndexType groupID)
MITKMULTILABEL_EXPORT LabelClassNameToLabelValueMapType	SplitLabelValuesByClassName (const MultiLabelSegmentation *labelSetImage, MultiLabelSegmentation::GroupIndexType groupID, const MultiLabelSegmentation::LabelValueVectorType &labelValues)
MITKMULTILABEL_EXPORT SourceToTargetGroupIDToLabelValueMappingMapType	SplitLabelValueMappingBySourceAndTargetGroup (const MultiLabelSegmentation *sourceSeg, const MultiLabelSegmentation *targetSeg, const LabelValueMappingVector &labelMapping)
MITKMULTILABEL_EXPORT std::string	CreateDisplayGroupName (const MultiLabelSegmentation *labelSetImage, MultiLabelSegmentation::GroupIndexType groupID)
MITKMULTILABEL_EXPORT std::string	CreateDisplayLabelName (const MultiLabelSegmentation *labelSetImage, const Label *label)
MITKMULTILABEL_EXPORT std::string	CreateHTMLLabelName (const Label *label, const MultiLabelSegmentation *segmentation=nullptr)

Typedef Documentation

GroupIDToLabelValueMapType

using mitk::LabelSetImageHelper::GroupIDToLabelValueMapType = typedef std::map<mitk::MultiLabelSegmentation::GroupIndexType, MultiLabelSegmentation::LabelValueVectorType>

Definition at line 71 of file mitkLabelSetImageHelper.h.

LabelClassNameToLabelValueMapType

using mitk::LabelSetImageHelper::LabelClassNameToLabelValueMapType = typedef std::map<std::string, MultiLabelSegmentation::LabelValueVectorType>

Definition at line 74 of file mitkLabelSetImageHelper.h.

SourceToTargetGroupIDToLabelValueMappingMapType

using mitk::LabelSetImageHelper::SourceToTargetGroupIDToLabelValueMappingMapType = typedef std::map<MultiLabelSegmentation::GroupIndexType, std::map<MultiLabelSegmentation::GroupIndexType, LabelValueMappingVector> >

Type that represents the mapping from a source group id to relevant target group ids (first map) and then to mapping to respective label value mapping vectors for each target group id (inner/second map).

Definition at line 80 of file mitkLabelSetImageHelper.h.

Function Documentation

CreateDisplayGroupName()

MITKMULTILABEL_EXPORT std::string mitk::LabelSetImageHelper::CreateDisplayGroupName	(	const MultiLabelSegmentation *	labelSetImage,
		MultiLabelSegmentation::GroupIndexType	groupID
	)

CreateDisplayLabelName()

MITKMULTILABEL_EXPORT std::string mitk::LabelSetImageHelper::CreateDisplayLabelName	(	const MultiLabelSegmentation *	labelSetImage,
		const Label *	label
	)

Helper that creates the human readable display name for a label. If label segmentation image is not null, the function will also check if the label is the only label with its name in the segmentation. If not, the tracking ID will be added in square brackets to the display name.

CreateEmptySegmentationNode()

MITKMULTILABEL_EXPORT mitk::DataNode::Pointer mitk::LabelSetImageHelper::CreateEmptySegmentationNode

(

const std::string &

segmentationName = std::string()

)

This function creates and returns a new empty segmentation data node.

Remarks

The data is not set. Set it manually to have a properly setup node.

Parameters

segmentationName

A name for the new segmentation node.

Returns

The new segmentation node as a data node pointer.

CreateHTMLLabelName()

MITKMULTILABEL_EXPORT std::string mitk::LabelSetImageHelper::CreateHTMLLabelName	(	const Label *	label,
		const MultiLabelSegmentation *	segmentation = nullptr
	)

Helper that creates a HTML string that contains the display name and a square glyph with the color of the label.

CreateNewLabel()

MITKMULTILABEL_EXPORT Label::Pointer mitk::LabelSetImageHelper::CreateNewLabel	(	const MultiLabelSegmentation *	labelSetImage,
		const std::string &	namePrefix = "Label",
		bool	hideIDIfUnique = false
	)

This function creates and returns a new label. The label is automatically assigned an unused generic label name, depending on existing label names in all label sets of the given label set image. The color of the label is selected from the MULTILABEL lookup table, following the same rules of the naming to likely chose a unique color.

Parameters

labelSetImage	The label set image that the new label is added to
namePrefix	The prefix of the label name that is prepended by a sequential number
hideIDIfUnique	Indicates if the ID suffix should be added if the label name prefix would be already unique. true: only add if not unique; false: add always.

Returns

The new label.

CreateNewSegmentationNode()

MITKMULTILABEL_EXPORT mitk::DataNode::Pointer mitk::LabelSetImageHelper::CreateNewSegmentationNode	(	const DataNode *	referenceNode,
		const Image *	initialSegmentationImage = nullptr,
		const std::string &	segmentationName = std::string(),
		const DataStorage *	dataStorage = nullptr
	)

This function creates and returns a new data node with a new empty segmentation data structure. The segmentation node is named according to the given reference data node, otherwise a name is passed explicitly. Some properties are set to ensure a proper setup segmentation and node (e.g. link the segmentation node with its parent node).

Parameters

referenceNode	The reference node from which the name of the new segmentation node is derived. If passed pointer is null, the name "unknown" will be used.
initialSegmentationImage	The segmentation image that is used to initialize the label set image.
segmentationName	An optional name for the new segmentation node.
dataStorage	The data storage of the reference node (if given, used to generate a unique node name).

Returns

The new segmentation node as a data node pointer.

SplitLabelValueMappingBySourceAndTargetGroup()

MITKMULTILABEL_EXPORT SourceToTargetGroupIDToLabelValueMappingMapType mitk::LabelSetImageHelper::SplitLabelValueMappingBySourceAndTargetGroup	(	const MultiLabelSegmentation *	sourceSeg,
		const MultiLabelSegmentation *	targetSeg,
		const LabelValueMappingVector &	labelMapping
	)

Helper function that takes a label mapping vector and deduces which group ids are needed in the source segmentation and target segmentation to conduct a mapping of pixel values. The result is e.g. used by TransferLabelContent.

SplitLabelValuesByClassName() [1/2]

MITKMULTILABEL_EXPORT LabelClassNameToLabelValueMapType mitk::LabelSetImageHelper::SplitLabelValuesByClassName	(	const MultiLabelSegmentation *	labelSetImage,
		MultiLabelSegmentation::GroupIndexType	groupID
	)

SplitLabelValuesByClassName() [2/2]

MITKMULTILABEL_EXPORT LabelClassNameToLabelValueMapType mitk::LabelSetImageHelper::SplitLabelValuesByClassName	(	const MultiLabelSegmentation *	labelSetImage,
		MultiLabelSegmentation::GroupIndexType	groupID,
		const MultiLabelSegmentation::LabelValueVectorType &	labelValues
	)

SplitLabelValuesByGroup()

MITKMULTILABEL_EXPORT GroupIDToLabelValueMapType mitk::LabelSetImageHelper::SplitLabelValuesByGroup	(	const MultiLabelSegmentation *	labelSetImage,
		const MultiLabelSegmentation::LabelValueVectorType &	labelValues
	)