Package org.dcm4che.typeddicom.dataelements

Class ZOffsetInSlideCoordinateSystem

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ZOffsetInSlideCoordinateSystem

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, DecimalStringWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class ZOffsetInSlideCoordinateSystem
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Z Offset in Slide Coordinate System
Keyword: ZOffsetInSlideCoordinateSystem
Tag: (0040,074A)
Value Representation: DecimalString
Value Multiplicity: 1

• Described in the contexts:
  • Slide Coordinates Module > Image Center Point Coordinates Sequence > Z Offset in Slide Coordinate System
  as follows:
  Attribute Name: Z Offset in Slide Coordinate System
  Type: 2
  Attribute Description:

  The Z offset in µm from the image substrate reference plane (i.e., utilized surface of a glass slide).

  Note

  The use of units of microns is inconsistent with the use of millimeters for Point Coordinates Data (0066,0016), Double Point Coordinates Data (0066,0022) and Common Z Coordinate Value (006A,0010) in the DICOM Standard Part 3 - Section C.37.1.2.

  
  
• Described in the contexts:
  • Microscope Slide Layer Tile Organization Module > Total Pixel Matrix Origin Sequence > Z Offset in Slide Coordinate System
  as follows:
  Attribute Name: Z Offset in Slide Coordinate System
  Type: 1C
  Attribute Description:

  The Z offset in µm from the image substrate reference plane (i.e., utilized surface of a glass slide).

  Required if the Z offset is not zero. May be present otherwise.

  Note

  The conditional requirement is used because, historically, this Attribute was not present.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ZOffsetInSlideCoordinateSystem.Builder<SELF extends ZOffsetInSlideCoordinateSystem.Builder<SELF,T>,T extends ZOffsetInSlideCoordinateSystem.Holder>
static interface	ZOffsetInSlideCoordinateSystem.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Z Offset in Slide Coordinate System" (see ZOffsetInSlideCoordinateSystem)

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

DecimalStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends DecimalStringWrapper>

Field Summary

Fields

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

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.DecimalStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ZOffsetInSlideCoordinateSystem()	Creates a new Z Offset in Slide Coordinate System object which wraps a new and empty Attributes object.
ZOffsetInSlideCoordinateSystem(org.dcm4che3.data.Attributes attributes)	Creates a new Z Offset in Slide Coordinate System object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ZOffsetInSlideCoordinateSystem	copy()	Returns a new Z Offset in Slide Coordinate System which wraps a copy of the Attributes wrapped in this Z Offset in Slide Coordinate System.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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.DecimalStringWrapper

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

ZOffsetInSlideCoordinateSystem

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

Creates a new Z Offset in Slide Coordinate System object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

ZOffsetInSlideCoordinateSystem

public ZOffsetInSlideCoordinateSystem()

Creates a new Z Offset in Slide Coordinate System object which wraps a new and empty Attributes object.

Method Detail

copy

public ZOffsetInSlideCoordinateSystem copy()

Returns a new Z Offset in Slide Coordinate System which wraps a copy of the Attributes wrapped in this Z Offset in Slide Coordinate System. (see Attributes(Attributes)

Returns:

a new Z Offset in Slide Coordinate System which wraps a copy of the Attributes wrapped in this Z Offset in Slide Coordinate System.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper