Relation rule for referencing an image as the source of a destination entity. More...

#include <mitkSourceImageRelationRule.h>

Inheritance diagram for mitk::SourceImageRelationRule:

[legend]

Collaboration diagram for mitk::SourceImageRelationRule:

Public Types
using	RuleIDType = PropertyRelationRuleBase::RuleIDType

using	RelationUIDType = PropertyRelationRuleBase::RelationUIDType

using	RelationUIDVectorType = PropertyRelationRuleBase::RelationUIDVectorType

Public Types inherited from mitk::PropertyRelationRuleBase
enum class	RelationType { None , Data , ID , Complete }

using	RuleIDType = std::string

using	RelationUIDType = Identifiable::UIDType

using	RelationUIDVectorType = std::vector< RelationUIDType >

using	RelationVectorType = std::vector< RelationType >

using	InstanceIDType = std::string

Public Member Functions
	mitkClassMacro (SourceImageRelationRule, PropertyRelationRuleBase)

	mitkNewMacro1Param (Self, const RuleIDType &)

	mitkNewMacro2Param (Self, const RuleIDType &, const std::string &)

	mitkNewMacro4Param (Self, const RuleIDType &, const std::string &, const std::string &, const std::string &)

RuleIDType	GetRuleID () const override
	Return an ID string that identifies the rule class. More...

bool	IsAbstract () const override
	Return whether this rule is abstract (i.e. has no purpose tag). More...

std::string	GetDisplayName () const override
	Return a human-readable string describing the rule. Does not need to be unique. More...

std::string	GetSourceRoleName () const override
	Return a human-readable string describing the role of a source in the context of this rule. More...

std::string	GetDestinationRoleName () const override
	Return a human-readable string describing the role of a destination in the context of this rule. More...

bool	IsDestinationCandidate (const IPropertyProvider *owner) const override
	Check whether the given property provider qualifies as a destination for this rule. More...

RelationUIDType	Connect (Image source, const Image destination) const
	Connect two images using this relation rule. More...

Public Member Functions inherited from mitk::PropertyRelationRuleBase
	mitkClassMacroItkParent (PropertyRelationRuleBase, itk::Object)

Pointer	Clone () const

	itkCreateAnotherMacro (Self)

virtual bool	IsSourceCandidate (const IPropertyProvider *owner) const

bool	IsSource (const IPropertyProvider *owner) const

RelationVectorType	GetRelationTypes (const IPropertyProvider source, const IPropertyProvider destination) const

bool	HasRelation (const IPropertyProvider source, const IPropertyProvider destination, RelationType requiredRelation=RelationType::None) const

RelationUIDVectorType	GetExistingRelations (const IPropertyProvider *source, RelationType layer=RelationType::None) const

RelationUIDVectorType	GetRelationUIDs (const IPropertyProvider source, const IPropertyProvider destination) const

RelationUIDType	GetRelationUID (const IPropertyProvider source, const IPropertyProvider destination) const

NodePredicateBase::ConstPointer	GetSourceCandidateIndicator () const

NodePredicateBase::ConstPointer	GetDestinationCandidateIndicator () const

NodePredicateBase::ConstPointer	GetConnectedSourcesDetector () const

NodePredicateBase::ConstPointer	GetSourcesDetector (const IPropertyProvider *destination, RelationType exclusiveRelation=RelationType::None) const

NodePredicateBase::ConstPointer	GetDestinationsDetector (const IPropertyProvider *source, RelationType exclusiveRelation=RelationType::None) const

NodePredicateBase::ConstPointer	GetDestinationDetector (const IPropertyProvider *source, RelationUIDType relationUID) const

void	Disconnect (IPropertyOwner source, const IPropertyProvider destination, RelationType layer=RelationType::Complete) const

void	Disconnect (IPropertyOwner *source, RelationUIDType relationUID, RelationType layer=RelationType::Complete) const

std::vector< PropertyKeyPath >	GetRelationPropertyPaths (const IPropertyProvider *source, RelationUIDType relationUID, RelationType layer=RelationType::Data) const
	Get all property key paths relevant for a given relation. More...

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from mitk::PropertyRelationRuleBase
static PropertyKeyPath	GetRootKeyPath ()

static PropertyKeyPath	GetRIIPropertyKeyPath (const std::string propName, const InstanceIDType &instanceID)

static PropertyKeyPath	GetRIIRelationUIDPropertyKeyPath (const InstanceIDType &instanceID="")

