Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::SemanticRelationsInference Namespace Reference

The API provides functions to query image relations and instances that are helpful during follow-up examination, like control-points (time period), types of the images or lesions that may be visible on multiple images. More...

Functions

MITKSEMANTICRELATIONS_EXPORT SemanticTypes::LesionClassVector GetAllLesionClassesOfCase (const SemanticTypes::CaseID &caseID)
 Return a vector of lesion classes that are currently available for the given case. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::Lesion GetLesionOfSegmentation (const DataNode *segmentationNode)
 Return the lesion that is defined by the given segmentation. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::LesionVector GetAllLesionsOfImage (const DataNode *imageNode)
 Returns a vector of all lesions that are currently available for the current case and are connected to the given image (via a segmentation). If no lesions are stored for the current case, an empty vector is returned. If no segmentations are connected with the image node, no lesions for the specific image will be found and an empty vector is returned. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::LesionVector GetAllLesionsOfControlPoint (const SemanticTypes::CaseID &caseID, const SemanticTypes::ControlPoint &controlPoint)
 Returns a vector of all lesions that are valid for the given case, given a specific control point. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::LesionVector GetAllLesionsOfInformationType (const SemanticTypes::CaseID &caseID, const SemanticTypes::InformationType &informationType)
 Returns a vector of all lesions that are valid for the given case, given a specific information type. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::LesionVector GetAllSpecificLesions (const SemanticTypes::CaseID &caseID, const SemanticTypes::ControlPoint &controlPoint, const SemanticTypes::InformationType &informationType)
 Returns a vector of all lesions that are valid for the given case, given a specific control point and a specific information type. More...
 
MITKSEMANTICRELATIONS_EXPORT bool IsRepresentingALesion (const DataNode *segmentationNode)
 Check if the given segmentation refers to an existing lesion instance. This function can be used before calling 'GetRepresentedLesion' in order to avoid a possible exception. More...
 
MITKSEMANTICRELATIONS_EXPORT bool IsRepresentingALesion (const SemanticTypes::CaseID &caseID, const SemanticTypes::ID &segmentationID)
 Check if the segmentation identified by the given segmentation ID refers to an existing lesion instance. This function can be used before calling 'GetRepresentedLesion' in order to avoid a possible exception. More...
 
MITKSEMANTICRELATIONS_EXPORT bool IsLesionPresent (const SemanticTypes::Lesion &lesion, const DataNode *dataNode)
 Check if the given lesion is present on the given data node. The function receives the case- and the node-ID from the DICOM tags of the node itself. It uses node predicates to decide if the node is an image or a segmentation node. More...
 
MITKSEMANTICRELATIONS_EXPORT bool IsLesionPresentOnImage (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion, const SemanticTypes::ID &imageID)
 Check if the given lesion is related to the image identified by the given image ID. Each lesion is represented by a segmentation which is connected to its parent image. More...
 
MITKSEMANTICRELATIONS_EXPORT bool IsLesionPresentOnSegmentation (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion, const SemanticTypes::ID &segmentationID)
 Check if the given lesion is present on the segmentation identified by the given segmentation ID. More...
 
MITKSEMANTICRELATIONS_EXPORT bool IsLesionPresentAtControlPoint (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion, const SemanticTypes::ControlPoint &controlPoint)
 Check if the given lesion is present at the given control point. More...
 
MITKSEMANTICRELATIONS_EXPORT bool InstanceExists (const DataNode *dataNode)
 Check if the given data node exists in the relation storage. The function receives the case- and the node-ID from the DICOM tags of the node itself. It uses node predicates to decide if the node is an image or a segmentation node and searches through the corresponding relations. More...
 
