DICOM PS3.3 2024e - Information Object Definitions |
---|
Table C.23.3-1 specifies the Attributes of the Hanging Protocol Display Module, which describe operations (filter, reformat, sort, presentation intent), layout and interactions for a Hanging Protocol. See Annex V “Hanging Protocols (Informative)” in PS3.17 for further explanation.
Table C.23.3-1. Hanging Protocol Display Module Attributes
Sequence that describes one or more display sets used to present the Image Sets defined in the Image Sets Sequence (0072,0020). One or more Items shall be included in this Sequence. See Section C.23.3.1. |
|||
A monotonically increasing integer, starting from 1, incrementing by 1, unique within the Hanging Protocol Instance. It shall be used to identify linked display sets in the Display Set Scrolling Group (0072,0212). |
|||
Description of the objective of the display set defined by this Sequence Item. |
|||
Positive integer value that designates this Display Set as part of a specific presentation group. All Display Sets with the same Display Set Presentation Group (0072,0204) value shall be displayed at the same time. The value 1 shall indicate that this Display Set is part of the initial presentation group. Subsequent values incrementing by 1 shall imply successive temporal ordering of display. |
|||
Image Set Number (0072,0032) value from a Time Based Image Sets Sequence (0072,0030) Item within the Image Sets Sequence (0072,0020) Item that is selected for display by this Display Set. |
|||
Sequence that defines the image boxes for this Display Set. Only a single Item shall be included in this Sequence unless Image Box Layout Type (0072,0304) is TILED, in which case one or more Items shall be included in this Sequence. |
|||
A monotonically increasing integer that identifies the order of image boxes for scrolling, starting from 1, incrementing by 1, unique within a Display Sets Sequence (0072,0200) Item. |
|||
Exactly four unitless floating point values indicating the rectangular coordinate position of the image box within the overall bounding box that encompasses all the display space (across all screens). See Section C.23.2.1.1. |
|||
Type of layout of the image box. All types except for TILED are single rectangles containing a single frame of image pixel data. The types are primarily distinguished by their interaction technique. Defined Terms:
|
|||
Positive integer defining the horizontal Image Box tile dimension; the number of columns. Required if the value of Image Box Layout Type (0072,0304) is TILED. |
|||
Positive integer defining the vertical Image Box tile dimension; the number of rows. Required if the value of Image Box Layout Type (0072,0304) is TILED. |
|||
Required if the value of Image Box Layout Type (0072,0304) is TILED, and the value of Image Box Tile Horizontal Dimension (0072,0306) or Image Box Tile Vertical Dimension (0072,0308) is greater than 1. |
|||
Defines the type of small increment scrolling to be applied to this Image Box. Required if the value of Image Box Layout Type (0072,0304) is TILED, and the value of Image Box Tile Horizontal Dimension (0072,0306) or Image Box Tile Vertical Dimension (0072,0308) is greater than 1. Scrolling is not specified if zero length. Enumerated Values:
|
|||
Defines the positive integer number of pages, rows, columns, or images per small increment scroll, based on the values of Image Box Small Scroll Type (0072,0312) and Image Box Scroll Direction (0072,0310). The value applies to both forward and backward scrolling. Required if Image Box Small Scroll Type (0072,0312) is present with a value. |
|||
Defines the type of large increment scrolling to be applied to this Image Box. Required if the value of Image Box Layout Type (0072,0304) is TILED, and the value of Image Box Tile Horizontal Dimension (0072,0306) or Image Box Tile Vertical Dimension (0072,0308) is greater than 1. Enumerated Values:
|
|||
Defines the positive integer number of pages, rows, columns, or images per large increment scroll, based on the values of Image Box Large Scroll Type (0072,0316) and Image Box Scroll Direction (0072,0310). The value applies to both forward and backward scrolling. Required if Image Box Large Scroll Type (0072,0316) is present with a value. |
|||
If this Image Box overlaps in spatial position with others, this Attribute indicates the layer of this Image Box in relation to the others. The value shall be a positive integer in the range 1 to 100, where 1 = top and 100 = bottom. If this Attribute is not present, then the expected behavior is not defined. |
|||
Describes the preferred playback sequencing for the Image Box. Overrides any Preferred Playback Sequencing (0018,1244) value in the image objects being displayed. Required if the value of Image Box Layout Type (0072,0304) is CINE. |
|||
Recommended rate at which the frames of a Multi-frame Image shall be displayed, in frames/second. Shall have a value greater than zero. Overrides any Recommended Display Frame Rate (0008,2144) value in the image objects being displayed. Required if the value of Image Box Layout Type (0072,0304) is CINE and if Cine Relative to Real-Time (0072,0330) is not present. |
|||
A positive unitless floating point numeric factor equal to playback rate divided by acquisition rate. Required if the value of Image Box Layout Type (0072,0304) is CINE and if Recommended Display Frame Rate (0008,2144) is not present. |
|||
Sequence that defines filter criteria to be applied to the image set identified by Image Set Number (0072,0032). Zero or more Items shall be included in this Sequence. See Section C.23.3.1.1. |
|||
Category of the filter operation. See Section C.23.3.1.1. |
|||
Operation to be applied based on the presence or absence of the Attribute represented by Selector Attribute (0072,0026) in each image of the Image Set. Required if Selector Attribute (0072,0026) is present and Filter-by Operator (0072,0406) is not present. |
|||
Data Element Tag of an Attribute from an Image IOD to use as a filter. See Section C.23.3.1.1 for potential Attributes. |
|||
The Value Representation of Selector Attribute (0072,0026). Required if Selector Attribute (0072,0026) or Filter-by Category (0072,0402), and Filter-by Operator (0072,0406) are present. |
|||
>>Include Table C.23.4-1 “Hanging Protocol Selector Attribute Context Macro Attributes” |
|||
>>Include Table C.23.4-2 “Hanging Protocol Selector Attribute Value Macro Attributes” |
|||
Positive integer identifying which value of the Attribute identified by Selector Attribute (0072,0026) is to be used for filtering. The value 1 identifies the first value. The value zero identifies any value. Required if Selector Attribute (0072,0026) and Filter-by Operator (0072,0406) are present. |
|||
Operation to be applied between the value(s) in the Hanging Protocol Selector Attribute Value Macro ("selector"), and the value(s) of the Attribute identified by Selector Attribute (0072,0026) (or the value implied by the Filter-by Category (0072,0402)) in each image of the Image Set. See Section C.23.3.1.1. Required if Filter-by Category (0072,0402) is present, or if Selector Attribute (0072,0026) is present and Filter-by Attribute Presence (0072,0404) is not present. Enumerated Values:
|
|||
Specifies the behavior of the Filter-by Operator (0072,0406) when Selector Attribute (0072,0026) is not available in the image or does not contain a value specified by Selector Value Number (0072,0028). If this Attribute is not present in this Sequence Item, MATCH shall be assumed. Shall be ignored if Filter-by Operator (0072,0406) is not present. |
|||
Sequence that defines sorting criteria to be applied to the result of filter and reformat operations, to define the order in which to present the images in the Image Boxes. Zero or more Items shall be included in this Sequence. See Section C.23.3.1.2. |
|||
Data Element Tag of an Attribute from an Image IOD to be used for sorting. See Section C.23.3.1.2 for potential Attributes. |
|||
>>Include Table C.23.4-1 “Hanging Protocol Selector Attribute Context Macro Attributes” |
|||
Positive integer identifying which value of the Attribute identified by Selector Attribute (0072,0026) is to be used for sorting. The value of 1 identifies the first value. Shall not be zero. |
|||
Category of the sorting operation. See Section C.23.3.1.2. |
|||
Sorting direction to be applied to the value(s) in the image set of the Attribute identified by Selector Attribute (0072,0026) or Sort-by Category (0072,0602). |
|||
Type of blending of superimposed and underlying images from the image set, performed before reformatting. See Section C.23.3.1.3. |
|||
The desired thickness of the reformatted images in millimeters. Required if value of Reformatting Operation Type (0072,0510) is SLAB or MPR. May be present otherwise. |
|||
The desired spacing of the reformatted images in millimeters. The spacing is measured from the center-to-center of each reconstructed image. Required if value of Reformatting Operation Type (0072,0510) is SLAB or MPR. May be present otherwise. |
|||
Initial view of the reformatted images. Required if the value of Reformatting Operation Type (0072,0510) is MPR or 3D_RENDERING. May be present otherwise. |
|||
Describes the intended 3D rendering type. One or more values shall be present. The first value shall not be zero length. Required if the value of Reformatting Operation Type (0072,0510) is 3D_RENDERING: Additional values may be used to identify implementation specific sub-types. |
|||
Patient direction of the rows and columns of the images, as intended for display. See Section C.23.3.1.4. |
|||
Indicates direction in which to horizontally justify the image within a viewport that is not the same shape (aspect ratio) as the image. |
|||
Indicates direction in which to vertically justify the image within a viewport that is not the same shape (aspect ratio) as the image. |
|||
Expected value of interest transformation for display (e.g., Window Center and Window Width or VOI LUT). |
|||
A category of pseudo-color palette choice to be applied after application of the VOI LUT. If this Attribute is not present, a pseudo-color palette shall not be applied. Defined Terms are the values of Content Label (0070,0080) in the list of standard color palettes defined in PS3.6 Well-Known Color Palettes. |
|||
Reference to a Color Palette Storage Instance to be applied after application of the VOI LUT. Only a single Item shall be included in this Sequence. The Referenced SOP Class UID (0008,1150) shall be "1.2.840.10008.5.1.4.39.1". If the value of Pseudo-Color Type (0072,0704) is a reference to the Content Label (0070,0080) of a standard palette, the Referenced SOP Instance UID (0008,1155) shall be the corresponding Well-known SOP Instance UID defined in PS3.6. Required if Pseudo-Color Type (0072,0704) is a reference to a standard palette. May be present otherwise if Pseudo-Color Type (0072,0704) is present. |
|||
>>Include Table 10-11 “SOP Instance Reference Macro Attributes” |
|||
Whether or not to invert the rendered luminance of the displayed values. See Section C.23.3.1.4. Enumerated Values: Note
|
|||
Indicates whether or not to display images with the physical size of the rendered image pixel the same on the screen as specified in the image Attributes, unless overridden by a Presentation State Instance. |
|||
Indicates whether or not to display Items from the Graphic Annotation Sequence (0070,0001) in an applied Presentation State, and the Attributes of the Overlay Plane Module in the image objects or applied Presentation State. |
|||
Indicates whether or not to display patient and Study identification information. |
|||
Indicates whether or not to display image acquisition technique information. |
|||
Description of the intent of the Display Set Presentation Group (0072,0204). If present, shall have the same value in all Sequence Items assigned the same value for Display Set Presentation Group (0072,0204). |
|||
If one or more Image Sets identified by Image Set Number (0072,0032) in the Display Sets Sequence (0072,0200) Items is not available, indicate whether or not to maintain the expected layout in the absence of complete Image Sets. Enumerated Values: If this Attribute is zero length, then the expected behavior is not defined. |
|||
Each Item of this Attribute identifies a group of Display Sets to which synchronized scrolling is to be applied. One or more Items are permitted in this Sequence. The dimensions along which the synchronization occurs shall be those specified in the Sorting Operations Sequence (0072,0600). |
|||
Multi-valued list of two or more Display Set Number (0072,0202) values. Indicates that the images within the specified Display Sets are scrolled in parallel, to maintain the established synchronization. |
|||
Describes a geometric relationship between Display Sets for the purpose of static or interactive localization or navigation. |
|||
Display Set Number (0072,0202) of the Display Set where the geometric relationship to the Reference Display Sets (0072,0218) is graphically depicted. Required if there is a one-way interaction such that the location of the Reference Display Sets is indicated on or controlled by the Navigation Display Set. |
|||
One or more Display Set Number (0072,0202) values. If Navigation Display Set is present, shall list those Display Sets that are controlled by or indicated on the Navigation Display Set. If Navigation Display Set is absent, shall indicate that all of the Reference Display Sets cross-reference each other. |
The Attributes of a Display Sets Sequence (0072,0200) Item shall be applied to the image set represented by the value of Image Set Number (0072,0032) in the following order:
The Items in the Filter Operations Sequence (0072,0400) determine which subset of the images in the identified Image Set are to be displayed in the associated Display Set image boxes. If there are multiple Items in the Filter Operations Sequence (0072,0400), the filter operations shall be applied in Item order, and the output of the preceding filter shall serve as the input to the succeeding filter (i.e., an AND operation). See Section C.23.4.2.1.1 and Section C.23.4.2.1.2 for additional details on matching strings and coded values.
When Filter-by Category (0072,0402) has a value of IMAGE_PLANE, Selector Attribute VR (0072,0050) shall have a value of "CS", and abstract Enumerated Values shall be used for the value of the associated Selector CS Value (0072,0062) Attribute, which may be computed from the values of Image Orientation (Patient) (0020,0037) or Patient Orientation (0020,0020).
The MEMBER_OF and NOT_MEMBER_OF values of Filter-by Operator (0072,0406) are then applicable.
Cross-sectional images do not normally contain a categorical description of the image plane, but rather only a patient-relative row and column direction cosines that are unit vectors. The category of image plane can be determined first by categorizing the row and column major directions (or detecting if the orientation is oblique according to a pre-specified threshold), and then using those categories to select a plan category.
The following pseudo-code can be used to determine the major axis (R or L, A or P, H or F) from a single direction cosine that is an (x,y,z) tuple (as defined in Section C.7.6.2.1.1):
Having determined the major axis of the row and column, the category of plane can be obtained from a table lookup:
Alternatively, one can obtain a single vector that is the normal to the orientation (cross product of the row and column unit vectors), then find which of the x, y and z components has the maximum absolute value that is above threshold; if x then SAGITTAL, if y then CORONAL, if z then TRANSVERSE; if all of the components are below threshold then the orientation is OBLIQUE.
Since it is also necessary to determine whether or not to flip or rotate the image into the preferred orientation (as specified by Display Set Patient orientation (0072,0700)) for the category of plane (e.g., sagittals are normally viewed with row direction posteriorly and column direction towards the feet), the categorical row and column direction to use can be obtained as above, additional accounting for the sign of the direction cosine, e.g.:
An application that is applying a Hanging Protocol Instance shall support any value for Selector Attribute (0072,0026). The Image Set Selector Usage Flag (0072,0024) specifies whether or not the image is included in the filter output when the Attribute or value identified by Selector Attribute (0072,0026) is not available in an image. The Attributes of the Hanging Protocol Selector Attribute Context Macro specify whether Selector Attribute (0072,0026) is contained in a Sequence, Functional Group Sequence, or Private Group.
The following Attributes from image IODs are examples of some possible values for Selector Attribute (0072,0026) of Filter Operations Sequence (0072,0400). This is not a complete list:
For a Multi-frame Image set, it is the responsibility of the application to apply the filter operations to individual frames within a Multi-frame Image Instance in the image set, versus multiple Single-frame Image Instances in the image set that represent individual frames.
The Items in the Sorting Operations Sequence (0072,0600) define the order in which the images resulting from the filter and reformat operations on the Image Set are to be displayed in the associated Image Boxes of the Display Set. The sorting criteria may include the value of a numeric, date, or time Attribute that is expected to be present in each of the image objects in the filtered Image Set, and/or an abstract sorting category. A sorting direction shall be associated with each sorting criterion. If a textual Attribute is used for sorting, then the INCREASING sorting direction indicates alphabetical order, and DECREASING indicates reverse alphabetical order.
If a Code Sequence Attribute is used for sorting, then Code Meaning (0008,0104) shall be sorted alphabetically. If a string numeric Attribute is used for sorting (VR of IS or DS), then sorting shall be on the numeric value, and padding shall be ignored. When sorting by date or time Attribute, then sorting shall be on the temporal value, not the alphabetic string.
If there are multiple Items in the Sorting Operations Sequence (0072,0600), then the sorting operations shall be applied in Item order. The least rapidly varying Attribute for the sorting operation shall be the first Item in the Sequence.
For example, a Sorting Operations Sequence (0072,0600) with two Items:
results in the following order, based on these Attribute values in the image objects:
When the Sort-by Category (0072,0602) is used with a value of ALONG_AXIS, such as for CT, MR or other cross-sectional image sets, the sorting operation is computed from the values Image Position (Patient) (0020,0032) and Image Orientation (Patient) (0020,0037) in the image objects.
For the image set to be displayed, a "dominant axis" of the set shall be determined. The dominant axis is the normal to Image Orientation (Patient) (0020,0037) (assuming all selected images are parallel), computed as the dot product in a right-handed coordinate system (see Section C.7.6.2.1.1). The INCREASING direction for ALONG_AXIS of the image set shall be in the positive direction along the dominant axis. The DECREASING direction shall be in the negative direction along that axis.
When the Sort-by Category (0072,0602) is used with a value of BY_ACQ_TIME, the sorting operation is computed from appropriate values in the image objects (e.g., Frame Acquisition DateTime, Acquisition Time, Content Time, Acquisition DateTime), since the specific Attribute used may vary from one Image Instance or SOP Class to another, yet the Hanging Protocol Instance may be generally applicable.
An application that is applying a Hanging Protocol Instance shall support any value for Selector Attribute (0072,0026), provided that it is present in the referenced Image Set. The Attributes of the Hanging Protocol Selector Attribute Context Macro specify whether Selector Attribute (0072,0026) is contained in a Sequence, Functional Group Sequence or Private Group.
The following Attributes from image IODs are examples of some possible values for Selector Attribute (0072,0026) of Sorting Operations Sequence (0072,0600). This is not a complete list:
For a Multi-frame Image set, it is the responsibility of the application to apply the sorting operations to individual frames within a Multi-frame Image Instance in the image set, versus multiple Single-frame Image Instances in the image set that represent individual frames.
A Blending Operation Type (0072,0500) of COLOR implies that the filtered selected image set contains two sets of images appropriate for blending, such as CT and PET images defined in the same Frame of Reference or associated by a spatial registration object. The decision as to which subset are the underlying images and which subset are the superimposed images is left to the discretion of the display application. There is no mechanism to explicitly specify the two subsets.
The relative opacity and color-related aspects of blending are not specified by the Hanging Protocol, and are left to the discretion of the application.
The Attributes that indicate the presentation intent for each Display Set of a Hanging Protocol Instance are: Display Set Patient Orientation (0072,0700), VOI Type (0072,0702), Pseudo-color Type (0072,0704), Show Grayscale Inverted (0072,0706), Show Image True Size Flag (0072,0710), Show Graphic Annotation Flag (0072,0712), Show Patient Demographics Flag (0072,0714), and Show Acquisition Techniques Flag (0072,0716).
If one Presentation State Instance is defined for the images that are to be displayed, then it shall be applied.
If more than one Presentation State Instance is defined for the images that are to be displayed, then the presentation intent Attributes, if present, shall be used to select the closest matching Presentation State Instance to apply (for example, matching VOI Type (0072,0702) in the Hanging Protocol Instance with Window Center & Width Explanation in the Presentation State Instance). Otherwise, the application shall determine which Presentation State Instance to apply.
If no Presentation State Instance is defined for the images that are to be displayed, then the presentation intent Attributes, if present, shall be applied (for example, matching VOI Type (0072,0702) in the Hanging Protocol Instance with Window Center & Width Explanation in the Image). Otherwise, the display related information in the Image Instances shall be applied.
The intent of VOI Type (0072,0702) is to support generic intensity window settings for the Display Sets in a Hanging Protocol, such as lung, soft tissue, or bone for chest CT. It is expected for most other modalities that the window/center or VOI LUT values, if not provided in a Presentation State Instance, would be provided in the Image Instance rather than by intent in a Hanging Protocol Instance.
The value of Show Grayscale Inverted (0072,0706) shall override any such intent expressed in the images or associated Presentation States to which the Hanging Protocol is applied.
For example, an image may have a MONOCHROME2 Photometric Interpretation (0028,0004) and no Presentation LUT Shape (2050,0020), which implies that maximum values are displayed with maximum available luminance, but the presence of a Show Grayscale Inverted (0072,0706) value of YES in the Hanging Protocol requires maximum values to be displayed with minimum available luminance.
For example, an image may have an applicable Presentation State with a Presentation LUT Shape (2050,0020) of IDENTITY, which implies that maximum values are displayed with maximum available luminance, but the presence of a Show Grayscale Inverted (0072,0706) value of YES in the Hanging Protocol requires maximum values to be displayed with minimum available luminance.
For example, an image may have an applicable Presentation State with a Presentation LUT, in which case the minimum possible LUT output value (i.e., 0) will be interpreted as maximum available luminance if the value of Show Grayscale Inverted (0072,0706) is YES.
The intent of Display Set Patient Orientation (0072,0700) is to describe the preferred image rotation and/or flip for presentation within an image box. Each of the two values shall be an anatomic direction designated by the capital letters: A (anterior), P (posterior), R (right), L (left), H (head), F (foot), or X (unspecified). Each value of the orientation Attribute shall contain at least one of these characters. If refinements in the orientation descriptions are to be specified, then they shall be designated by one or two additional letters in each value. Within each value, the letters shall be ordered with the principal orientation designated in the first character. If the value "X" is used for one of the values, the patient direction for that value is not defined.
The first value is the patient direction to be oriented at the right side of the image box for each image. The second value is the patient direction to be positioned at the bottom of the image box for each image. The application shall use the patient orientation information of each image (if available) to compute the best rotate and/or flip operation to be applied within the display set. If the patient orientation of an image is not defined, then this Attribute shall be ignored.
DICOM PS3.3 2024e - Information Object Definitions |
---|