Class HierarchicalSOPInstanceReference
- Direct Known Subclasses:
HierarchicalImageReference
A class to represent the study, series and instance identifiers necessary to retrieve a specific instance using the hierarchical model.
Used, for example, when extracting a map of instance uids to hierarchical references from an SR evidence sequence.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstruct an instance of a reference from the attributes of the referenced instance itself.Construct an instance of a reference to an instance, with its hierarchy.HierarchicalSOPInstanceReference
(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID) Construct an instance of a reference to an instance, with its hierarchy. -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addToHierarchicalReferencesToSOPInstances
(AttributeList list, Map<String, HierarchicalSOPInstanceReference> hierarchicalInstancesBySOPInstanceUID) Find hierarchical references to instances that may be referenced anywhere in any dataset regardless of depth of nesting.Find hierarchical references to instances that may be referenced anywhere in any dataset regardless of depth of nesting.Find hierarchical references to instances that may be referenced in the content tree of an SR object.Get the Series Instance UID.Get the SOP Class UID.Get the SOP Instance UID.Get the Study Instance UID.static void
Dump the references in an a file (whether it is an SR file or not).toString()
static String
-
Field Details
-
studyInstanceUID
-
seriesInstanceUID
-
sopInstanceUID
-
sopClassUID
-
-
Constructor Details
-
HierarchicalSOPInstanceReference
public HierarchicalSOPInstanceReference(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID) Construct an instance of a reference to an instance, with its hierarchy.
- Parameters:
studyInstanceUID
- the Study Instance UIDseriesInstanceUID
- the Series Instance UIDsopInstanceUID
- the SOP Instance UIDsopClassUID
- the SOP Class UID
-
HierarchicalSOPInstanceReference
Construct an instance of a reference to an instance, with its hierarchy.
- Parameters:
reference
- an existing reference to clone
-
HierarchicalSOPInstanceReference
Construct an instance of a reference from the attributes of the referenced instance itself.
- Parameters:
list
- the attributes of an instance
-
-
Method Details
-
getStudyInstanceUID
Get the Study Instance UID.
- Returns:
- the Study Instance UID, or null
-
getSeriesInstanceUID
Get the Series Instance UID.
- Returns:
- the Series Instance UID, or null
-
getSOPInstanceUID
Get the SOP Instance UID.
- Returns:
- the SOP Instance UID, or null
-
getSOPClassUID
Get the SOP Class UID.
- Returns:
- the SOP Class UID, or null
-
findHierarchicalReferencesToSOPInstancesInStructuredReport
public static Map<String,HierarchicalSOPInstanceReference> findHierarchicalReferencesToSOPInstancesInStructuredReport(AttributeList list) Find hierarchical references to instances that may be referenced in the content tree of an SR object.
Uses the mandatory Current Requested Procedure Evidence Sequence in the top level dataset of an SR object.
- Parameters:
list
- the top level dataset of an SR instance- Returns:
- a
Map
ofString
SOPInstanceUIDs toHierarchicalSOPInstanceReference
-
findHierarchicalReferencesToSOPInstances
public static Map<String,HierarchicalSOPInstanceReference> findHierarchicalReferencesToSOPInstances(AttributeList list) Find hierarchical references to instances that may be referenced anywhere in any dataset regardless of depth of nesting.
Detects any occurence of ReferencedSOPInstanceUID and then uses surround context to establish hierarchy.
- Parameters:
list
- the top level dataset of an instance- Returns:
- a
Map
ofString
SOPInstanceUIDs toHierarchicalSOPInstanceReference
-
addToHierarchicalReferencesToSOPInstances
public static void addToHierarchicalReferencesToSOPInstances(AttributeList list, Map<String, HierarchicalSOPInstanceReference> hierarchicalInstancesBySOPInstanceUID) Find hierarchical references to instances that may be referenced anywhere in any dataset regardless of depth of nesting.
Detects any occurence of ReferencedSOPInstanceUID and then uses surround context to establish hierarchy.
- Parameters:
list
- the top level dataset of an instancehierarchicalInstancesBySOPInstanceUID
- aMap
ofString
SOPInstanceUIDs toHierarchicalSOPInstanceReference
that is added to as references are found
-
toString
-
toString
-
main
Dump the references in an a file (whether it is an SR file or not).
- Parameters:
arg
- DICOM file
-