MITKSEMANTICRELATIONS_EXPORT bool InstanceExists (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion)
 Check if the given lesion instance exists. This function can be used before calling 'AddLesionInstance' in order to avoid a possible exception. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::IDVector GetAllImageIDsOfLesion (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion)
 Return a vector of all image IDs that identify images that are related to the given lesion. Each lesion is represented by a segmentation which is connected to its parent image. If the lesion is not represented by any segmentation, an empty vector is returned. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::IDVector GetAllImageIDsOfExaminationPeriod (const SemanticTypes::CaseID &caseID, const SemanticTypes::ExaminationPeriod &examinationPeriod)
 Return a vector of all image IDs that identify images that are related to the given examination period. If the examination period is not used by and image, an empty vector is returned. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::ControlPoint GetControlPointOfImage (const DataNode *dataNode)
 Return the control point of a data node. If the data node is not linked to a control point or the data node refers to a non-existing control point, a control point with an empty UID is returned. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::ControlPointVector GetAllControlPointsOfLesion (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion)
 Return a vector of all control points that are valid for the given case, given a specific lesion. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::ControlPointVector GetAllControlPointsOfInformationType (const SemanticTypes::CaseID &caseID, const SemanticTypes::InformationType &informationType)
 Return a vector of all control points that are valid for the given case, given a specific information type. More...
 
MITKSEMANTICRELATIONS_EXPORT bool InstanceExists (const SemanticTypes::CaseID &caseID, const SemanticTypes::ControlPoint &controlPoint)
 Check if the given control point instance exists. This function can be used before adding, linking and unlinking control points to avoid a possible exception. More...
 
MITKSEMANTICRELATIONS_EXPORT bool InstanceExists (const SemanticTypes::CaseID &caseID, const SemanticTypes::ExaminationPeriod &examinationPeriod)
 Check if the given examination period instance exists. This function can be used before calling 'AddExaminationPeriod' in order to avoid a possible exception. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::InformationType GetInformationTypeOfImage (const DataNode *imageNode)
 Return the information type of the given image. If the image does not contain any information type, an empty information type is returned. More...
 
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::InformationTypeVector GetAllInformationTypesOfControlPoint (const SemanticTypes::CaseID &caseID, const SemanticTypes::ControlPoint &controlPoint)
 Return a vector of all information types that are valid for the given case, given a specific control point. More...
 
MITKSEMANTICRELATIONS_EXPORT bool InstanceExists (const SemanticTypes::CaseID &caseID, const SemanticTypes::InformationType &informationType)
 Check if the given information type exists. More...
 
MITKSEMANTICRELATIONS_EXPORT bool SpecificImageExists (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion, const SemanticTypes::InformationType &informationType)
 Determine if the given information type contains images, which are connected to segmentations that represent the given lesion. If the lesion or the information type are not correctly stored, the function returns false. More...
 
MITKSEMANTICRELATIONS_EXPORT bool SpecificImageExists (const SemanticTypes::CaseID &caseID, const SemanticTypes::Lesion &lesion, const SemanticTypes::ControlPoint &controlPoint)
 Determine if the given control point contains images, which are connected to segmentations that represent the given lesion. If the lesion or the control point are not correctly stored, the function returns false. More...
 
MITKSEMANTICRELATIONS_EXPORT bool SpecificImageExists (const SemanticTypes::CaseID &caseID, const SemanticTypes::InformationType &informationType, const SemanticTypes::ControlPoint &controlPoint)
 Determine if the given control point contains images, which refer to the given information type. If the information type or the control point are not correctly stored, the function returns false. More...
 

Detailed Description

The API provides functions to query image relations and instances that are helpful during follow-up examination, like control-points (time period), types of the images or lesions that may be visible on multiple images.

The class is able to generate IDs from given data nodes using DICOM information. These IDs are used to identify the corresponding instances of a specific case. The case can also be directly identified by the given case ID.

In order for most functions to work the case ID has to be used as a parameter. If not, these functions do nothing.

Function Documentation

◆ GetAllControlPointsOfInformationType()

mitk::SemanticTypes::ControlPointVector mitk::SemanticRelationsInference::GetAllControlPointsOfInformationType ( const SemanticTypes::CaseID caseID,
const SemanticTypes::InformationType informationType 
)

Return a vector of all control points that are valid for the given case, given a specific information type.

Parameters
caseIDThe current case identifier is defined by the given string.
informationTypeA specific information type which has to be available at a returned (found) control point: Only those control points are returned for which an associated data has the given information type. If the information type instance does not exists, an empty vector is returned.
Returns
A vector of control points.

