cdac.medinfo.sdk.dcm30_04.baselibs

Class RespiratorySynchronizationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RespiratorySynchronizationSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class RespiratorySynchronizationSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes ofRespiratory Synchronization Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
double	getActualRespiratoryTriggerDelayTime() Retrieves the Nominal Respiratory Trigger Delay Time.
float	getEndingRespiratoryAmplitude() Retrieves the Starting Respiratory Amplitude.
java.lang.String	getEndingRespiratoryPhase() Return type of Ending Respiratory Phase.
float	getNominalPercentageOfRespiratoryPhase() Retrieves the Nominal Percentage Of Respiratory Phase.
double	getNominalRespiratoryTriggerDelayTime() Retrieves the Nominal Respiratory Trigger Delay Time.
double	getRespiratoryIntervalTime() Retrieves the Minimal value of Chemical Shift Frequency in ppm.
float	getStartingRespiratoryAmplitude() Retrieves the Starting Respiratory Amplitude.
java.lang.String	getStartingRespiratoryPhase() Return type of Starting Respiratory Phase.
void	setActualRespiratoryTriggerDelayTime(double dblActualRespiratoryTriggerDelayTime) The actual time in ms from the beginning of the respiratory interval to thevalue of Frame Reference DateTime (0018,9151).
void	setEndingRespiratoryAmplitude(float fEndingRespiratoryAmplitude) Nominal amplitude of the respiratory signal at which the acquisition of datafor this frame begins, in percent of the nominal maximum value (whichrepresents maximum inspiration).
void	setEndingRespiratoryPhase(EnumEndingRespiratoryPhase enumEndingRespiratoryPhase) The phase of respiration at which the Ending Respiratory Amplitude(0020,9248) was measured.
void	setNominalPercentageOfRespiratoryPhase(float fNominalPercentageOfRespiratoryPhase) The nominal time relative to the preceding respiratory inspiration maximumdivided by the nominal respiratory interval multiplied by 100.
void	setNominalRespiratoryTriggerDelayTime(double dblNominalRespiratoryTriggerDelayTime) The nominal time in ms from the beginning of the respiratory interval tothe value of Frame Reference DateTime (0018,9151).
void	setRespiratoryIntervalTime(double dblRespiratoryIntervalTime) Measured interval time in ms from maximum respiration peak to the nextpeak for the respiratory cycle in which this frame occurs.
void	setStartingRespiratoryAmplitude(float fStartingRespiratoryAmplitude) Nominal amplitude of the respiratory signal at which the acquisition of datafor this frame begins, in percent of the nominal maximum value (whichrepresents maximum inspiration).
void	setStartingRespiratoryPhase(EnumStartingRespiratoryPhase enumStartingRespiratoryPhase) The phase of respiration at which the Starting Respiratory Amplitude(0020,9246) was measured.
boolean	validateForModule() Validates all the attributes in CalculatedDoseReferenceSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

setRespiratoryIntervalTime

public void setRespiratoryIntervalTime(double dblRespiratoryIntervalTime)

Measured interval time in ms from maximum respiration peak to the nextpeak for the respiratory cycle in which this frame occurs.

Parameters:

dblRespiratoryIntervalTime - Double value of coordinates

getRespiratoryIntervalTime

public double getRespiratoryIntervalTime()

Retrieves the Minimal value of Chemical Shift Frequency in ppm.

Returns:

double - double value of ChemicalShiftsMinimumIntegrationLimitOnppm

setNominalPercentageOfRespiratoryPhase

public void setNominalPercentageOfRespiratoryPhase(float fNominalPercentageOfRespiratoryPhase)

The nominal time relative to the preceding respiratory inspiration maximumdivided by the nominal respiratory interval multiplied by 100. Required if used as a dimension index, may be present otherwise.

Parameters:

fPresentationPixelMagnificationRatio - Float value of the Ratio of displayed pixels to source pixels

getNominalPercentageOfRespiratoryPhase

public float getNominalPercentageOfRespiratoryPhase()

