Package org.dcm4che.typeddicom.dataelements

Class BeamDosePointSSD

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamDosePointSSD

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class BeamDosePointSSD
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Beam Dose Point SSD
Keyword: BeamDosePointSSD
Tag: (300A,008A)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Referenced Dose Reference Sequence > Beam Dose Verification Control Point Sequence > Beam Dose Point SSD
  as follows:
  Attribute Name: Beam Dose Point SSD
  Type: 1C
  Attribute Description:

  Source to patient surface (skin) distance in mm along a ray from the source to the dose point specified by the Dose Reference Point Coordinates (300A,0018) or the referenced ROI.

  Required for all but the last Item in this Sequence and for the last Item if Depth Value Averaging Flag (300A,0093) has a value of NO.

  See Note 6.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
BeamDosePointSSD	copy()	Returns a new Beam Dose Point SSD which wraps a copy of the Attributes wrapped in this Beam Dose Point SSD.
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

BeamDosePointSSD

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

Creates a new Beam Dose Point SSD object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamDosePointSSD

public BeamDosePointSSD()

Creates a new Beam Dose Point SSD object which wraps a new and empty Attributes object.

Method Details

copy

public BeamDosePointSSD copy()

Returns a new Beam Dose Point SSD which wraps a copy of the Attributes wrapped in this Beam Dose Point SSD. (see Attributes(Attributes)

Returns:

a new Beam Dose Point SSD which wraps a copy of the Attributes wrapped in this Beam Dose Point SSD.

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.