Class ImageLibrary
- Direct Known Subclasses:
CrossSectionalImageLibrary
,ProjectionXRayImageLibrary
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CompositeInstanceContext
protected Map
<String, ImageLibrary.ImageLibraryEntry> -
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty Image Library.ImageLibrary
(AttributeList list) Construct an Image Library by extracting it from an existing DICOM SR instance.ImageLibrary
(ContentItem imageLibraryContainer, AttributeList list) Construct an Image Library by extracting it from an existing DICOM SR instance.ImageLibrary
(Set<File> files) Create an SR Image Library from a bunch of DICOM image instances. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addImage
(AttributeList list) Create and add an SR Image Library entry derived from a DICOM image instance.protected void
constructImageLibrary
(ContentItem imageLibraryContainer, AttributeList list) Construct an Image Library by extracting it from an existing DICOM SR instance.static ContentItem
Find the Image Library contained within an SR content tree.getCommonInstanceReferenceModuleReferencedSeriesSequence
(String studyInstanceUID) Build a hierarchical evidence sequence for the current Image Library content.protected Map
<String, HierarchicalSOPInstanceReference> Get the Image Library as an SR fragment.static void
Create an SR Image Library from a bunch of DICOM image instances.makeImageLibraryEntry
(ContentItemFactory.ImageContentItem imageContentItem, Map<String, HierarchicalSOPInstanceReference> hierarchicalSOPInstanceReferencesIndexedBySOPInstanceUID) static ImageLibrary
Extract the Image Library from a DICOM SR instance.toString()
void
void
-
Field Details
-
entriesIndexedBySOPInstanceUID
-
compositeInstanceContext
-
-
Constructor Details
-
ImageLibrary
public ImageLibrary()Construct an empty Image Library.
-
ImageLibrary
Construct an Image Library by extracting it from an existing DICOM SR instance.
Searches the content tree for the Image Library CONTAINER content item.
- Parameters:
list
- the attributes comprising the DICOM SR instance containing the Image Library- Throws:
DicomException
- if error in DICOM encoding
-
ImageLibrary
Construct an Image Library by extracting it from an existing DICOM SR instance.
- Parameters:
imageLibraryContainer
- the content item that is the Image Library CONTAINERlist
- the attributes comprising the DICOM SR instance containing the Image Library
-
ImageLibrary
Create an SR Image Library from a bunch of DICOM image instances.
Adds a new series (instance UID) to the existing study (instance UID).
- Parameters:
files
- the filenames and/or folder names of files containing the input image files- Throws:
DicomException
- if error in DICOM encodingIOException
- if error reading a file
-
-
Method Details
-
makeImageLibraryEntry
public ImageLibrary.ImageLibraryEntry makeImageLibraryEntry(ContentItemFactory.ImageContentItem imageContentItem, Map<String, HierarchicalSOPInstanceReference> hierarchicalSOPInstanceReferencesIndexedBySOPInstanceUID) -
makeImageLibraryEntry
public ImageLibrary.ImageLibraryEntry makeImageLibraryEntry(AttributeList list) throws DicomException - Throws:
DicomException
-
toString
-
getCommonInstanceReferenceModuleReferencedSeriesSequence
public SequenceAttribute getCommonInstanceReferenceModuleReferencedSeriesSequence(String studyInstanceUID) throws DicomException - Throws:
DicomException
-
getHierarchicalEvidenceSequence
Build a hierarchical evidence sequence for the current Image Library content.
This contains the Study and Series Instance UIDs and is required for most SR IODs.
- Returns:
- a CurrentRequestedProcedureEvidenceSequence listing all the referenced instances
- Throws:
DicomException
- if error in DICOM encoding
-
findImageLibraryContainer
Find the Image Library contained within an SR content tree.
The Image Library is identified by the ("111028","DCM","Image Library") concept name for the content item.
- Parameters:
node
- the content item to being the search at (e.g., the root node)- Returns:
- the content item that is the Image Library CONTAINER
-
getHierarchicalSOPInstanceReferencesIndexedBySOPInstanceUID
protected Map<String,HierarchicalSOPInstanceReference> getHierarchicalSOPInstanceReferencesIndexedBySOPInstanceUID(AttributeList list) -
constructImageLibrary
Construct an Image Library by extracting it from an existing DICOM SR instance.
- Parameters:
imageLibraryContainer
- the content item that is the Image Library CONTAINERlist
- the attributes comprising the DICOM SR instance containing the Image Library
-
getStructuredReportFragment
Get the Image Library as an SR fragment.
Has side effect of adding the fragment to the parent if the parent is not null.
- Parameters:
parent
- the parent CONTAINER content item (usually the root content item)- Returns:
- a new ContainerContentItem with ImageContentItem children
- Throws:
DicomException
- if error in DICOM encoding
-
getStructuredReport
- Throws:
DicomException
-
getAttributeList
- Throws:
DicomException
-
addContributingEquipmentSequence
- Throws:
DicomException
-
write
- Throws:
DicomException
IOException
-
write
- Throws:
DicomException
IOException
-
read
Extract the Image Library from a DICOM SR instance.
- Parameters:
filename
- the DICOM SR instance containing the Image Library- Returns:
- an instance of the ImageLibrary class representing the Image Library content encoded in the DICOM SR file
- Throws:
DicomException
- if error in DICOM encodingIOException
- if error reading the file
-
addImage
Create and add an SR Image Library entry derived from a DICOM image instance.
Requires that a SOP Instance UID be present in the supplied image instance, to be used to index the entries.
- Parameters:
list
- the list of attributes of the image instance- Returns:
- the new ImageLibraryEntry added to this ImageLibrary, or null if no SOP Instance UID is present in the supplied image instance
- Throws:
DicomException
- if error in DICOM encoding
-
main
Create an SR Image Library from a bunch of DICOM image instances.
Adds a new series (instance UID) to the existing study (instance UID).
- Parameters:
arg
- the path for the SR Image Library output, then the filenames and/or folder names of files containing the input image files
-