Package org.dcm4che.typeddicom.dataelements

Class PupilCentroidYCoordinate

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PupilCentroidYCoordinate

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class PupilCentroidYCoordinate
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Pupil Centroid Y-Coordinate
Keyword: PupilCentroidYCoordinate
Tag: (0046,0204)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • Corneal Topography Map Analysis Module > Pupil Centroid Y-Coordinate
  as follows:
  Attribute Name: Pupil Centroid Y-Coordinate
  Type: 1C
  Attribute Description:

  The vertical coordinate of the centroid of the pupil relative to location of the cornea vertex specified in the Attribute Corneal Vertex Location (0046,0202), in mm, such that up is positive. See DICOM Standard Part 3 - Section C.8.30.3.1.4 for further explanation.

  Required if Attribute Corneal Topography Surface (0046,0201) is A (Anterior).

  Note

  This Attribute is conveyed in mm from the corneal vertex because display applications will have zoom and 3-D rotational capabilities.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PupilCentroidYCoordinate.Builder<SELF extends PupilCentroidYCoordinate.Builder<SELF,T>,T extends PupilCentroidYCoordinate.Holder>
static interface	PupilCentroidYCoordinate.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Pupil Centroid Y-Coordinate" (see PupilCentroidYCoordinate)
static class	PupilCentroidYCoordinate.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
PupilCentroidYCoordinate()	Creates a new Pupil Centroid Y-Coordinate object which wraps a new and empty Attributes object.
PupilCentroidYCoordinate(org.dcm4che3.data.Attributes attributes)	Creates a new Pupil Centroid Y-Coordinate object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
PupilCentroidYCoordinate	copy()	Returns a new Pupil Centroid Y-Coordinate which wraps a copy of the Attributes wrapped in this Pupil Centroid Y-Coordinate.
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

PupilCentroidYCoordinate

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

Creates a new Pupil Centroid Y-Coordinate object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PupilCentroidYCoordinate

public PupilCentroidYCoordinate()

Creates a new Pupil Centroid Y-Coordinate object which wraps a new and empty Attributes object.

Method Details

copy

public PupilCentroidYCoordinate copy()

Returns a new Pupil Centroid Y-Coordinate which wraps a copy of the Attributes wrapped in this Pupil Centroid Y-Coordinate. (see Attributes(Attributes)

Returns:

a new Pupil Centroid Y-Coordinate which wraps a copy of the Attributes wrapped in this Pupil Centroid Y-Coordinate.

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.