static PropertyKeyPath	GetRIIRuleIDPropertyKeyPath (const InstanceIDType &instanceID="")

static PropertyKeyPath	GetRIIDestinationUIDPropertyKeyPath (const InstanceIDType &instanceID="")

Protected Types
using	InstanceIDType = PropertyRelationRuleBase::InstanceIDType

using	InstanceIDVectorType = PropertyRelationRuleBase::InstanceIDVectorType

using	DataRelationUIDVectorType = PropertyRelationRuleBase::DataRelationUIDVectorType

Protected Types inherited from mitk::PropertyRelationRuleBase
using	InstanceIDVectorType = std::vector< InstanceIDType >

using	DataRelationUIDVectorType = std::vector< std::pair< RelationUIDType, RuleIDType > >

Protected Member Functions
	SourceImageRelationRule ()
	Default constructor. Creates an abstract rule with no purpose tag. More...

	SourceImageRelationRule (const RuleIDType &purposeTag)
	Construct a rule with a specific purpose tag. More...

	SourceImageRelationRule (const RuleIDType &purposeTag, const std::string &displayName)
	Construct a rule with a purpose tag and display name. More...

	SourceImageRelationRule (const RuleIDType &purposeTag, const std::string &displayName, const std::string &sourceRole, const std::string &destinationRole)
	Construct a rule with all customizable parameters. More...

	~SourceImageRelationRule () override=default

std::vector< std::pair< size_t, std::string > >	GetReferenceSequenceIndices (const IPropertyProvider source, const IPropertyProvider destination=nullptr, InstanceIDVectorType ignoreInstances={}) const
	Get reference sequence indices from the DICOM Source Image Sequence (0008,2112). More...

virtual DataRelationUIDVectorType	GetRelationUIDs_DataLayer (const IPropertyProvider source, const IPropertyProvider destination, const InstanceIDVectorType &instances_IDLayer) const override

void	Connect_datalayer (IPropertyOwner source, const IPropertyProvider destination, const InstanceIDType &instanceID) const override

void	Disconnect_datalayer (IPropertyOwner *source, const RelationUIDType &relationUID) const override

bool	IsSupportedRuleID (const RuleIDType &ruleID) const override

	SourceImageRelationRule (const SourceImageRelationRule &other)

	mitkCloneMacro (Self)

PropertyKeyPath::ItemSelectionIndex	CreateNewSourceImageSequenceItem (IPropertyOwner *source) const
	Prepare a new reference to an image on the data layer. More...

std::string	GenerateRuleID (const std::string &purpose) const
	Generate a rule ID string from the given purpose tag. More...

Protected Member Functions inherited from mitk::PropertyRelationRuleBase
	PropertyRelationRuleBase ()=default

	PropertyRelationRuleBase (const PropertyRelationRuleBase &)

	~PropertyRelationRuleBase () override=default

InstanceIDVectorType	GetInstanceID_IDLayer (const IPropertyProvider source, const IPropertyProvider destination) const

RelationUIDType	GetRelationUIDByInstanceID (const IPropertyProvider *source, const InstanceIDType &instanceID) const

InstanceIDType	GetInstanceIDByRelationUID (const IPropertyProvider *source, const RelationUIDType &relationUID) const

RelationUIDType	Connect (IPropertyOwner source, const IPropertyProvider destination) const

std::string	GetRIIPropertyRegEx (const std::string propName="", const InstanceIDType &instanceID="") const

RuleIDType	GetRuleIDByInstanceID (const IPropertyProvider *source, const InstanceIDType &instanceID) const

std::string	GetDestinationUIDByInstanceID (const IPropertyProvider *source, const InstanceIDType &instanceID) const

const Identifiable *	CastProviderAsIdentifiable (const mitk::IPropertyProvider *provider) const

Additional Inherited Members
Static Protected Member Functions inherited from mitk::PropertyRelationRuleBase
static InstanceIDType	NULL_INSTANCE_ID ()

static InstanceIDType	GetInstanceIDByPropertyName (const std::string propName)

static std::vector< std::string >	GetPropertyKeys (const IPropertyProvider *owner)

Detailed Description

Relation rule for referencing an image as the source of a destination entity.

This rule class can be used for relations that reference an image as source for a destination entity (e.g. an image that is used to generate the relation source).

The ID-layer is supported like for GenericIDRelations, so it can be used for all ID-based relations between PropertyProviders that also implement the Identifiable interface.

