Package org.dcm4che.typeddicom.dataelements

Class DisplayEnvironmentSpatialPosition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DisplayEnvironmentSpatialPosition

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointDoubleMultiWrapper

public class DisplayEnvironmentSpatialPosition
extends AbstractDataElementWrapper
implements FloatingPointDoubleMultiWrapper

Name: Display Environment Spatial Position
Keyword: DisplayEnvironmentSpatialPosition
Tag: (0072,0108)
Value Representation: FD
Value Multiplicity: 4

• Described in the contexts:
  • Structured Display Annotation Module > Structured Display Text Box Sequence > Display Environment Spatial Position
  as follows:
  Attribute Name: Display Environment Spatial Position
  Type: 1
  Attribute Description:

  Exactly four dimensionless floating point values, in the range 0.0 to 1.0, indicating the rectangular coordinate position within the Display Environment of the bounding box in which Unformatted Text Value (0070,0006) is to be displayed.

  Note

  For the Basic Structured Display with a single screen, the Display Environment is coextensive with thescreen defined in the Nominal Screen Definition Sequence (0072,0102). See DICOM Standard Part 3 - Section C.11.16.

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

  Exactly four dimensionless floating point values, in the range 0.0 to 1.0, indicating the rectangular coordinate position of the Image Box within the Display Environment.

  Note

  For the Basic Structured Display with a single screen, the Display Environment is coextensive with the screen defined in the Nominal Screen Definition Sequence (0072,0102).

  See DICOM Standard Part 3 - Section C.11.17.1.1

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

  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 DICOM Standard Part 3 - Section C.23.2.1.1.

  
  
• Described in the contexts:
  • Screen Specifications Macro > Display Environment Spatial Position
  as follows:
  Attribute Name: Display Environment Spatial Position
  Type: 1
  Attribute Description:

  Exactly four dimensionless floating point values indicating the rectangular coordinate position of the screen within the overall bounding box that encompasses all the screens. See DICOM Standard Part 3 - Section C.23.2.1.1.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DisplayEnvironmentSpatialPosition.Builder<SELF extends DisplayEnvironmentSpatialPosition.Builder<SELF,T>,T extends DisplayEnvironmentSpatialPosition.Holder>
static interface	DisplayEnvironmentSpatialPosition.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Display Environment Spatial Position" (see DisplayEnvironmentSpatialPosition)
static class	DisplayEnvironmentSpatialPosition.SimpleHolder

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

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

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.FloatingPointDoubleMultiWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DisplayEnvironmentSpatialPosition()	Creates a new Display Environment Spatial Position object which wraps a new and empty Attributes object.
DisplayEnvironmentSpatialPosition(org.dcm4che3.data.Attributes attributes)	Creates a new Display Environment Spatial Position object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DisplayEnvironmentSpatialPosition	copy()	Returns a new Display Environment Spatial Position which wraps a copy of the Attributes wrapped in this Display Environment Spatial Position.
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.DataElementWrapper

exists, getValue

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

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

getValueRepresentation

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

DisplayEnvironmentSpatialPosition

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

Creates a new Display Environment Spatial Position object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DisplayEnvironmentSpatialPosition

public DisplayEnvironmentSpatialPosition()

Creates a new Display Environment Spatial Position object which wraps a new and empty Attributes object.

Method Details

copy

public DisplayEnvironmentSpatialPosition copy()

Returns a new Display Environment Spatial Position which wraps a copy of the Attributes wrapped in this Display Environment Spatial Position. (see Attributes(Attributes)

Returns:

a new Display Environment Spatial Position which wraps a copy of the Attributes wrapped in this Display Environment Spatial Position.

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.