Definition at line 414 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllControlPointsOfCase(), and SpecificImageExists().

◆ GetAllControlPointsOfLesion()

mitk::SemanticTypes::ControlPointVector mitk::SemanticRelationsInference::GetAllControlPointsOfLesion ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion 
)

Return a vector of all control points that are valid for the given case, given a specific lesion.

Parameters
caseIDThe current case identifier is defined by the given string.
lesionA specific lesion which has to be available at a returned (found) control point: Only those control points are returned for which an associated data has a segmentation that references the given lesion. If the lesion does not exists, an empty vector is returned.
Returns
A vector of control points.

Definition at line 399 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllControlPointsOfCase(), and SpecificImageExists().

◆ GetAllImageIDsOfExaminationPeriod()

mitk::SemanticTypes::IDVector mitk::SemanticRelationsInference::GetAllImageIDsOfExaminationPeriod ( const SemanticTypes::CaseID caseID,
const SemanticTypes::ExaminationPeriod examinationPeriod 
)

Return a vector of all image IDs that identify images that are related to the given examination period. If the examination period is not used by and image, an empty vector is returned.

Precondition
The UID of the examination period has to exist for an examination period instance.
Exceptions
SemanticRelationException,ifUID of the examination period does not exist for an examination period instance (this can be checked via 'InstanceExists').
Parameters
caseIDThe current case identifier is defined by the given string.
examinationPeriodAn examination period with a UID that identifies the corresponding examination period instance.
Returns
A vector of IDs identifying images that are related to the given examination period.

Definition at line 356 of file mitkSemanticRelationsInference.cpp.

References mitk::SemanticTypes::ExaminationPeriod::controlPointUIDs, mitk::RelationStorage::GetAllImageIDsOfControlPoint(), mitk::GetControlPointByUID(), mitk::RelationStorage::InstanceExists(), mitkThrowException, and mitk::SemanticTypes::ExaminationPeriod::name.

Referenced by mitk::SemanticRelationsDataStorageAccess::GetAllSpecificImages().

◆ GetAllImageIDsOfLesion()

mitk::SemanticTypes::IDVector mitk::SemanticRelationsInference::GetAllImageIDsOfLesion ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion 
)

Return a vector of all image IDs that identify images that are related to the given lesion. Each lesion is represented by a segmentation which is connected to its parent image. If the lesion is not represented by any segmentation, an empty vector is returned.

Precondition
The UID of the lesion has to exist for a lesion instance.
Exceptions
SemanticRelationException,ifUID of the lesion does not exist for a lesion instance (this can be checked via 'InstanceExists').
Parameters
caseIDThe current case identifier is defined by the given string.
lesionA lesion with a UID that identifies the corresponding lesion instance.
Returns
A vector of IDs identifying images that are related to the given lesion.

Definition at line 328 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllSegmentationIDsOfLesion(), mitk::RelationStorage::GetImageIDOfSegmentation(), mitk::RelationStorage::InstanceExists(), mitkThrowException, and mitk::SemanticTypes::Lesion::UID.

Referenced by IsLesionPresentAtControlPoint(), IsLesionPresentOnImage(), and SpecificImageExists().

◆ GetAllInformationTypesOfControlPoint()

mitk::SemanticTypes::InformationTypeVector mitk::SemanticRelationsInference::GetAllInformationTypesOfControlPoint ( const SemanticTypes::CaseID caseID,
const SemanticTypes::ControlPoint controlPoint 
)

Return a vector of all information types that are valid for the given case, given a specific control point.

Parameters
caseIDThe current case identifier is defined by the given string.
controlPointA specific control point which has to be available at a returned (found) information type: Only those information types are returned for which an associated data is linked to the given control point. If the control point instance does not exist, an empty vector is returned.
Returns
A vector of information types.

Definition at line 487 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllInformationTypesOfCase(), and SpecificImageExists().

◆ GetAllLesionClassesOfCase()

mitk::SemanticTypes::LesionClassVector mitk::SemanticRelationsInference::GetAllLesionClassesOfCase ( const SemanticTypes::CaseID caseID)

