Package org.dcm4che.typeddicom.dataelements

Class ReferencedImageSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.dcm4che.typeddicom.SequenceWrapper<ReferencedImageSequence,ReferencedImageSequence.Item>

org.dcm4che.typeddicom.dataelements.ReferencedImageSequence

All Implemented Interfaces:

Iterable<ReferencedImageSequence.Item>, Collection<ReferencedImageSequence.Item>, List<ReferencedImageSequence.Item>

public class ReferencedImageSequence
extends SequenceWrapper<ReferencedImageSequence,ReferencedImageSequence.Item>

Name: Referenced Image Sequence
Keyword: ReferencedImageSequence
Tag: (0008,1140)
Value Representation: SQ
Value Multiplicity: 1

• Described in the contexts:
  • XA/XRF Presentation State Presentation Module > Multi-frame Presentation Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Sequence of Items where each Item provides reference to a selected set of Image SOP Class/SOP Instance pairs that are defined in the DICOM Standard Part 3 - Section C.11.11.

  One or more Items shall be included in this Sequence.

  Required if display sequences in this Item do not apply to all the images listed in the DICOM Standard Part 3 - Section C.11.11.

  
  
• Described in the contexts:
  • Presentation State Relationship Macro > Referenced Series Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1
  Attribute Description:

  The set of images and frames to which the Presentation applies. These shall be of the Study defined by Study Instance UID (0020,000D) and the Series defined by Series Instance UID (0020,000E).

  One or more Items shall be included in this Sequence.

  The referenced SOP Class shall be the same for all Images in any Item of this Referenced Series Sequence (0008,1115).

  
  
• Described in the contexts:
  • Spatial Fiducials Module > Fiducial Set Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Identifies the set of images in which the fiducials are located.

  One or more Items shall be included in this Sequence.

  Required if Frame of Reference UID (0020,0052) is absent. May be present otherwise.

  All referenced images shall have the same Frame of Reference UID if present in the images.

  
  
• Described in the contexts:
  • Visual Evaluation Result Macro > Visual Evaluation Test Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type:
  Attribute Description:

  Reference to the Image Instance containing the test pattern presented for visual evaluation.

  Only a single Item shall be included in this Sequence.

  Required if Test Pattern Code Sequence (0028,702C) is absent in this Item. May be present otherwise.

  
  
• Described in the contexts:
  • Presentation State Blending Module > Blending Sequence > Softcopy VOI LUT Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Sequence of Items identifying images that are defined in the enclosing Item of Blending Sequence (0070,0402), to which this VOI LUT or Window Center and Width applies.

  One or more Items shall be included in this Sequence.

  Required if the VOI LUT transformation in this Item does not apply to all the images and frames in the enclosing Item of Blending Sequence (0070,0402).

  
  
• Described in the contexts:
  • Enhanced US Image Module > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 3
  Attribute Description:

  A Sequence that references other images significantly related to this image. (e.g., an image containing spatially related frames)

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Real World Value Mapping Module > Referenced Image Real World Value Mapping Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1
  Attribute Description:

  A Sequence listing the images to which the mapping applies.

  One or more Items shall be included in this Sequence.

  
  
• Described in the contexts:
  • Volume Cropping Module > Volume Cropping Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Instances of the Segmentation Storage SOP Class (1.2.840.10008.5. 1.4.1.1.66.4) containing segments specifying the included or excluded source volume data.

  Each referenced Segmentation Instance shall have Segmentation Type (0062,0001) value of BINARY and shall share a Frame of Reference with one or more Input Volumes.

  One or more Items shall be included in this Sequence.

  Required if Volume Cropping Method (0070,1302) has a value of INCLUDE_SEG or EXCLUDE_SEG.

  Note

  Surface Segmentation Instances are not referenced by this element.

  
  
