Medical Imaging Interaction Toolkit
2023.12.00
Medical Imaging Interaction Toolkit
|
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... | |
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.
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
informationType | A 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. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
lesion | A 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. |
MITKSEMANTICRELATIONS_EXPORT 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.
SemanticRelationException,if | UID of the examination period does not exist for an examination period instance (this can be checked via 'InstanceExists'). |
caseID | The current case identifier is defined by the given string. |
examinationPeriod | An examination period with a UID that identifies the corresponding examination period instance. |
MITKSEMANTICRELATIONS_EXPORT 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.
SemanticRelationException,if | UID of the lesion does not exist for a lesion instance (this can be checked via 'InstanceExists'). |
caseID | The current case identifier is defined by the given string. |
lesion | A lesion with a UID that identifies the corresponding lesion instance. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
controlPoint | A 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. |
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::LesionClassVector mitk::SemanticRelationsInference::GetAllLesionClassesOfCase | ( | const SemanticTypes::CaseID & | caseID | ) |
Return a vector of lesion classes that are currently available for the given case.
caseID | The current case identifier is defined by the given string. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
controlPoint | A 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. |
MITKSEMANTICRELATIONS_EXPORT 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.
SemanticRelationException,if | the given image data node is invalid (==nullptr). |
imageNode | The current case identifier is extracted from the given data node, which contains DICOM information about the case. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
informationType | A 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. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
controlPoint | A 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. |
informationType | A 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. |
MITKSEMANTICRELATIONS_EXPORT 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.
SemanticRelationException,if | the given image data node is invalid (==nullptr). |
dataNode | The current case identifier is extracted from the given data node, which contains DICOM information about the case. |
MITKSEMANTICRELATIONS_EXPORT 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.
SemanticRelationException,if | the given image data node is invalid (==nullptr). |
imageNode | The current case identifier is extracted from the given data node, which contains DICOM information about the case. |
MITKSEMANTICRELATIONS_EXPORT SemanticTypes::Lesion mitk::SemanticRelationsInference::GetLesionOfSegmentation | ( | const DataNode * | segmentationNode | ) |
Return the lesion that is defined by the given segmentation.
SemanticRelationException,if | the given segmentation is invalid (==nullptr). |
SemanticRelationException,if | the segmentation does not represent an existing lesion (this can be checked via 'IsRepresentingALesion'). |
segmentationNode | The segmentation identifier is extracted from the given data node. |
MITKSEMANTICRELATIONS_EXPORT bool mitk::SemanticRelationsInference::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.
dataNode | A data node to check. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
controlPoint | A control point with a UID that identifies the corresponding control point instance. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
examinationPeriod | An examination period with a UID that identifies the corresponding examination period instance. |
MITKSEMANTICRELATIONS_EXPORT bool mitk::SemanticRelationsInference::InstanceExists | ( | const SemanticTypes::CaseID & | caseID, |
const SemanticTypes::InformationType & | informationType | ||
) |
Check if the given information type exists.
caseID | The current case identifier is defined by the given string. |
informationType | An information type. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
lesion | A lesion with a UID that identifies the corresponding lesion instance. |
MITKSEMANTICRELATIONS_EXPORT 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.
lesion | A lesion with a UID that identifies the corresponding lesion instance. |
dataNode | A data node to check. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
lesion | A lesion with a UID that identifies the corresponding lesion instance. |
controlPoint | A control point with a UID that identifies the corresponding control point instance. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
lesion | A lesion with a UID that identifies the corresponding lesion instance. |
imageID | The image node identifier is defined by the given string. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
lesion | A lesion with a UID that identifies the corresponding lesion instance. |
segmentationID | The segmentation node identifier is defined by the given string. |
MITKSEMANTICRELATIONS_EXPORT 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.
segmentationNode | The segmentation identifier is extracted from the given data node. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
segmentationID | The segmentation node identifier is defined by the given string. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
informationType | An information type that identifies the corresponding information type instance. |
controlPoint | A control point with a UID that identifies the corresponding control point instance. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
lesion | A Lesion with a UID that identifies the corresponding lesion instance. |
controlPoint | A control point with a UID that identifies the corresponding control point instance. |
MITKSEMANTICRELATIONS_EXPORT 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.
caseID | The current case identifier is defined by the given string. |
lesion | A Lesion with a UID that identifies the corresponding lesion instance. |
informationType | An information type that identifies the corresponding information type instance. |