Return a vector of lesion classes that are currently available for the given case.

Parameters
caseIDThe current case identifier is defined by the given string.
Returns
A vector of lesion classes.

Definition at line 26 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllLesionsOfCase(), and mitk::SemanticTypes::LesionClass::UID.

Referenced by mitk::FindExistingLesionClass().

◆ GetAllLesionsOfControlPoint()

mitk::SemanticTypes::LesionVector mitk::SemanticRelationsInference::GetAllLesionsOfControlPoint ( const SemanticTypes::CaseID caseID,
const SemanticTypes::ControlPoint controlPoint 
)

Returns a vector of all lesions that are valid for the given case, given a specific control point.

Parameters
caseIDThe current case identifier is defined by the given string.
controlPointA specific control point which has to be available at a returned (found) lesion: Only those lesions are returned for which the image of the associated segmentation is linked to the given control point. If the control point instance does not exist, an empty vector is returned.
Returns
A vector of lesions.

Definition at line 126 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllLesionsOfCase(), and SpecificImageExists().

Referenced by GetAllSpecificLesions().

◆ GetAllLesionsOfImage()

mitk::SemanticTypes::LesionVector mitk::SemanticRelationsInference::GetAllLesionsOfImage ( const DataNode imageNode)

Returns a vector of all lesions that are currently available for the current case and are connected to the given image (via a segmentation). If no lesions are stored for the current case, an empty vector is returned. If no segmentations are connected with the image node, no lesions for the specific image will be found and an empty vector is returned.

Precondition
The given image data node has to be valid (!nullptr).
Exceptions
SemanticRelationException,ifthe given image data node is invalid (==nullptr).
Parameters
imageNodeThe current case identifier is extracted from the given data node, which contains DICOM information about the case.
Returns
A vector of lesions.

Definition at line 75 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllSegmentationIDsOfImage(), mitk::GetCaseIDFromDataNode(), mitk::GetIDFromDataNode(), mitk::RelationStorage::GetLesionOfSegmentation(), mitkReThrow, mitkThrowException, and mitk::SemanticTypes::Lesion::UID.

◆ GetAllLesionsOfInformationType()

mitk::SemanticTypes::LesionVector mitk::SemanticRelationsInference::GetAllLesionsOfInformationType ( const SemanticTypes::CaseID caseID,
const SemanticTypes::InformationType informationType 
)

Returns a vector of all lesions that are valid for the given case, given a specific information type.

Parameters
caseIDThe current case identifier is defined by the given string.
informationTypeA specific information type which has to be available at a returned (found) lesion: Only those lesions are returned for which the image of the associated segmentation is of the given information type. If the information type instance does not exist, an empty vector is returned.
Returns
A vector of lesions.

Definition at line 141 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllLesionsOfCase(), and SpecificImageExists().

Referenced by GetAllSpecificLesions().

◆ GetAllSpecificLesions()

mitk::SemanticTypes::LesionVector mitk::SemanticRelationsInference::GetAllSpecificLesions ( const SemanticTypes::CaseID caseID,
const SemanticTypes::ControlPoint controlPoint,
const SemanticTypes::InformationType informationType 
)

Returns a vector of all lesions that are valid for the given case, given a specific control point and a specific information type.

Parameters
caseIDThe current case identifier is defined by the given string.
controlPointA specific control point which has to be available at a returned (found) lesion: Only those lesions are returned for which the image of the associated segmentation is linked to the given control point. If the control point instance does not exist, an empty vector is returned.
informationTypeA specific information type which has to be available at a returned (found) lesion: Only those lesions are returned for which the image of the associated segmentation is of the given information type. If the information type instance does not exist, an empty vector is returned.
Returns
A vector of lesions.

Definition at line 156 of file mitkSemanticRelationsInference.cpp.

References GetAllLesionsOfControlPoint(), GetAllLesionsOfInformationType(), and mitk::SemanticTypes::Lesion::UID.

◆ GetControlPointOfImage()

mitk::SemanticTypes::ControlPoint mitk::SemanticRelationsInference::GetControlPointOfImage ( const DataNode dataNode)

