The MultiLabelIOHelper is a static helper class that supports serialization of mitk::MultiLabelSegmentation. More...

#include <mitkMultiLabelIOHelper.h>

Classes
struct	LabelGroupMetaData
	Structure to hold label group metadata including labels and group properties. More...

Public Types
using	GroupFileNameCallback = std::function< std::string(const mitk::MultiLabelSegmentation *, mitk::MultiLabelSegmentation::GroupIndexType)>

using	LabelFileNameCallback = std::function< std::string(const mitk::MultiLabelSegmentation *, mitk::MultiLabelSegmentation::LabelValueType)>

using	LabelFileValueCallback = std::function< mitk::MultiLabelSegmentation::LabelValueType(const mitk::MultiLabelSegmentation *, mitk::MultiLabelSegmentation::LabelValueType)>

Static Public Member Functions
static bool	SaveMultiLabelSegmentationPreset (const std::string &presetFilename, const mitk::MultiLabelSegmentation *inputSegmentation)
	Saves the mitk::LabelSet configuration of inputSegmentation to presetFilename. The preset is stored as "*.multilabel.json". More...

static bool	LoadMultiLabelSegmentationPreset (const std::string &presetFilename, mitk::MultiLabelSegmentation *inputSegmentation)
	Loads an existing preset for a mitk::MultiLabelSegmentation from presetFilename and applies it to inputSegmentation This functions supports the new format (.multilabel.json) and the legacy format (*.lpset) More...

static itk::SmartPointer< mitk::Label >	LoadLabelFromXMLDocument (const tinyxml2::XMLElement *labelElem)
	Creates a mitk::Label from an XML element. More...

static tinyxml2::XMLElement *	GetLabelAsXMLElement (tinyxml2::XMLDocument &doc, const Label *label)
	Creates an XML element from a mitk::Label. More...

static tinyxml2::XMLElement *	PropertyToXMLElement (tinyxml2::XMLDocument &doc, const std::string &key, const BaseProperty *property)
	Since a mitk::Label is basically a mitk::PropertyList this function converts the label's properties into XML. More...

static bool	PropertyFromXMLElement (std::string &key, itk::SmartPointer< mitk::BaseProperty > &prop, const tinyxml2::XMLElement *elem)
	Since a mitk::Label is basically a mitk::PropertyList this function converts an XML element into a property. More...

static int	GetIntByKey (const itk::MetaDataDictionary &dic, const std::string &key)

static std::string	GetStringByKey (const itk::MetaDataDictionary &dic, const std::string &key)

static nlohmann::json	SerializeMultLabelGroupsToJSON (const mitk::MultiLabelSegmentation *inputSegmentation, GroupFileNameCallback groupFileNameCallback=nullptr, LabelFileNameCallback labelFileNameCallback=nullptr, LabelFileValueCallback labelFileValueCallback=nullptr)
	Serialize meta data all groups of the multilabel segmentation to JSON format (v2) More...

static std::vector< LabelGroupMetaData >	DeserializeMultiLabelGroupsFromJSON (const nlohmann::json &listOfLabelGroups)
	Deserialize meta data of multilabel groups from JSON format (v2) More...

static nlohmann::json	SerializeLabelToJSON (const Label *label)
	Serialize a single label to JSON. More...

static mitk::Label::Pointer	DeserializeLabelFromJSON (const nlohmann::json &labelJson)
	Deserialize a single label from JSON. More...

static nlohmann::json	SerializeLabelPropertyToJSON (const BaseProperty *property)
	Serialize the property of a label to JSON. More...

template<typename TValueType >
static bool	GetValueFromJson (const nlohmann::json &labelJson, const std::string &key, TValueType &value)

static void	RemoveMetaPropertiesFromLabel (Label *label)
	Remove all meta properties from a label instance. Meta properties (indicated by a preceding "_" in the property name) are used to steer code logic e.g. in the case of label loading or suggestion handling. They are not to be used in concrete label instances. This method removes all meta properties form a label. More...

static LabelVector	CloneLabelsWithoutMetaProperties (const LabelVector &labels)
	Remove all meta properties from all label clones of the passed vector. Meta properties (indicated by a preceding "_" in the property name) are used to steer code logic e.g. in the case of label loading or suggestion handling. They are not to be used in concrete label instances. This method clones all passed labels and removes all meta properties form the clones. More...

Detailed Description

The MultiLabelIOHelper is a static helper class that supports serialization of mitk::MultiLabelSegmentation.

This class provides static functions for converting mitk::Label into XML and also allows the serialization of mitk::LabelSet as presets

