mitk::SourceImageRelationRule Class Reference

#include <mitkSourceImageRelationRule.h>

Inheritance diagram for mitk::SourceImageRelationRule:

Collaboration diagram for mitk::SourceImageRelationRule:

Public Types
typedef SourceImageRelationRule	Self
typedef PropertyRelationRuleBase	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
using	RuleIDType = PropertyRelationRuleBase::RuleIDType
using	RelationUIDType = PropertyRelationRuleBase::RelationUIDType
using	RelationUIDVectorType = PropertyRelationRuleBase::RelationUIDVectorType
Public Types inherited from mitk::PropertyRelationRuleBase
enum	RelationType { RelationType::None, RelationType::Data, RelationType::ID, RelationType::Complete }
typedef PropertyRelationRuleBase	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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
virtual std::vector< std::string >	GetClassHierarchy () const override
virtual const char *	GetClassName () const
RuleIDType	GetRuleID () const override
bool	IsAbstract () const override
std::string	GetDisplayName () const override
std::string	GetSourceRoleName () const override
std::string	GetDestinationRoleName () const override
bool	IsDestinationCandidate (const IPropertyProvider *owner) const override
RelationUIDType	Connect (Image *source, const Image *destination) const
Public Member Functions inherited from mitk::PropertyRelationRuleBase
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

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New ()
static Pointer	New (const RuleIDType &_arg)
static Pointer	New (const RuleIDType &_arga, const std::string &_argb)
static Pointer	New (const RuleIDType &_arga, const std::string &_argb, const std::string &_argc, const std::string &_argd)
Static Public Member Functions inherited from mitk::PropertyRelationRuleBase
static const char *	GetStaticNameOfClass ()
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 ()
	SourceImageRelationRule (const RuleIDType &purposeTag)
	SourceImageRelationRule (const RuleIDType &purposeTag, const std::string &displayName)
	SourceImageRelationRule (const RuleIDType &purposeTag, const std::string &displayName, const std::string &sourceRole, const std::string &destinationRole)
	~SourceImageRelationRule () override=default
std::vector< std::pair< size_t, std::string > >	GetReferenceSequenceIndices (const IPropertyProvider *source, const IPropertyProvider *destination=nullptr, InstanceIDVectorType ignoreInstances={}) const
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
itk::LightObject::Pointer	InternalClone () const override
PropertyKeyPath::ItemSelectionIndex	CreateNewSourceImageSequenceItem (IPropertyOwner *source) const
std::string	GenerateRuleID (const std::string &purpose) const
Protected Member Functions inherited from mitk::PropertyRelationRuleBase
	PropertyRelationRuleBase ()=default
	~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
itk::LightObject::Pointer	InternalClone () const override
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

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 interface identifiable. 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 UIDs (0x0008, 0x0018) and DICOM SOP Class UID (0x0008, 0x0016). If the destination does not have this properties, no connection can be made on the data-layer.

Remarks

