Package org.dcm4che.typeddicom.dataelements

Class ScanMode

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ScanMode

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ScanMode
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Scan Mode
Keyword: ScanMode
Tag: (300A,0308)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Scan Mode
  as follows:
  Attribute Name: Scan Mode
  Type: 1
  Attribute Description:

  The method of beam scanning to be used during treatment.

  Defined Terms:

  NONE

  No beam scanning is performed.

  UNIFORM

  Between control points, the beam is scanned to create a uniform lateral fluence distribution across the field.

  MODULATED

  Between control points, the beam is scanned to create a modulated lateral fluence distribution across the field.

  MODULATED_SPEC

  Between control points, the beam is scanned to create a modulated lateral fluence distribution across the field. The specific scan mode is defined by Modulated Scan Mode Type (300A,0309).

  
  
• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Scan Mode
  as follows:
  Attribute Name: Scan Mode
  Type: 1
  Attribute Description:

  The method of beam scanning used during treatment.

  Defined Terms:

  NONE

  No beam scanning is performed.

  UNIFORM

  Between control points, the beam is scanned to create a uniform lateral fluence distribution across the field.

  MODULATED

  Between control points, the beam is scanned to create a modulated lateral fluence distribution across the field.

  MODULATED_SPEC

  Between control points, the beam is scanned to create a modulated lateral fluence distribution across the field. The specific scan mode is defined by Modulated Scan Mode Type (300A,0309).

  
  
• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Scan Mode
  as follows:
  Attribute Name: Scan Mode
  Type:
  Attribute Description:

  The method of beam scanning to be used during treatment.

  Enumerated Values:

  NONE

  No beam scanning is performed

  UNIFORM

  The beam is scanned between control points to create a uniform lateral fluence distribution across the field

  MODULATED

  The beam is scanned between control points to create a modulated lateral fluence distribution across the field

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
ScanMode()	Creates a new Scan Mode object which wraps a new and empty Attributes object.
ScanMode(org.dcm4che3.data.Attributes attributes)	Creates a new Scan Mode object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ScanMode	copy()	Returns a new Scan Mode which wraps a copy of the Attributes wrapped in this Scan Mode.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

ScanMode

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

Creates a new Scan Mode object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ScanMode

public ScanMode()

Creates a new Scan Mode object which wraps a new and empty Attributes object.

Method Details

copy

public ScanMode copy()

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

Returns:

a new Scan Mode which wraps a copy of the Attributes wrapped in this Scan Mode.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.