Definition at line 50 of file mitkMultiLabelIOHelper.h.

Member Typedef Documentation

◆ GroupFileNameCallback

using mitk::MultiLabelIOHelper::GroupFileNameCallback = std::function<std::string(const mitk::MultiLabelSegmentation*, mitk::MultiLabelSegmentation::GroupIndexType)>

Definition at line 130 of file mitkMultiLabelIOHelper.h.

◆ LabelFileNameCallback

using mitk::MultiLabelIOHelper::LabelFileNameCallback = std::function<std::string(const mitk::MultiLabelSegmentation*, mitk::MultiLabelSegmentation::LabelValueType)>

Definition at line 131 of file mitkMultiLabelIOHelper.h.

◆ LabelFileValueCallback

using mitk::MultiLabelIOHelper::LabelFileValueCallback = std::function<mitk::MultiLabelSegmentation::LabelValueType(const mitk::MultiLabelSegmentation*, mitk::MultiLabelSegmentation::LabelValueType)>

Definition at line 132 of file mitkMultiLabelIOHelper.h.

Member Function Documentation

◆ CloneLabelsWithoutMetaProperties()

static LabelVector mitk::MultiLabelIOHelper::CloneLabelsWithoutMetaProperties ( const LabelVector & labels )

static

Remove all meta properties from all label clones of the passed vector. Meta properties (indicated by a preceding "_" in the property name) are used to steer code logic e.g. in the case of label loading or suggestion handling. They are not to be used in concrete label instances. This method clones all passed labels and removes all meta properties form the clones.

Parameters

labels Vector with all labels that should be cloned and cleaned.

◆ DeserializeLabelFromJSON()

static mitk::Label::Pointer mitk::MultiLabelIOHelper::DeserializeLabelFromJSON ( const nlohmann::json & labelJson )

static

Deserialize a single label from JSON.

Parameters

labelJson JSON representation of the label

Returns: pointer to the deserialized label

◆ DeserializeMultiLabelGroupsFromJSON()

static std::vector<LabelGroupMetaData> mitk::MultiLabelIOHelper::DeserializeMultiLabelGroupsFromJSON ( const nlohmann::json & listOfLabelGroups )

static

Deserialize meta data of multilabel groups from JSON format (v2)

Parameters

listOfLabelGroups JSON representation of label groups

Returns: vector of label group metadata

◆ GetIntByKey()

static int mitk::MultiLabelIOHelper::GetIntByKey	(	const itk::MetaDataDictionary &	dic,
		const std::string &	key
	)

static

Helper that extracts the value of a key in a meta dictionary as int. If the key does not exist 0 is returned.

◆ GetLabelAsXMLElement()

static tinyxml2::XMLElement* mitk::MultiLabelIOHelper::GetLabelAsXMLElement	(	tinyxml2::XMLDocument &	doc,
		const Label *	label
	)

static

Creates an XML element from a mitk::Label.

Parameters

doc
label	the mitk::Label from which the xml element will be created

Returns: the created XML element

◆ GetStringByKey()

static std::string mitk::MultiLabelIOHelper::GetStringByKey	(	const itk::MetaDataDictionary &	dic,
		const std::string &	key
	)

static

Helper that extracts the value of a key in a meta dictionary as string. If the key does not exist an empty string is returned.

◆ GetValueFromJson()

template<typename TValueType >

static bool mitk::MultiLabelIOHelper::GetValueFromJson	(	const nlohmann::json &	labelJson,
		const std::string &	key,
		TValueType &	value
	)

inlinestatic

Definition at line 179 of file mitkMultiLabelIOHelper.h.

References MITK_ERROR.

◆ LoadLabelFromXMLDocument()

static itk::SmartPointer<mitk::Label> mitk::MultiLabelIOHelper::LoadLabelFromXMLDocument ( const tinyxml2::XMLElement * labelElem )

static

Creates a mitk::Label from an XML element.

Parameters

labelElem the xml element from which a mitk::Label will be created

Returns: the created mitk::Label

◆ LoadMultiLabelSegmentationPreset()

static bool mitk::MultiLabelIOHelper::LoadMultiLabelSegmentationPreset	(	const std::string &	presetFilename,
		mitk::MultiLabelSegmentation *	inputSegmentation
	)

static

Loads an existing preset for a mitk::MultiLabelSegmentation from presetFilename and applies it to inputSegmentation This functions supports the new format (.multilabel.json) and the legacy format (*.lpset)

Parameters

presetFilename	the filename of the preset including the file system path
inputSegmentation	the image to which the loaded preset will be applied