Please note that PropertyRelationRules and DICOM use the term "source" differently. The DICOM source (image) equals the PropertyRelationRule destination. This is due to an inverted relation direction. So in the context of the SourceImageRelationRule interface a derived data is the source and points to the original image, it derives from. In the context of DICOM this referenced original image would be called source image (as the name of this class). In order to be able to use this class for different relation types (DICOM would call it 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 of the instance and therefore allows to create specific and distinguishable rules 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")

Definition at line 44 of file mitkSourceImageRelationRule.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> mitk::SourceImageRelationRule::ConstPointer

Definition at line 47 of file mitkSourceImageRelationRule.h.

DataRelationUIDVectorType

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

protected

Definition at line 97 of file mitkSourceImageRelationRule.h.

InstanceIDType

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

protected

Definition at line 89 of file mitkSourceImageRelationRule.h.

InstanceIDVectorType

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

protected

Definition at line 90 of file mitkSourceImageRelationRule.h.

Pointer

typedef itk::SmartPointer<Self> mitk::SourceImageRelationRule::Pointer

Definition at line 47 of file mitkSourceImageRelationRule.h.

RelationUIDType

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

Definition at line 54 of file mitkSourceImageRelationRule.h.

RelationUIDVectorType

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

Definition at line 55 of file mitkSourceImageRelationRule.h.

RuleIDType

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

Definition at line 53 of file mitkSourceImageRelationRule.h.

Self

typedef SourceImageRelationRule mitk::SourceImageRelationRule::Self

Definition at line 47 of file mitkSourceImageRelationRule.h.

Superclass

typedef PropertyRelationRuleBase mitk::SourceImageRelationRule::Superclass

Definition at line 47 of file mitkSourceImageRelationRule.h.

Constructor & Destructor Documentation

SourceImageRelationRule() [1/4]

mitk::SourceImageRelationRule::SourceImageRelationRule ( )

protected

SourceImageRelationRule() [2/4]

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

protected

SourceImageRelationRule() [3/4]

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

protected

SourceImageRelationRule() [4/4]

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

protected

~SourceImageRelationRule()

mitk::SourceImageRelationRule::~SourceImageRelationRule ( )

overrideprotecteddefault

Member Function Documentation

Connect()

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

Connects to passed images.

Remarks

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

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.

CreateNewSourceImageSequenceItem()

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

protected

Prepares a new reference to an image on the data layer. Therefore an unused and valid sequence item index for the passed source will be generated and a relationUID property with the relationUID will be set to block the instance ID. The instance ID will be returned.

Remarks

The method is guarded by a class wide mutex to avoid racing conditions in a scenario where 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::ModelFitResultRelationRule.

GenerateRuleID()

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

protected

GetClassHierarchy()

virtual std::vector<std::string> mitk::SourceImageRelationRule::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::PropertyRelationRuleBase.

Definition at line 47 of file mitkSourceImageRelationRule.h.

GetClassName()

virtual const char* mitk::SourceImageRelationRule::GetClassName ( ) const

virtual

Reimplemented from mitk::PropertyRelationRuleBase.

GetDestinationRoleName()

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

overridevirtual

Returns a human readable string that can be used to describe the role of a destination in context of the rule instance.

Implements mitk::PropertyRelationRuleBase.

GetDisplayName()

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

overridevirtual

Returns a human readable string that can be used to describe 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

Helper function that returns a vector of all selections of the property DICOM.0008.2112 (and its associated ruleID) that refer to destination or all (if no destination is passed) with a supported RuleID and which are not already covered by the 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

Returns an ID string that identifies the rule class

Implements mitk::PropertyRelationRuleBase.

GetSourceRoleName()

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

overridevirtual

Returns a human readable string that can be used to describe the role of a source in context of the rule instance.

Implements mitk::PropertyRelationRuleBase.

GetStaticNameOfClass()

static const char* mitk::SourceImageRelationRule::GetStaticNameOfClass ( )

inlinestatic

Definition at line 47 of file mitkSourceImageRelationRule.h.

InternalClone()

itk::LightObject::Pointer mitk::SourceImageRelationRule::InternalClone ( ) const

overrideprotected

IsAbstract()

bool mitk::SourceImageRelationRule::IsAbstract ( ) const

overridevirtual

Returns if the instance is a abstract rule (true). Default implementation is true. Overwrite and reimplement if another behavior is needed.

Reimplemented from mitk::PropertyRelationRuleBase.

IsDestinationCandidate()

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

overridevirtual

This method checks if owner is eligible to be a Destination for the rule. The default implementation returns a True for every valid IPropertyProvider (so only a null_ptr results into false). May be reimplement by derived rules if they have requirements on potential Sources).

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.

New() [1/4]

static Pointer mitk::SourceImageRelationRule::New ( )

static

New() [2/4]

static Pointer mitk::SourceImageRelationRule::New ( const RuleIDType &  _arg )

inlinestatic

Definition at line 49 of file mitkSourceImageRelationRule.h.

New() [3/4]

static Pointer mitk::SourceImageRelationRule::New ( const RuleIDType &  _arga, const std::string &  _argb  )

inlinestatic

Definition at line 50 of file mitkSourceImageRelationRule.h.

New() [4/4]

static Pointer mitk::SourceImageRelationRule::New ( const RuleIDType &  _arga, const std::string &  _argb, const std::string &  _argc, const std::string &  _argd  )

inlinestatic

Definition at line 51 of file mitkSourceImageRelationRule.h.

---

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

• mitkSourceImageRelationRule.h