Package org.dcm4che.typeddicom.dataelements

Class RangeModulatorType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RangeModulatorType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RangeModulatorType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Range Modulator Type
Keyword: RangeModulatorType
Tag: (300A,0348)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Recorded Range Modulator Sequence > Range Modulator Type
  as follows:
  Attribute Name: Range Modulator Type
  Type:
  Attribute Description:

  Type of Range Modulator.

  See DICOM Standard Part 3 - Section C.31.3.1 for Defined Terms.

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

  Type of Range Modulator.

  Defined Terms:

  FIXED

  fixed modulation width and weights using ridge filter or constant speed wheel with constant beam current

  WHL_FIXEDWEIGHTS

  selected wheel/track (Range Modulator ID) is spinning at constant speed. Modulation width is adjusted by switching constant beam current on and off at wheel steps indicated by Range Modulator Interrupt Values

  WHL_MODWEIGHTS

  selected wheel/track (Range Modulator ID) is spinning at constant speed. Weight per wheel step is adjusted by modulating beam current according to selected Beam Current Modulation ID (300A,034C)

  Only one Item in the Recorded Range Modulator Sequence (3008,00F6) can have a Range Modulator Type (300A,0348) of WHL_MODWEIGHTS.

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

  Type of Range Modulator.

  Defined Terms:

  FIXED

  fixed modulation width and weights using ridge filter or constant speed wheel with constant beam current

  WHL_FIXEDWEIGHTS

  selected wheel/track (Range Modulator ID) is spinning at constant speed. Modulation width is adjusted by switching constant beam current on and off at wheel steps indicated by Range Modulator Gating Values.

  WHL_MODWEIGHTS

  selected wheel/track (Range Modulator ID) is spinning at constant speed. Weight per wheel step is adjusted by modulating beam current according to selected Beam Current Modulation ID (300A,034C).

  Only one Item in the Range Modulator Sequence (300A,0342) can have a Range Modulator Type (300A,0348) of WHL_MODWEIGHTS.

  
  

Nested Class Summary

Nested Classes

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RangeModulatorType()	Creates a new Range Modulator Type object which wraps a new and empty Attributes object.
RangeModulatorType(org.dcm4che3.data.Attributes attributes)	Creates a new Range Modulator Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RangeModulatorType	copy()	Returns a new Range Modulator Type which wraps a copy of the Attributes wrapped in this Range Modulator Type.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

getString, setString

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

RangeModulatorType

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

Creates a new Range Modulator Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RangeModulatorType

public RangeModulatorType()

Creates a new Range Modulator Type object which wraps a new and empty Attributes object.

Method Details

copy

public RangeModulatorType copy()

Returns a new Range Modulator Type which wraps a copy of the Attributes wrapped in this Range Modulator Type. (see Attributes(Attributes)

Returns:

a new Range Modulator Type which wraps a copy of the Attributes wrapped in this Range Modulator Type.

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.