Package com.pixelmed.dicom
Class HierarchicalImageReference
java.lang.Object
com.pixelmed.dicom.HierarchicalSOPInstanceReference
com.pixelmed.dicom.HierarchicalImageReference
A class to represent the study, series and instance identifiers necessary to retrieve a specific single image or frame in a multi-frame image using the hierarchical model.
Used, for example, when extracting a map of instance uids to hierarchical references from an SR evidence sequence.
-
Field Summary
FieldsFields inherited from class com.pixelmed.dicom.HierarchicalSOPInstanceReference
seriesInstanceUID, sopClassUID, sopInstanceUID, studyInstanceUID
-
Constructor Summary
ConstructorsConstructorDescriptionHierarchicalImageReference
(HierarchicalSOPInstanceReference instanceReference) Construct an instance of a reference to an image, with its hierarchy.HierarchicalImageReference
(HierarchicalSOPInstanceReference instanceReference, String referencedFrameNumber) Construct an instance of a reference to an image, with its hierarchy.HierarchicalImageReference
(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID) Construct an instance of a reference to an image, with its hierarchy.HierarchicalImageReference
(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID, String referencedFrameNumber) Construct an instance of a reference to an image, with its hierarchy. -
Method Summary
Methods inherited from class com.pixelmed.dicom.HierarchicalSOPInstanceReference
addToHierarchicalReferencesToSOPInstances, findHierarchicalReferencesToSOPInstances, findHierarchicalReferencesToSOPInstancesInStructuredReport, getSeriesInstanceUID, getSOPClassUID, getSOPInstanceUID, getStudyInstanceUID, main, toString
-
Field Details
-
referencedFrameNumber
-
-
Constructor Details
-
HierarchicalImageReference
public HierarchicalImageReference(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID) Construct an instance of a reference to an image, with its hierarchy.
- Parameters:
studyInstanceUID
- the Study Instance UIDseriesInstanceUID
- the Series Instance UIDsopInstanceUID
- the SOP Instance UIDsopClassUID
- the SOP Class UID
-
HierarchicalImageReference
public HierarchicalImageReference(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID, String referencedFrameNumber) Construct an instance of a reference to an image, with its hierarchy.
- Parameters:
studyInstanceUID
- the Study Instance UIDseriesInstanceUID
- the Series Instance UIDsopInstanceUID
- the SOP Instance UIDsopClassUID
- the SOP Class UIDreferencedFrameNumber
- the Referenced Frame Number
-
HierarchicalImageReference
public HierarchicalImageReference(HierarchicalSOPInstanceReference instanceReference, String referencedFrameNumber) Construct an instance of a reference to an image, with its hierarchy.
- Parameters:
instanceReference
- an existingHierarchicalSOPInstanceReference
for this imagereferencedFrameNumber
- the Referenced Frame Number
-
HierarchicalImageReference
Construct an instance of a reference to an image, with its hierarchy.
- Parameters:
instanceReference
- an existingHierarchicalSOPInstanceReference
for this image
-
-
Method Details
-
getReferencedFrameNumber
Get the Referenced Frame Number.
- Returns:
- the Referenced Frame Number, or null
-
toString
- Overrides:
toString
in classHierarchicalSOPInstanceReference
-