Return the control point of a data node. If the data node is not linked to a control point or the data node refers to a non-existing control point, a control point with an empty UID is returned.

Precondition
The given image data node has to be valid (!nullptr).
Exceptions
SemanticRelationException,ifthe given image data node is invalid (==nullptr).
Parameters
dataNodeThe current case identifier is extracted from the given data node, which contains DICOM information about the case.
Returns
The control point of the given data node.

Definition at line 377 of file mitkSemanticRelationsInference.cpp.

References mitk::GetCaseIDFromDataNode(), mitk::RelationStorage::GetControlPointOfImage(), mitk::GetIDFromDataNode(), mitkReThrow, and mitkThrowException.

Referenced by mitk::SemanticRelationsDataStorageAccess::GetAllSpecificImages().

◆ GetInformationTypeOfImage()

mitk::SemanticTypes::InformationType mitk::SemanticRelationsInference::GetInformationTypeOfImage ( const DataNode imageNode)

Return the information type of the given image. If the image does not contain any information type, an empty information type is returned.

Precondition
The given image data node has to be valid (!nullptr).
Exceptions
SemanticRelationException,ifthe given image data node is invalid (==nullptr).
Parameters
imageNodeThe current case identifier is extracted from the given data node, which contains DICOM information about the case.
Returns
The information type of the given data node.

Definition at line 465 of file mitkSemanticRelationsInference.cpp.

References mitk::GetCaseIDFromDataNode(), mitk::GetIDFromDataNode(), mitk::RelationStorage::GetInformationTypeOfImage(), mitkReThrow, and mitkThrowException.

Referenced by mitk::SemanticRelationsDataStorageAccess::GetAllSpecificImages().

◆ GetLesionOfSegmentation()

mitk::SemanticTypes::Lesion mitk::SemanticRelationsInference::GetLesionOfSegmentation ( const DataNode segmentationNode)

Return the lesion that is defined by the given segmentation.

Precondition
The given segmentation data node has to be valid (!nullptr).
Exceptions
SemanticRelationException,ifthe given segmentation is invalid (==nullptr).
Precondition
The segmentation data node has to represent a lesion. If not, the retrieved lesion will be empty, which leads to an exception.
Exceptions
SemanticRelationException,ifthe segmentation does not represent an existing lesion (this can be checked via 'IsRepresentingALesion').
Parameters
segmentationNodeThe segmentation identifier is extracted from the given data node.
Returns
The represented lesion.

Definition at line 53 of file mitkSemanticRelationsInference.cpp.

References mitk::GetCaseIDFromDataNode(), mitk::GetIDFromDataNode(), mitk::RelationStorage::GetLesionOfSegmentation(), mitkReThrow, and mitkThrowException.

Referenced by mitk::SemanticRelationsDataStorageAccess::GetAllSegmentationsOfLesion(), and mitk::SemanticRelationsDataStorageAccess::GetSpecificSegmentation().

◆ InstanceExists() [1/5]

bool mitk::SemanticRelationsInference::InstanceExists ( const DataNode dataNode)

◆ InstanceExists() [2/5]

bool mitk::SemanticRelationsInference::InstanceExists ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion 
)

Check if the given lesion instance exists. This function can be used before calling 'AddLesionInstance' in order to avoid a possible exception.

Parameters
caseIDThe current case identifier is defined by the given string.
lesionA lesion with a UID that identifies the corresponding lesion instance.
Returns
True, if the lesion instance exists; false otherwise.

Definition at line 313 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllLesionsOfCase(), and mitk::SemanticTypes::Lesion::UID.

◆ InstanceExists() [3/5]

bool mitk::SemanticRelationsInference::InstanceExists ( const SemanticTypes::CaseID caseID,
const SemanticTypes::ControlPoint controlPoint 
)

Check if the given control point instance exists. This function can be used before adding, linking and unlinking control points to avoid a possible exception.

Parameters
caseIDThe current case identifier is defined by the given string.
controlPointA control point with a UID that identifies the corresponding control point instance.
Returns
True, if the control point instance exists; false otherwise.

