Package org.dcm4che.typeddicom.dataelements

Class ScanningSpotSize

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ScanningSpotSize

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointSingleMultiWrapper

public class ScanningSpotSize
extends AbstractDataElementWrapper
implements FloatingPointSingleMultiWrapper

Name: Scanning Spot Size
Keyword: ScanningSpotSize
Tag: (300A,0398)
Value Representation: FL
Value Multiplicity: 2

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

  The Scanning Spot Size as calculated using the Full Width Half Maximum (FWHM). Specified by a numeric pair - the size measured in air at isocenter in IEC GANTRY X direction followed by the size in the IEC GANTRY Y direction (mm).

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ScanningSpotSize

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

Creates a new Scanning Spot Size object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ScanningSpotSize

public ScanningSpotSize()

Creates a new Scanning Spot Size object which wraps a new and empty Attributes object.

Method Details

copy

public ScanningSpotSize copy()

Returns a new Scanning Spot Size which wraps a copy of the Attributes wrapped in this Scanning Spot Size. (see Attributes(Attributes)

Returns:

a new Scanning Spot Size which wraps a copy of the Attributes wrapped in this Scanning Spot Size.

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.