Package org.dcm4che.typeddicom.dataelements

Class VirtualSourceAxisDistances

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.VirtualSourceAxisDistances

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementMultiWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementMultiWrapper, FloatingPointSingleMultiWrapper

public class VirtualSourceAxisDistances
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements FloatingPointSingleMultiWrapper

Name: Virtual Source-Axis Distances
Keyword: VirtualSourceAxisDistances
Tag: (300A,030A)
Value Representation: FloatingPointSingle
Value Multiplicity: 2

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Virtual Source-Axis Distances
  as follows:
  Attribute Name: Virtual Source-Axis Distances
  Type: 1
  Attribute Description:

  Distance (in mm) from virtual source position to gantry rotation axis or nominal isocenter position (fixed beam-lines) of the equipment to be used for beam delivery. Specified by a numeric pair - the VSAD in the IEC Gantry X direction followed by the VSAD in the IEC Gantry Y direction.

  The VSAD is commonly used for designing apertures in contrast to the effective source-axis-distance (ESAD) that is commonly used with the inverse square law for calculating the dose decrease with distance. See DICOM Standard Part 3 - Section C.8.8.25.4.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VirtualSourceAxisDistances.Builder<SELF extends VirtualSourceAxisDistances.Builder<SELF,T>,T extends VirtualSourceAxisDistances.Holder>
static interface	VirtualSourceAxisDistances.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Virtual Source-Axis Distances" (see VirtualSourceAxisDistances)

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
VirtualSourceAxisDistances()	Creates a new Virtual Source-Axis Distances object which wraps a new and empty Attributes object.
VirtualSourceAxisDistances(org.dcm4che3.data.Attributes attributes)	Creates a new Virtual Source-Axis Distances object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
VirtualSourceAxisDistances	copy()	Returns a new Virtual Source-Axis Distances which wraps a copy of the Attributes wrapped in this Virtual Source-Axis Distances.
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, 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.DoubleDataElementMultiWrapper

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

getValueRepresentation

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

VirtualSourceAxisDistances

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

Creates a new Virtual Source-Axis Distances object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

VirtualSourceAxisDistances

public VirtualSourceAxisDistances()

Creates a new Virtual Source-Axis Distances object which wraps a new and empty Attributes object.

Method Detail

copy

public VirtualSourceAxisDistances copy()

Returns a new Virtual Source-Axis Distances which wraps a copy of the Attributes wrapped in this Virtual Source-Axis Distances. (see Attributes(Attributes)

Returns:

a new Virtual Source-Axis Distances which wraps a copy of the Attributes wrapped in this Virtual Source-Axis Distances.

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