Definition at line 429 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllControlPointsOfCase(), and mitk::SemanticTypes::ControlPoint::UID.

◆ InstanceExists() [4/5]

bool mitk::SemanticRelationsInference::InstanceExists ( const SemanticTypes::CaseID caseID,
const SemanticTypes::ExaminationPeriod examinationPeriod 
)

Check if the given examination period instance exists. This function can be used before calling 'AddExaminationPeriod' in order to avoid a possible exception.

Parameters
caseIDThe current case identifier is defined by the given string.
examinationPeriodAn examination period with a UID that identifies the corresponding examination period instance.
Returns
True, if the examination period instance exists; false otherwise.

Definition at line 447 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllExaminationPeriodsOfCase(), and mitk::SemanticTypes::ExaminationPeriod::UID.

◆ InstanceExists() [5/5]

bool mitk::SemanticRelationsInference::InstanceExists ( const SemanticTypes::CaseID caseID,
const SemanticTypes::InformationType informationType 
)

Check if the given information type exists.

Parameters
caseIDThe current case identifier is defined by the given string.
informationTypeAn information type.
Returns
True, if the information type exists; false otherwise.

Definition at line 502 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllInformationTypesOfCase().

◆ IsLesionPresent()

bool mitk::SemanticRelationsInference::IsLesionPresent ( const SemanticTypes::Lesion lesion,
const DataNode dataNode 
)

Check if the given lesion is present on the given data node. The function receives the case- and the node-ID from the DICOM tags of the node itself. It uses node predicates to decide if the node is an image or a segmentation node.

Parameters
lesionA lesion with a UID that identifies the corresponding lesion instance.
dataNodeA data node to check.
Returns
True, if the lesion is present on the data node; false otherwise.

Definition at line 204 of file mitkSemanticRelationsInference.cpp.

References mitk::GetCaseIDFromDataNode(), mitk::GetIDFromDataNode(), mitk::NodePredicates::GetImagePredicate(), mitk::NodePredicates::GetSegmentationPredicate(), IsLesionPresentOnImage(), and IsLesionPresentOnSegmentation().

Referenced by QmitkLesionTreeModel::SetData(), and QmitkPatientTableModel::SetData().

◆ IsLesionPresentAtControlPoint()

bool mitk::SemanticRelationsInference::IsLesionPresentAtControlPoint ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion,
const SemanticTypes::ControlPoint controlPoint 
)

Check if the given lesion is present at the given control point.

Parameters
caseIDThe current case identifier is defined by the given string.
lesionA lesion with a UID that identifies the corresponding lesion instance.
controlPointA control point with a UID that identifies the corresponding control point instance.
Returns
True, if the lesion is present at the given control point; false otherwise.

Definition at line 260 of file mitkSemanticRelationsInference.cpp.

References mitk::SemanticTypes::ControlPoint::date, GetAllImageIDsOfLesion(), mitk::RelationStorage::GetControlPointOfImage(), and mitkReThrow.

Referenced by mitk::ComputeLesionPresence().

◆ IsLesionPresentOnImage()

bool mitk::SemanticRelationsInference::IsLesionPresentOnImage ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion,
const SemanticTypes::ID imageID 
)

Check if the given lesion is related to the image identified by the given image ID. Each lesion is represented by a segmentation which is connected to its parent image.

Parameters
caseIDThe current case identifier is defined by the given string.
lesionA lesion with a UID that identifies the corresponding lesion instance.
imageIDThe image node identifier is defined by the given string.
Returns
True, if the lesion is related to image identified by the given image ID; false otherwise.

Definition at line 231 of file mitkSemanticRelationsInference.cpp.

References GetAllImageIDsOfLesion(), and mitkReThrow.

Referenced by IsLesionPresent().

◆ IsLesionPresentOnSegmentation()

bool mitk::SemanticRelationsInference::IsLesionPresentOnSegmentation ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion,
const SemanticTypes::ID segmentationID 
)

Check if the given lesion is present on the segmentation identified by the given segmentation ID.

