Package org.dcm4che.typeddicom.dataelements

Class SourceToCompensatorDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SourceToCompensatorDistance

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringMultiWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, StringDataElementMultiWrapper

public class SourceToCompensatorDistance
extends AbstractDataElementWrapper
implements DecimalStringMultiWrapper

Name: Source to Compensator Distance
Keyword: SourceToCompensatorDistance
Tag: (300A,02E2)
Value Representation: DS
Value Multiplicity: 1-n

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Compensator Sequence > Source to Compensator Distance
  as follows:
  Attribute Name: Source to Compensator Distance
  Type: 1C
  Attribute Description:

  A data stream of the pixel samples that comprise the distance from the radiation source to the compensator surface closest to the radiation source (in mm). The order of pixels encoded is left to right, top to bottom (upper left pixel, followed by the remainder of row 1, followed by the remainder of the columns). Required if Material ID (300A,00E1) is non-zero length, and Compensator Mounting Position (300A,02E1) is DOUBLE_SIDED. May be present if Material ID (300A,00E1) is zero length and Compensator Mounting Position (300A,02E1) is DOUBLE_SIDED. See DICOM Standard Part 3 - Section C.8.8.14.9 and DICOM Standard Part 3 - Section C.8.8.14.11.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

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

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

getString, getString, getStrings, setStrings

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

SourceToCompensatorDistance

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

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

Parameters:

attributes - The Attributes object to be wrapped.

SourceToCompensatorDistance

public SourceToCompensatorDistance()

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

Method Details

copy

public SourceToCompensatorDistance copy()

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

Returns:

a new Source to Compensator Distance which wraps a copy of the Attributes wrapped in this Source to Compensator 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.