cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RespiratorySynchronizationModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RespiratorySynchronizationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RespiratorySynchronizationModule
extends Module

\* This module specifies the attributes of the Respiratory Synchronization Module.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
RespiratorySynchronizationModule(IDataSet objIDataSet) Instantiates a new respiratory synchronization module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getRespiratoryMotionCompensationTechnique() Retrieves applied technique to reduce respiratory motion artifacts.
java.lang.String	getRespiratorySignalSource() Retrieves signal source from which respiratory motion is derived.
double	getRespiratoryTriggerDelayThreshold() Retrieves Respiratory trigger threshold in percent of the chest expansion for the frame relative to the last Respiratory-Peak.
java.lang.String	getRespiratoryTriggerType() Returns Characteristic of the respiratory signal used to the define the respiratory triggering.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setRespiratoryMotionCompensationTechnique(EnumRespiratoryMotionCompensation enumRespiratoryMotionCompensationTechnique) Sets applied technique to reduce respiratory motion artifacts.
void	setRespiratorySignalSource(EnumRespiratorySignalSource enumRespiratorySignalSource) Sets signal source from which respiratory motion is derived.
void	setRespiratoryTriggerDelayThreshold(double dblRespiratoryTriggerDelayThreshold) Sets Respiratory trigger threshold in percent of the chest expansion for the frame relative to the last Respiratory-Peak.
void	setRespiratoryTriggerType(EnumRespiratoryTriggerType enumRespiratoryTriggerType) Sets Characteristic of the respiratory signal used to the define the respiratory triggering.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

RespiratorySynchronizationModule

public RespiratorySynchronizationModule(IDataSet objIDataSet)

Instantiates a new respiratory synchronization module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setRespiratoryMotionCompensationTechnique

public void setRespiratoryMotionCompensationTechnique(EnumRespiratoryMotionCompensation enumRespiratoryMotionCompensationTechnique)

Sets applied technique to reduce respiratory motion artifacts. Defined Terms: 1) NONE 2) BREATH_HOLD 3) REALTIME = image acquisition shorter than respiratory cycle. 4) GATING = Prospective gating. 5) TRACKING = prospective throughplane or in-plane motion tracking. 6) PHASE_ORDERING = prospective phase ordering. 7) PHASE_RESCANNING = prospective techniques, such as real-time averaging, diminishing variance and motion adaptive gating. 8) RETROSPECTIVE = retrospective gating. 9) CORRECTION = retrospective image correction.

Parameters:

enumRespiratoryMotionCompensationTechnique - - Enum value of Respiratory Motion Compensation Technique.

getRespiratoryMotionCompensationTechnique

public java.lang.String getRespiratoryMotionCompensationTechnique()

Retrieves applied technique to reduce respiratory motion artifacts.

Returns:

- String value of Respiratory Motion Compensation Technique.

setRespiratorySignalSource

public void setRespiratorySignalSource(EnumRespiratorySignalSource enumRespiratorySignalSource)

Sets signal source from which respiratory motion is derived. Defined Terms: 1) NONE 2) BELT 3) NASAL_PROBE 4) CO2_SENSOR 5) NAVIGATOR = MR navigator and organ edge detection. 6) MR_PHASE = phase (of center k-space line). 7) ECG = baseline demodulation of the ECG.

Parameters:

enumRespiratorySignalSource - - Enum value of Respiratory Signal Source.

getRespiratorySignalSource

public java.lang.String getRespiratorySignalSource()

Retrieves signal source from which respiratory motion is derived.

Returns:

- String value of Respiratory Signal Source.

setRespiratoryTriggerDelayThreshold

public void setRespiratoryTriggerDelayThreshold(double dblRespiratoryTriggerDelayThreshold)

Sets Respiratory trigger threshold in percent of the chest expansion for the frame relative to the last Respiratory-Peak.

Parameters:

dblRespiratoryTriggerDelayThreshold - Double value of RespiratoryTriggerDelayThreshold

getRespiratoryTriggerDelayThreshold

public double getRespiratoryTriggerDelayThreshold()

Retrieves Respiratory trigger threshold in percent of the chest expansion for the frame relative to the last Respiratory-Peak.

Returns:

double - double value of RespiratoryTriggerDelayThreshold

setRespiratoryTriggerType

public void setRespiratoryTriggerType(EnumRespiratoryTriggerType enumRespiratoryTriggerType)

Sets Characteristic of the respiratory signal used to the define the respiratory triggering. Enumerated Values: TIME. AMPLITUDE. BOTH

Parameters:

enumRespiratoryTriggerType - String value of Stereo Pairs Present.

getRespiratoryTriggerType

public java.lang.String getRespiratoryTriggerType()

Returns Characteristic of the respiratory signal used to the define the respiratory triggering.

Returns:

String - String value of RespiratoryTriggerType.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

- the customized collection containing the dataelement tags that beling to this module