Package org.dcm4che.typeddicom.dataelements

Class RespiratorySignalSource

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RespiratorySignalSource

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RespiratorySignalSource
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Respiratory Signal Source
Keyword: RespiratorySignalSource
Tag: (0018,9171)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Performed CT Acquisition Module > Acquisition Protocol Element Sequence > CT X-Ray Details Sequence > Respiratory Signal Source
  as follows:
  Attribute Name: Respiratory Signal Source
  Type: 1C
  Attribute Description:

  Signal source from which respiratory motion is derived.

  Defined Terms:

  NONE

  BELT

  NASAL_PROBE

  CO2_SENSOR

  ECG

  Required if Respiratory Motion Compensation Technique (0018,9170) equals other than NONE or BREATH_HOLD. May be present otherwise.

  
  
• Described in the contexts:
  • Respiratory Synchronization Module > Respiratory Signal Source
  as follows:
  Attribute Name: Respiratory Signal Source
  Type: 1C
  Attribute Description:

  Signal source from which respiratory motion is derived.

  Defined Terms:

  NONE

  BELT

  includes various devices that detect or track expansion of the chest

  NASAL_PROBE

  CO2_SENSOR

  NAVIGATOR

  MR navigator and organ edge detection

  MR_PHASE

  phase (of center k-space line)

  ECG

  baseline demodulation of the ECG

  Required if Image Type (0008,0008) Value 1 is ORIGINAL or MIXED and Respiratory Motion Compensation Technique (0018,9170) equals other than NONE.

  Otherwise may be present if Image Type (0008,0008) Value 1 is DERIVED and Respiratory Motion Compensation Technique (0018,9170equals other than NONE.

  
  
• Described in the contexts:
  • RT Patient Setup Module > Patient Setup Sequence > Motion Synchronization Sequence > Respiratory Signal Source
  as follows:
  Attribute Name: Respiratory Signal Source
  Type: 1
  Attribute Description:

  Signal source from which respiratory motion is derived.

  Defined Terms:

  NONE

  BELT

  NASAL_PROBE

  CO2_SENSOR

  NAVIGATOR

  MR navigator and organ edge detection

  MR_PHASE

  phase (of center k-space line)

  ECG

  baseline demodulation of the ECG

  SPIROMETER

  Signal derived from flow sensor

  EXTERNAL_MARKER

  Signal determined from external motion surrogate

  INTERNAL_MARKER

  Signal determined from internal motion surrogate

  IMAGE

  Signal derived from an image

  UNKNOWN

  Signal source not known

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RespiratorySignalSource	copy()	Returns a new Respiratory Signal Source which wraps a copy of the Attributes wrapped in this Respiratory Signal Source.
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

RespiratorySignalSource

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

Creates a new Respiratory Signal Source object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RespiratorySignalSource

public RespiratorySignalSource()

Creates a new Respiratory Signal Source object which wraps a new and empty Attributes object.

Method Details

copy

public RespiratorySignalSource copy()

Returns a new Respiratory Signal Source which wraps a copy of the Attributes wrapped in this Respiratory Signal Source. (see Attributes(Attributes)

Returns:

a new Respiratory Signal Source which wraps a copy of the Attributes wrapped in this Respiratory Signal Source.

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.