• Described in the contexts:
  • General Reference Module > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 3
  Attribute Description:

  Other images significantly related to this image (e.g., post-localizer CT image or Mammographic biopsy or partial view images).

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Image Acquisition Results Module > Performed Series Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type:
  Attribute Description:

  A Sequence that provides reference to Composite SOP Instances created during the acquisition of the procedure step.

  Zero or more Items shall be included in this Sequence.

  Note

  The use of Referenced Image Sequence is historical, and in this context it allows the reference of any Composite SOP Instance.

  
  
• Described in the contexts:
  • Graphic Annotation Module > Graphic Annotation Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  The subset of images and frames listed in the DICOM Standard Part 3 - Section C.11.11, to which this graphic annotation applies.

  One or more Items shall be included in this Sequence.

  Required if graphic annotations in this Item do not apply to all the images and frames listed in the DICOM Standard Part 3 - Section C.11.11.

  
  
• Described in the contexts:
  • Deformable Spatial Registration Module > Deformable Registration Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Identifies the set of images registered in this Item.

  One or more Items shall be included in this Sequence.

  Required if the registration applies to a subset of images within the specified Source Frame of Reference UID (0064,0003). All referenced images shall be in the same spatial Frame of Reference.

  
  
• Described in the contexts:
  • Structured Display Image Box Module > Structured Display Image Box Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 2C
  Attribute Description:

  Reference to the Image SOP Instances, or frames from multi-frame Image SOP Instances, to be displayed in this Image Box.

  Zero or more Items shall be included in this Sequence.

  Required if Referenced Presentation State Sequence (0008,9237), Referenced Stereometric Instance Sequence (0008,1134), and Referenced Instance Sequence (0008,114A) are not present.

  See DICOM Standard Part 3 - Section C.11.17.1.2.

  
  
• Described in the contexts:
  • Encapsulated Document Module > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 3
  Attribute Description:

  The set of Image Instances referenced in the encapsulated document.

  One or more Items are permitted in this Sequence.

  
  
• Described in the contexts:
  • Microscopy Bulk Simple Annotations Module > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  The image to which this Annotation object applies.

  Only a single Item shall be included in this Sequence.

  Required if Annotation Coordinate Type (006A,0001) is 2D. May be present otherwise.

  
  
• Described in the contexts:
  • Spatial Fiducials Module > Fiducial Set Sequence > Fiducial Sequence > Graphic Coordinates Data Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1
  Attribute Description:

  A Sequence that specifies the image containing the fiducial's graphic coordinates.

  Only a single Item shall be included in this Sequence.

  Shall be an image within the set of the images in the Referenced Image Sequence (0008,1140) of the encapsulating Fiducial Set Sequence (0070,031C) Item.

  
  
• Described in the contexts:
  • XA/XRF Presentation State Shutter Module > Frame Display Shutter Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Sequence of Items where each Item provides reference to a selected set of Image SOP Class/SOP Instance pairs that are defined in the DICOM Standard Part 3 - Section C.11.11.

  One or more Items shall be included in this Sequence.

  Required if shutters in this Item do not apply to all the images and frames listed in the DICOM Standard Part 3 - Section C.11.11.

  
  
• Described in the contexts:
  • X-Ray Image Module > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Other images significantly related to this image. Shall be present if Image Type (0008,0008) Value 3 is BIPLANE A or BIPLANE B. May be present otherwise.

  One or more Items shall be included in this Sequence.

  See DICOM Standard Part 3 - Section C.8.7.1.1.13.

  
  
• Described in the contexts:
  • Referenced Image Macro > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 2
  Attribute Description:

  The set of images or other composite SOP Instances used to plan the acquisition, if any, and other significant related images. See DICOM Standard Part 3 - Section C.7.6.16.2.5.1 for further explanation. Zero or more Items shall be included in this Sequence.

  
  