Returns: true if the deserilization was successful and false otherwise

◆ PropertyFromXMLElement()

static bool mitk::MultiLabelIOHelper::PropertyFromXMLElement	(	std::string &	key,
		itk::SmartPointer< mitk::BaseProperty > &	prop,
		const tinyxml2::XMLElement *	elem
	)

static

Since a mitk::Label is basically a mitk::PropertyList this function converts an XML element into a property.

Parameters

key	the property's key
prop	the mitk::BaseProperty that will be created
elem	the XML elem from which the property will be created

Returns: true if the conversion was successful and false otherwise

◆ PropertyToXMLElement()

static tinyxml2::XMLElement* mitk::MultiLabelIOHelper::PropertyToXMLElement	(	tinyxml2::XMLDocument &	doc,
		const std::string &	key,
		const BaseProperty *	property
	)

static

Since a mitk::Label is basically a mitk::PropertyList this function converts the label's properties into XML.

Parameters

doc
key	the property's key which will be used in the XML element
property	the mitk::BaseProperty that should be converted

Returns: the created XML element

◆ RemoveMetaPropertiesFromLabel()

static void mitk::MultiLabelIOHelper::RemoveMetaPropertiesFromLabel ( Label * label )

static

Remove all meta properties from a label instance. Meta properties (indicated by a preceding "_" in the property name) are used to steer code logic e.g. in the case of label loading or suggestion handling. They are not to be used in concrete label instances. This method removes all meta properties form a label.

Parameters

label Pointer to the label instance that should be stripped of its labels.

◆ SaveMultiLabelSegmentationPreset()

static bool mitk::MultiLabelIOHelper::SaveMultiLabelSegmentationPreset	(	const std::string &	presetFilename,
		const mitk::MultiLabelSegmentation *	inputSegmentation
	)

static

Saves the mitk::LabelSet configuration of inputSegmentation to presetFilename. The preset is stored as "*.multilabel.json".

Parameters

presetFilename	the filename including the file system path
inputSegmentation	the input image from which the preset should be generated

Returns: true if the serialization was successful and false otherwise

◆ SerializeLabelPropertyToJSON()

static nlohmann::json mitk::MultiLabelIOHelper::SerializeLabelPropertyToJSON ( const BaseProperty * property )

static

Serialize the property of a label to JSON.

Parameters

property Pointer to the property that should be serialized

Returns: JSON representation of the property

◆ SerializeLabelToJSON()

static nlohmann::json mitk::MultiLabelIOHelper::SerializeLabelToJSON ( const Label * label )

static

Serialize a single label to JSON.

Parameters

label the label to serialize

Returns: JSON representation of the label

◆ SerializeMultLabelGroupsToJSON()

static nlohmann::json mitk::MultiLabelIOHelper::SerializeMultLabelGroupsToJSON	(	const mitk::MultiLabelSegmentation *	inputSegmentation,
		GroupFileNameCallback	groupFileNameCallback = `nullptr`,
		LabelFileNameCallback	labelFileNameCallback = `nullptr`,
		LabelFileValueCallback	labelFileValueCallback = `nullptr`
	)

static

Serialize meta data all groups of the multilabel segmentation to JSON format (v2)

Parameters

inputSegmentation	the multilabel segmentation to serialize
groupFileNameCallback	Optional call back function. If provided the property "_file" on group level based on the returned string will be set.
labelFileNameCallback	Optional call back function. If provided the property "_file" per label based on the returned string will be set.
labelFileValueCallback	Optional call back function. If provided the property "_file_value" per label will be set according to the returned value.

Returns: JSON representation of the groups

The documentation for this class was generated from the following file:

mitkMultiLabelIOHelper.h

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ GroupFileNameCallback

◆ LabelFileNameCallback

◆ LabelFileValueCallback

Member Function Documentation

◆ CloneLabelsWithoutMetaProperties()

◆ DeserializeLabelFromJSON()

◆ DeserializeMultiLabelGroupsFromJSON()

◆ GetIntByKey()

◆ GetLabelAsXMLElement()

◆ GetStringByKey()

◆ GetValueFromJson()

◆ LoadLabelFromXMLDocument()

◆ LoadMultiLabelSegmentationPreset()

◆ PropertyFromXMLElement()

◆ PropertyToXMLElement()

◆ RemoveMetaPropertiesFromLabel()

◆ SaveMultiLabelSegmentationPreset()

◆ SerializeLabelPropertyToJSON()

◆ SerializeLabelToJSON()

◆ SerializeMultLabelGroupsToJSON()