Retrieves the Nominal Percentage Of Respiratory Phase.

Returns:

float - Float value of the Ratio of displayed pixels to source pixels

setNominalRespiratoryTriggerDelayTime

public void setNominalRespiratoryTriggerDelayTime(double dblNominalRespiratoryTriggerDelayTime)

The nominal time in ms from the beginning of the respiratory interval tothe value of Frame Reference DateTime (0018,9151).

Parameters:

dblNominalRespiratoryTriggerDelayTime - Double value of coordinates

getNominalRespiratoryTriggerDelayTime

public double getNominalRespiratoryTriggerDelayTime()

Retrieves the Nominal Respiratory Trigger Delay Time.

Returns:

double - double value of NominalRespiratoryTriggerDelayTime

setActualRespiratoryTriggerDelayTime

public void setActualRespiratoryTriggerDelayTime(double dblActualRespiratoryTriggerDelayTime)

The actual time in ms from the beginning of the respiratory interval to thevalue of Frame Reference DateTime (0018,9151).

Parameters:

dblActualRespiratoryTriggerDelayTime - Double value of coordinates

getActualRespiratoryTriggerDelayTime

public double getActualRespiratoryTriggerDelayTime()

Retrieves the Nominal Respiratory Trigger Delay Time.

Returns:

double - double value of NominalRespiratoryTriggerDelayTime

setStartingRespiratoryAmplitude

public void setStartingRespiratoryAmplitude(float fStartingRespiratoryAmplitude)

Nominal amplitude of the respiratory signal at which the acquisition of datafor this frame begins, in percent of the nominal maximum value (whichrepresents maximum inspiration).

Parameters:

fStartingRespiratoryAmplitude - Float value of Starting Respiratory Amplitude.

getStartingRespiratoryAmplitude

public float getStartingRespiratoryAmplitude()

Retrieves the Starting Respiratory Amplitude.

Returns:

float - Float value of the Ratio of displayed pixels to source pixels

setStartingRespiratoryPhase

public void setStartingRespiratoryPhase(EnumStartingRespiratoryPhase enumStartingRespiratoryPhase)

The phase of respiration at which the Starting Respiratory Amplitude(0020,9246) was measured. Enumerated Values: INSPIRATION MAXIMUM EXPIRATION MINIMUM Required if Starting Respiratory Amplitude (0020,9246) is present.

Parameters:

enumStartingRespiratoryPhase - enum value of Starting Respiratory Phase.

getStartingRespiratoryPhase

public java.lang.String getStartingRespiratoryPhase()

Return type of Starting Respiratory Phase.

Returns:

String - value of Setup Device Type.

setEndingRespiratoryAmplitude

public void setEndingRespiratoryAmplitude(float fEndingRespiratoryAmplitude)

Nominal amplitude of the respiratory signal at which the acquisition of datafor this frame begins, in percent of the nominal maximum value (whichrepresents maximum inspiration).

Parameters:

fEndingRespiratoryAmplitude - Float value of Ending Respiratory Amplitude.

getEndingRespiratoryAmplitude

public float getEndingRespiratoryAmplitude()

Retrieves the Starting Respiratory Amplitude.

Returns:

float - Float value of the Ratio of displayed pixels to source pixels

setEndingRespiratoryPhase

public void setEndingRespiratoryPhase(EnumEndingRespiratoryPhase enumEndingRespiratoryPhase)

The phase of respiration at which the Ending Respiratory Amplitude(0020,9248) was measured. Enumerated Values: INSPIRATION MAXIMUM EXPIRATION MINIMUM Required if Starting Respiratory Amplitude (0020,9246) is present.

Parameters:

enumEndingRespiratoryPhase - enum value of Starting Respiratory Phase.

getEndingRespiratoryPhase

public java.lang.String getEndingRespiratoryPhase()

Return type of Ending Respiratory Phase.

Returns:

String - value of Setup Device Type.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in CalculatedDoseReferenceSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.