Package org.dcm4che.typeddicom.dataelements

Class ScanSpotTimeOffset

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ScanSpotTimeOffset

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointSingleMultiWrapper

public class ScanSpotTimeOffset
extends AbstractDataElementWrapper
implements FloatingPointSingleMultiWrapper

Name: Scan Spot Time Offset
Keyword: ScanSpotTimeOffset
Tag: (300A,038F)
Value Representation: FL
Value Multiplicity: 1-n

• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Scan Spot Time Offset
  as follows:
  Attribute Name: Scan Spot Time Offset
  Type: 3
  Attribute Description:

  A set of time offsets (in microseconds). Each offset is the time from the Treatment Control Point Time (3008,0025) until both the beam has reached the X,Y position recorded in the Scan Spot Position Map (300A,0394) and ion delivery has started at this position.

  The order of values matches the order of positions in Scan Spot Position Map (300A,0394).

  The number of values shall equal the value of Number of Scan Spot Positions (300A,0392).

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScanSpotTimeOffset.Builder<SELF extends ScanSpotTimeOffset.Builder<SELF,T>,T extends ScanSpotTimeOffset.Holder>
static interface	ScanSpotTimeOffset.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Scan Spot Time Offset" (see ScanSpotTimeOffset)
static class	ScanSpotTimeOffset.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ScanSpotTimeOffset()	Creates a new Scan Spot Time Offset object which wraps a new and empty Attributes object.
ScanSpotTimeOffset(org.dcm4che3.data.Attributes attributes)	Creates a new Scan Spot Time Offset object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ScanSpotTimeOffset	copy()	Returns a new Scan Spot Time Offset which wraps a copy of the Attributes wrapped in this Scan Spot Time Offset.
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 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

ScanSpotTimeOffset

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

Creates a new Scan Spot Time Offset object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ScanSpotTimeOffset

public ScanSpotTimeOffset()

Creates a new Scan Spot Time Offset object which wraps a new and empty Attributes object.

Method Details

copy

public ScanSpotTimeOffset copy()

Returns a new Scan Spot Time Offset which wraps a copy of the Attributes wrapped in this Scan Spot Time Offset. (see Attributes(Attributes)

Returns:

a new Scan Spot Time Offset which wraps a copy of the Attributes wrapped in this Scan Spot Time Offset.

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.