Parameters
caseIDThe current case identifier is defined by the given string.
lesionA lesion with a UID that identifies the corresponding lesion instance.
segmentationIDThe segmentation node identifier is defined by the given string.
Returns
True, if the lesion is present on the segmentation identified by the given segmentation ID; false otherwise.

Definition at line 254 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetLesionOfSegmentation(), and mitk::SemanticTypes::Lesion::UID.

Referenced by IsLesionPresent().

◆ IsRepresentingALesion() [1/2]

bool mitk::SemanticRelationsInference::IsRepresentingALesion ( const DataNode segmentationNode)

Check if the given segmentation refers to an existing lesion instance. This function can be used before calling 'GetRepresentedLesion' in order to avoid a possible exception.

Parameters
segmentationNodeThe segmentation identifier is extracted from the given data node.
Returns
True, if the segmentation refers to an existing lesion; false otherwise.

Definition at line 183 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetLesionOfSegmentation(), and mitk::SemanticTypes::Lesion::UID.

◆ IsRepresentingALesion() [2/2]

bool mitk::SemanticRelationsInference::IsRepresentingALesion ( const SemanticTypes::CaseID caseID,
const SemanticTypes::ID segmentationID 
)

Check if the segmentation identified by the given segmentation ID refers to an existing lesion instance. This function can be used before calling 'GetRepresentedLesion' in order to avoid a possible exception.

Parameters
caseIDThe current case identifier is defined by the given string.
segmentationIDThe segmentation node identifier is defined by the given string.
Returns
True, if the segmentation refers to an existing lesion; false otherwise.

Definition at line 198 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetLesionOfSegmentation(), and mitk::SemanticTypes::Lesion::UID.

◆ SpecificImageExists() [1/3]

bool mitk::SemanticRelationsInference::SpecificImageExists ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion,
const SemanticTypes::InformationType informationType 
)

Determine if the given information type contains images, which are connected to segmentations that represent the given lesion. If the lesion or the information type are not correctly stored, the function returns false.

Parameters
caseIDThe current case identifier is defined by the given string.
lesionA Lesion with a UID that identifies the corresponding lesion instance.
informationTypeAn information type that identifies the corresponding information type instance.
Returns
True, if the given information type contains data that is related to the given lesion; false otherwise.

Definition at line 520 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllImageIDsOfInformationType(), and GetAllImageIDsOfLesion().

Referenced by GetAllControlPointsOfInformationType(), GetAllControlPointsOfLesion(), GetAllInformationTypesOfControlPoint(), GetAllLesionsOfControlPoint(), and GetAllLesionsOfInformationType().

◆ SpecificImageExists() [2/3]

bool mitk::SemanticRelationsInference::SpecificImageExists ( const SemanticTypes::CaseID caseID,
const SemanticTypes::Lesion lesion,
const SemanticTypes::ControlPoint controlPoint 
)

Determine if the given control point contains images, which are connected to segmentations that represent the given lesion. If the lesion or the control point are not correctly stored, the function returns false.

Parameters
caseIDThe current case identifier is defined by the given string.
lesionA Lesion with a UID that identifies the corresponding lesion instance.
controlPointA control point with a UID that identifies the corresponding control point instance.
Returns
True, if the given control point contains data that is related to the given lesion; false otherwise.

Definition at line 546 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllImageIDsOfControlPoint(), and GetAllImageIDsOfLesion().

◆ SpecificImageExists() [3/3]

bool mitk::SemanticRelationsInference::SpecificImageExists ( const SemanticTypes::CaseID caseID,
const SemanticTypes::InformationType informationType,
const SemanticTypes::ControlPoint controlPoint 
)

Determine if the given control point contains images, which refer to the given information type. If the information type or the control point are not correctly stored, the function returns false.

Parameters
caseIDThe current case identifier is defined by the given string.
informationTypeAn information type that identifies the corresponding information type instance.
controlPointA control point with a UID that identifies the corresponding control point instance.
Returns
True, if the given control point contains data that is related to the given information type; false otherwise.

Definition at line 572 of file mitkSemanticRelationsInference.cpp.

References mitk::RelationStorage::GetAllImageIDsOfControlPoint(), and mitk::RelationStorage::GetAllImageIDsOfInformationType().