In addition, the rule uses the data-layer to deduce/define relations. For this layer it uses properties compliant to DICOM. Thus (1) the information is stored in a DICOM Source Image Sequence item (0x0008,0x2112) and (2) the destination must have properties DICOM SOP Instance UID (0x0008,0x0018) and DICOM SOP Class UID (0x0008,0x0016). If the destination does not have these properties, no connection can be made on the data-layer.

Remarks: PropertyRelationRules and DICOM use the term "source" differently. The DICOM source (image) equals the PropertyRelationRule destination. This is due to an inverted relation direction. In the context of this rule interface, derived data is the source and points to the original image it derives from. In DICOM, this referenced original image would be called the source image (as the name of this class suggests).

In order to use this class for different relation types (DICOM would call them purposes), the purposeTag is used. It must be specified when creating a rule instance. The purposeTag will be used as suffix for the rule ID and therefore allows creating specific and distinguishable rule instances based on this class.

One may also specify the display name and the role names of the instance. If not specified, the default values are used (display name: "<purposeTag> relation", source role name: "derived data", destination role name: "source image").

See also: PropertyRelationRuleBase; GenericIDRelationRule

Definition at line 53 of file mitkSourceImageRelationRule.h.

Member Typedef Documentation

◆ DataRelationUIDVectorType

using mitk::SourceImageRelationRule::DataRelationUIDVectorType = PropertyRelationRuleBase::DataRelationUIDVectorType

protected

Definition at line 134 of file mitkSourceImageRelationRule.h.

◆ InstanceIDType

using mitk::SourceImageRelationRule::InstanceIDType = PropertyRelationRuleBase::InstanceIDType

protected

Definition at line 122 of file mitkSourceImageRelationRule.h.

◆ InstanceIDVectorType

using mitk::SourceImageRelationRule::InstanceIDVectorType = PropertyRelationRuleBase::InstanceIDVectorType

protected

Definition at line 123 of file mitkSourceImageRelationRule.h.

◆ RelationUIDType

using mitk::SourceImageRelationRule::RelationUIDType = PropertyRelationRuleBase::RelationUIDType

Definition at line 63 of file mitkSourceImageRelationRule.h.

◆ RelationUIDVectorType

using mitk::SourceImageRelationRule::RelationUIDVectorType = PropertyRelationRuleBase::RelationUIDVectorType

Definition at line 64 of file mitkSourceImageRelationRule.h.

◆ RuleIDType

using mitk::SourceImageRelationRule::RuleIDType = PropertyRelationRuleBase::RuleIDType

Definition at line 62 of file mitkSourceImageRelationRule.h.

Constructor & Destructor Documentation

◆ SourceImageRelationRule() [1/5]

mitk::SourceImageRelationRule::SourceImageRelationRule ( )

protected

Default constructor. Creates an abstract rule with no purpose tag.

◆ SourceImageRelationRule() [2/5]

mitk::SourceImageRelationRule::SourceImageRelationRule ( const RuleIDType & purposeTag )

protected

Construct a rule with a specific purpose tag.

Parameters

[in] purposeTag The purpose tag used as suffix for the rule ID.

◆ SourceImageRelationRule() [3/5]

mitk::SourceImageRelationRule::SourceImageRelationRule	(	const RuleIDType &	purposeTag,
		const std::string &	displayName
	)

protected

Construct a rule with a purpose tag and display name.

Parameters

[in]	purposeTag	The purpose tag used as suffix for the rule ID.
[in]	displayName	Human-readable name for the rule.

◆ SourceImageRelationRule() [4/5]

mitk::SourceImageRelationRule::SourceImageRelationRule	(	const RuleIDType &	purposeTag,
		const std::string &	displayName,
		const std::string &	sourceRole,
		const std::string &	destinationRole
	)

protected

Construct a rule with all customizable parameters.

Parameters

[in]	purposeTag	The purpose tag used as suffix for the rule ID.
[in]	displayName	Human-readable name for the rule.
[in]	sourceRole	Human-readable name for the source role.
[in]	destinationRole	Human-readable name for the destination role.

◆ ~SourceImageRelationRule()

mitk::SourceImageRelationRule::~SourceImageRelationRule ( )

overrideprotecteddefault

◆ SourceImageRelationRule() [5/5]

mitk::SourceImageRelationRule::SourceImageRelationRule ( const SourceImageRelationRule & other )

protected

Member Function Documentation

◆ Connect()