• Described in the contexts:
  • VL Image Module > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  A Sequence that references other images significantly related to this image.

  One or more Items are permitted in this Sequence.

  Required if Image Type (0008,0008) Value 3 is present and has a value of "STEREO L" or "STEREO R". May also be present otherwise. See DICOM Standard Part 3 - Section C.8.12.1.1.7.

  
  
• Described in the contexts:
  • XA/XRF Presentation State Mask Module > Mask Subtraction Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  A reference to a selected Image.

  Required if DICOM Standard Part 3 - Section C.11.11 references more than one SOP Instance.

  Only a single Item shall be included in this Sequence.

  
  
• Described in the contexts:
  • Advanced Blending Presentation State Module > Advanced Blending Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  The set of images comprising this input. One or more Items shall be included in this Sequence.

  Required if the input is not the entire set of Instances in the Series.

  
  
• Described in the contexts:
  • Spatial Registration Module > Registration Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  Identifies the set of images of the referenced data, registered in this Item.

  One or more Items shall be included in this Sequence.

  Required if Frame of Reference UID (0020,0052) is absent. May be present otherwise.

  
  
• Described in the contexts:
  • Softcopy VOI LUT Module > Softcopy VOI LUT Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  The subset of images and frames listed in the DICOM Standard Part 3 - Section C.11.11, to which this VOI LUT or Window Center and Width applies.

  One or more Items shall be included in this Sequence.

  Required if the VOI LUT transformation in this Item does not apply to all the images and frames listed in the DICOM Standard Part 3 - Section C.11.11.

  
  
• Described in the contexts:
  • Displayed Area Module > Displayed Area Selection Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  The subset of images and frames listed in the DICOM Standard Part 3 - Section C.11.11, to which this displayed area selection applies.

  One or more Items shall be included in this Sequence.

  Required if the displayed area selection in this Item does not apply to all the images and frames listed in the DICOM Standard Part 3 - Section C.11.11.

  
  
• Described in the contexts:
  • Related Information Entities Macro > Referenced Study Sequence > Referenced Series Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 3
  Attribute Description:

  Image SOP Instances which are relevant in the invocation context.

  One or more Items are permitted for this Sequence.

  
  
• Described in the contexts:
  • Volumetric Presentation State Relationship Module > Volumetric Presentation Input Set Sequence > Referenced Image Sequence
  as follows:
  Attribute Name: Referenced Image Sequence
  Type: 1C
  Attribute Description:

  The set of images comprising this input volume. One or more Items shall be included in this Sequence.

  See DICOM Standard Part 3 - Section C.11.23.1 for constraints on objects referenced by this Sequence.

  Required if Presentation Input Type (0070,1202) has a value of VOLUME.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReferencedImageSequence.Builder<SELF extends ReferencedImageSequence.Builder<SELF,T>,T extends ReferencedImageSequence.Holder>
static interface	ReferencedImageSequence.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Image Sequence" (see ReferencedImageSequence)
static class	ReferencedImageSequence.Item
static class	ReferencedImageSequence.SimpleHolder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from class org.dcm4che.typeddicom.SequenceWrapper

VALUE_REPRESENTATION

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ReferencedImageSequence(org.dcm4che3.data.Sequence sequence)	Creates a new Referenced Image Sequence object which wraps the provided sequence.

Method Summary

Modifier and Type	Method	Description
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.SequenceWrapper

add, equals, get, getSequence, getValueRepresentation, hashCode, remove, set, size, toString

Methods inherited from class java.util.AbstractList

add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ReferencedImageSequence

public ReferencedImageSequence(org.dcm4che3.data.Sequence sequence)

Creates a new Referenced Image Sequence object which wraps the provided sequence.

Parameters:

sequence - The Sequence object to be linked.

Method Details

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in class SequenceWrapper<ReferencedImageSequence,ReferencedImageSequence.Item>

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in class SequenceWrapper<ReferencedImageSequence,ReferencedImageSequence.Item>

Returns:

The DICOM Tag of the wrapped DICOM sequence.