Package org.dcm4che.typeddicom.dataelements

Class DisplayedZValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DisplayedZValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class DisplayedZValue
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Displayed Z Value
Keyword: DisplayedZValue
Tag: (0018,2046)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • Mammography Image Module > Biopsy Target Sequence > Displayed Z Value
  as follows:
  Attribute Name: Displayed Z Value
  Type: 1
  Attribute Description:

  The z value in mm displayed to the user at the time of biopsy.

  Note

  1. This may be the same as the z value of Calculated Target Position or different in direction or reference point, such as relative to the compression paddle.

  2. This is not the distance that the needle was inserted, particularly for a lateral (parallel) approach.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DisplayedZValue()	Creates a new Displayed Z Value object which wraps a new and empty Attributes object.
DisplayedZValue(org.dcm4che3.data.Attributes attributes)	Creates a new Displayed Z Value object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DisplayedZValue	copy()	Returns a new Displayed Z Value which wraps a copy of the Attributes wrapped in this Displayed Z Value.
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.DoubleDataElementWrapper

getDouble, setDouble

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

getFloat, setFloat

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

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

DisplayedZValue

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

Creates a new Displayed Z Value object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DisplayedZValue

public DisplayedZValue()

Creates a new Displayed Z Value object which wraps a new and empty Attributes object.

Method Details

copy

public DisplayedZValue copy()

Returns a new Displayed Z Value which wraps a copy of the Attributes wrapped in this Displayed Z Value. (see Attributes(Attributes)

Returns:

a new Displayed Z Value which wraps a copy of the Attributes wrapped in this Displayed Z Value.

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.