RelationUIDType mitk::SourceImageRelationRule::Connect	(	Image *	source,
		const Image *	destination
	)		const

Connect two images using this relation rule.

Remarks: The destination must specify DICOM SOP Instance UID (0x0008,0x0018) and DICOM SOP Class UID (0x0008,0x0016) in order to establish a connection on the data layer.

Parameters

[in]	source	The derived image (relation source).
[in]	destination	The original image (relation destination / DICOM source image).

Returns: The UID of the newly created relation.

◆ Connect_datalayer()

void mitk::SourceImageRelationRule::Connect_datalayer	(	IPropertyOwner *	source,
		const IPropertyProvider *	destination,
		const InstanceIDType &	instanceID
	)		const

overrideprotectedvirtual

Is called by Connect() to ensure that source has correctly set properties to resemble the relation on the data layer. This means that the method should set the properties that describe and encode the relation on the data layer (data-layer-specific relation properties). If the passed instance are already connected, the old settings should be overwritten. Connect() will ensure that source and destination are valid pointers.

Parameters

source
destination
instanceID	is the ID for the relation instance that should be connected. Existence of the relation instance is ensured.

Precondition: source must be a valid instance.; destination must be a valid instance.

Implements mitk::PropertyRelationRuleBase.

Reimplemented in mitk::SegSourceImageRelationRule.

◆ CreateNewSourceImageSequenceItem()

PropertyKeyPath::ItemSelectionIndex mitk::SourceImageRelationRule::CreateNewSourceImageSequenceItem ( IPropertyOwner * source ) const

protected

Prepare a new reference to an image on the data layer.

Generates an unused and valid sequence item index for the passed source and sets a relationUID property to block the instance ID. The instance ID is returned.

Remarks: This method is guarded by a class-wide mutex to avoid race conditions when rules are used concurrently.

◆ Disconnect_datalayer()

void mitk::SourceImageRelationRule::Disconnect_datalayer	(	IPropertyOwner *	source,
		const RelationUIDType &	relationUID
	)		const

overrideprotectedvirtual

This method is called by Disconnect() to remove all properties of the relation from the source that are set by Connect_datalayer().

Remarks: This method should remove all properties that are set for a specific relation by Connect_datalayer(...). If the relationUID is not part of the source, nothing will be changed. Disconnect() ensures that source is a valid pointer if called.; Disconnect() ensures that source is valid and only invokes if instance exists.

Implements mitk::PropertyRelationRuleBase.

Reimplemented in mitk::SegSourceImageRelationRule, and mitk::ModelFitResultRelationRule.

◆ GenerateRuleID()

std::string mitk::SourceImageRelationRule::GenerateRuleID ( const std::string & purpose ) const

protected

Generate a rule ID string from the given purpose tag.

◆ GetDestinationRoleName()

std::string mitk::SourceImageRelationRule::GetDestinationRoleName ( ) const

overridevirtual

Return a human-readable string describing the role of a destination in the context of this rule.

Implements mitk::PropertyRelationRuleBase.

◆ GetDisplayName()

std::string mitk::SourceImageRelationRule::GetDisplayName ( ) const

overridevirtual

Return a human-readable string describing the rule. Does not need to be unique.

Implements mitk::PropertyRelationRuleBase.

◆ GetReferenceSequenceIndices()

std::vector<std::pair<size_t, std::string> > mitk::SourceImageRelationRule::GetReferenceSequenceIndices	(	const IPropertyProvider *	source,
		const IPropertyProvider *	destination = `nullptr`,
		InstanceIDVectorType	ignoreInstances = `{}`
	)		const

protected

Get reference sequence indices from the DICOM Source Image Sequence (0008,2112).

Returns a vector of (sequence index, ruleID) pairs that refer to the given destination (or all if no destination is passed), have a supported RuleID, and are not already covered by ignoreInstances.

◆ GetRelationUIDs_DataLayer()

virtual DataRelationUIDVectorType mitk::SourceImageRelationRule::GetRelationUIDs_DataLayer	(	const IPropertyProvider *	source,
		const IPropertyProvider *	destination,
		const InstanceIDVectorType &	instances_IDLayer
	)		const

overrideprotectedvirtual

Returns the RelationUIDs of all relations that are defined by the data layer of source for this rule instance and, if defined, destination. If the passed source (and destination) instance has no relation on the data layer, an empty vector will be returned.

