Package org.dcm4che.typeddicom.dataelements

Class ScanSpotPositionMap

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ScanSpotPositionMap

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointSingleMultiWrapper

public class ScanSpotPositionMap
extends AbstractDataElementWrapper
implements FloatingPointSingleMultiWrapper

Name: Scan Spot Position Map
Keyword: ScanSpotPositionMap
Tag: (300A,0394)
Value Representation: FL
Value Multiplicity: 1-n

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Scan Spot Position Map
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Scan Spot Position Map
  as follows:
  Attribute Name: Scan Spot Position Map
  Type: 1C
  Attribute Description:

  A data stream of (x,y) pairs that define the coordinates of the scan spots as projected onto the machine isocentric plane in the IEC GANTRY coordinate system (mm). Required if Scan Mode (300A,0308) is MODULATED or MODULATED_SPEC. Contains 2N values where N is the Number of Scan Spot Positions (300A,0392). See DICOM Standard Part 3 - Section C.8.8.25.8.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ScanSpotPositionMap

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

Creates a new Scan Spot Position Map object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ScanSpotPositionMap

public ScanSpotPositionMap()

Creates a new Scan Spot Position Map object which wraps a new and empty Attributes object.

Method Details

copy

public ScanSpotPositionMap copy()

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

Returns:

a new Scan Spot Position Map which wraps a copy of the Attributes wrapped in this Scan Spot Position Map.

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.