Package org.dcm4che.typeddicom.dataelements

Class ImageBoxLayoutType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ImageBoxLayoutType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ImageBoxLayoutType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Image Box Layout Type
Keyword: ImageBoxLayoutType
Tag: (0072,0304)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Structured Display Image Box Module > Structured Display Image Box Sequence > Image Box Layout Type
  as follows:
  Attribute Name: Image Box Layout Type
  Type: 1
  Attribute Description:

  Type of layout of the Image Box. The types are primarily distinguished by their interaction technique.

  Defined Terms:

  TILED

  A scrollable array of rectangles, each containing a single frame of image pixel data.

  STACK

  A single rectangle containing a steppable single frame, intended for user-controlled stepping through the image set, usually via continuous device interaction (e.g., mouse scrolling) or by single stepping (mouse or button click).

  CINE

  A single rectangle, intended for animation where the user controls are play sequence, rate of play, and direction.

  VOLUME_VIEW

  A single rectangle, intended for volumetric display.

  VOLUME_CINE

  A single rectangle, intended for animation of a volumetric view.

  SINGLE

  A single rectangle, intended for images and objects with no defined methods of interaction.

  Note

  This value may also be used for non-image objects, such as waveforms and SR documents.

  
  
• Described in the contexts:
  • Hanging Protocol Display Module > Display Sets Sequence > Image Boxes Sequence > Image Box Layout Type
  as follows:
  Attribute Name: Image Box Layout Type
  Type: 1
  Attribute Description:

  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:

  TILED

  a scrollable array of rectangles, each containing a single frame of image pixel data.

  STACK

  a single rectangle containing a steppable single frame, intended for user-controlled stepping through the image set, usually via continuous device interaction (e.g., mouse scrolling) or by single stepping (mouse or button click).

  CINE

  a single rectangle, intended for video type play back where the user controls are play sequence, rate of play, and direction.

  PROCESSED

  intended for interactive 3D visualizations that have custom interfaces.

  SINGLE

  a single rectangle, intended for images and objects with no defined methods of interaction.

  Note

  This value may also be used for non-image objects, such as waveforms and SR documents.

  
  

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

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 interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ImageBoxLayoutType()	Creates a new Image Box Layout Type object which wraps a new and empty Attributes object.
ImageBoxLayoutType(org.dcm4che3.data.Attributes attributes)	Creates a new Image Box Layout Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ImageBoxLayoutType	copy()	Returns a new Image Box Layout Type which wraps a copy of the Attributes wrapped in this Image Box Layout Type.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

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

ImageBoxLayoutType

public ImageBoxLayoutType(org.dcm4che3.data.Attributes attributes)

Creates a new Image Box Layout Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ImageBoxLayoutType

public ImageBoxLayoutType()

Creates a new Image Box Layout Type object which wraps a new and empty Attributes object.

Method Details

copy

public ImageBoxLayoutType copy()

Returns a new Image Box Layout Type which wraps a copy of the Attributes wrapped in this Image Box Layout Type. (see Attributes(Attributes)

Returns:

a new Image Box Layout Type which wraps a copy of the Attributes wrapped in this Image Box Layout Type.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.