Remarks: Per definition for property relation rules only 0 or 1 instance should be found for one provider pair and concrete rule. But there might be more then one instance because either 1) the rule is abstract and supports multiple rule IDs or 2) the data layer may be ambiguous (e.g. because the destination was not specified) and therefore multiple relation instances of the rule instance could match. The implementation of this function should report all relation instances. The calling function will take care.

Parameters

source
destination	Destination the find relations should point to. If destination is NULL any relation on the data layer for this rule and source are wanted.
instances_IDLayer	List of relation instances that are already defined by the ID layer. The implementation of this function should only cover relations that are not already resembled in the passed relarions_IDLayer.

Precondition: source must be a pointer to a valid IPropertyProvider instance.

Implements mitk::PropertyRelationRuleBase.

Reimplemented in mitk::ModelFitResultRelationRule.

◆ GetRuleID()

RuleIDType mitk::SourceImageRelationRule::GetRuleID ( ) const

overridevirtual

Return an ID string that identifies the rule class.

Implements mitk::PropertyRelationRuleBase.

◆ GetSourceRoleName()

std::string mitk::SourceImageRelationRule::GetSourceRoleName ( ) const

overridevirtual

Return a human-readable string describing the role of a source in the context of this rule.

Implements mitk::PropertyRelationRuleBase.

◆ IsAbstract()

bool mitk::SourceImageRelationRule::IsAbstract ( ) const

overridevirtual

Return whether this rule is abstract (i.e. has no purpose tag).

Reimplemented from mitk::PropertyRelationRuleBase.

◆ IsDestinationCandidate()

bool mitk::SourceImageRelationRule::IsDestinationCandidate ( const IPropertyProvider * owner ) const

overridevirtual

Check whether the given property provider qualifies as a destination for this rule.

Reimplemented from mitk::PropertyRelationRuleBase.

Reimplemented in mitk::ModelFitResultRelationRule.

◆ IsSupportedRuleID()

bool mitk::SourceImageRelationRule::IsSupportedRuleID ( const RuleIDType & ruleID ) const

overrideprotectedvirtual

Returns if the passed rule ID is supported/relevant for the rule. Either because it is the very ID of the rule (default implementation) or because it is an abstract rule which also supports the rule ID.

Returns: true: If the rule ID can handle the rule ID. false: the rule does not support the rule ID.

Reimplemented from mitk::PropertyRelationRuleBase.

◆ mitkClassMacro()

mitk::SourceImageRelationRule::mitkClassMacro	(	SourceImageRelationRule	,
		PropertyRelationRuleBase
	)

◆ mitkCloneMacro()

mitk::SourceImageRelationRule::mitkCloneMacro ( Self )

protected

◆ mitkNewMacro1Param()

mitk::SourceImageRelationRule::mitkNewMacro1Param	(	Self	,
		const RuleIDType &
	)

◆ mitkNewMacro2Param()

mitk::SourceImageRelationRule::mitkNewMacro2Param	(	Self	,
		const RuleIDType &	,
		const std::string &
	)

◆ mitkNewMacro4Param()

mitk::SourceImageRelationRule::mitkNewMacro4Param	(	Self	,
		const RuleIDType &	,
		const std::string &	,
		const std::string &	,
		const std::string &
	)

◆ New()

static Pointer mitk::SourceImageRelationRule::New ( )

static

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

mitkSourceImageRelationRule.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DataRelationUIDVectorType

◆ InstanceIDType

◆ InstanceIDVectorType

◆ RelationUIDType

◆ RelationUIDVectorType

◆ RuleIDType

Constructor & Destructor Documentation

◆ SourceImageRelationRule() [1/5]

◆ SourceImageRelationRule() [2/5]

◆ SourceImageRelationRule() [3/5]

◆ SourceImageRelationRule() [4/5]

◆ ~SourceImageRelationRule()

◆ SourceImageRelationRule() [5/5]

Member Function Documentation

◆ Connect()

◆ Connect_datalayer()

◆ CreateNewSourceImageSequenceItem()

◆ Disconnect_datalayer()

◆ GenerateRuleID()

◆ GetDestinationRoleName()

◆ GetDisplayName()

◆ GetReferenceSequenceIndices()

◆ GetRelationUIDs_DataLayer()

◆ GetRuleID()

◆ GetSourceRoleName()

◆ IsAbstract()

◆ IsDestinationCandidate()

◆ IsSupportedRuleID()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param()

◆ mitkNewMacro2Param()

◆ mitkNewMacro4Param()

◆ New()