public class HierarchicalImageReference extends HierarchicalSOPInstanceReference
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.
Modifier and Type | Field and Description |
---|---|
protected String |
referencedFrameNumber |
seriesInstanceUID, sopClassUID, sopInstanceUID, studyInstanceUID
Constructor and Description |
---|
HierarchicalImageReference(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.
|
Modifier and Type | Method and Description |
---|---|
String |
getReferencedFrameNumber()
Get the Referenced Frame Number.
|
String |
toString() |
addToHierarchicalReferencesToSOPInstances, findHierarchicalReferencesToSOPInstances, findHierarchicalReferencesToSOPInstancesInStructuredReport, getSeriesInstanceUID, getSOPClassUID, getSOPInstanceUID, getStudyInstanceUID, main, toString
protected String referencedFrameNumber
public HierarchicalImageReference(HierarchicalSOPInstanceReference instanceReference)
Construct an instance of a reference to an image, with its hierarchy.
instanceReference
- an existing HierarchicalSOPInstanceReference
for this imagepublic HierarchicalImageReference(HierarchicalSOPInstanceReference instanceReference, String referencedFrameNumber)
Construct an instance of a reference to an image, with its hierarchy.
instanceReference
- an existing HierarchicalSOPInstanceReference
for this imagereferencedFrameNumber
- the Referenced Frame Numberpublic HierarchicalImageReference(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID)
Construct an instance of a reference to an image, with its hierarchy.
studyInstanceUID
- the Study Instance UIDseriesInstanceUID
- the Series Instance UIDsopInstanceUID
- the SOP Instance UIDsopClassUID
- the SOP Class UIDpublic HierarchicalImageReference(String studyInstanceUID, String seriesInstanceUID, String sopInstanceUID, String sopClassUID, String referencedFrameNumber)
Construct an instance of a reference to an image, with its hierarchy.
studyInstanceUID
- the Study Instance UIDseriesInstanceUID
- the Series Instance UIDsopInstanceUID
- the SOP Instance UIDsopClassUID
- the SOP Class UIDreferencedFrameNumber
- the Referenced Frame Numberpublic String getReferencedFrameNumber()
Get the Referenced Frame Number.
public String toString()
toString
in class HierarchicalSOPInstanceReference