Package org.dcm4che.typeddicom.dataelements

Class SourceToPatientSurfaceDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SourceToPatientSurfaceDistance

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointDoubleWrapper

public class SourceToPatientSurfaceDistance
extends AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: Source to Patient Surface Distance
Keyword: SourceToPatientSurfaceDistance
Tag: (300A,0634)
Value Representation: FD
Value Multiplicity: 1

• Described in the contexts:
  • C-Arm Photon-Electron Beam Module > C-Arm Photon-Electron Control Point Sequence > Source to Patient Surface Distance
  as follows:
  Attribute Name: Source to Patient Surface Distance
  Type: 2C
  Attribute Description:

  Distance in mm from the nominal Radiation Source location to the Patient surface (skin) along the central beam axis from the source.

  Required if the conditions in DICOM Standard Part 3 - Section C.36.2.2.5.1.1 are satisfied.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SourceToPatientSurfaceDistance.Builder<SELF extends SourceToPatientSurfaceDistance.Builder<SELF,T>,T extends SourceToPatientSurfaceDistance.Holder>
static interface	SourceToPatientSurfaceDistance.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Source to Patient Surface Distance" (see SourceToPatientSurfaceDistance)
static class	SourceToPatientSurfaceDistance.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SourceToPatientSurfaceDistance()	Creates a new Source to Patient Surface Distance object which wraps a new and empty Attributes object.
SourceToPatientSurfaceDistance(org.dcm4che3.data.Attributes attributes)	Creates a new Source to Patient Surface Distance object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SourceToPatientSurfaceDistance	copy()	Returns a new Source to Patient Surface Distance which wraps a copy of the Attributes wrapped in this Source to Patient Surface Distance.
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.FloatingPointDoubleWrapper

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

SourceToPatientSurfaceDistance

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

Creates a new Source to Patient Surface Distance object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SourceToPatientSurfaceDistance

public SourceToPatientSurfaceDistance()

Creates a new Source to Patient Surface Distance object which wraps a new and empty Attributes object.

Method Details

copy

public SourceToPatientSurfaceDistance copy()

Returns a new Source to Patient Surface Distance which wraps a copy of the Attributes wrapped in this Source to Patient Surface Distance. (see Attributes(Attributes)

Returns:

a new Source to Patient Surface Distance which wraps a copy of the Attributes wrapped in this Source to Patient Surface Distance.

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.