cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class EnhancedPETAcquisitionModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.EnhancedPETAcquisitionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class EnhancedPETAcquisitionModule
extends Module

\* This module is used for Enhanced PET Acquisition Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EnhancedPETAcquisitionModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionStartCondition() Return Description of how the data collection was started.
java.lang.String	getAcquisitionTerminationCondition() Returns Description of how the data collection was stopped.
double	getAxialDetectorDimension() Retrieves Axial Detector Dimension
java.lang.String	getCoincidenceWindowWidth() Retrieves The width of the coincidence timing window, in nsec.
java.lang.String	getCollimatorType() Retrieves the Type of Collimator.
java.lang.String	getDetectorGeometry() Returns Physical arrangement of the detectors in the acquisition system
EnergyWindowRangeSequence	getEnergyWindowRangeSequence() Retrieves pre-initialized object of Energy Window RangeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence
java.lang.String[]	getIsocenterPosition() Retrieves Isocenter Position
MandatoryViewandSliceProgressionDirectionMacro	getMandatoryViewandSliceProgressionDirectionMacro() Get the Instance of Mandatory View and Slice ProgressionDirection Macro Attributes .Calling this method multiple times will return the same Marco Instance that was created at first.
java.lang.String	getScanProgressionDirection() Retrieves type of the value encoded in this Item
double	getStartCardiacTriggerCountThreshold() Retrieves Start Cardiac Trigger CountThreshold
double	getStartDensityThreshold() Retrieves Start Density Threshold
double	getStartRelativeDensityDifferenceThreshold() Retrieves Start Relative DensityDifference Threshold
double	getStartRespiratoryTriggerCountThreshold() Retrieves Start Respiratory TriggerCount Threshold
java.lang.String	getTableMotion() Return Table Motion.
double	getTerminationCardiacTriggerCountThreshold() Retrieves Termination Cardiac Trigger CountThreshold
double	getTerminationCountsThreshold() Retrieves Termination Counts Threshold
double	getTerminationDensityThreshold() Retrieves Termination Density Threshold
double	getTerminationRelativeDensityThreshold() Retrieves Termination Relative DensityThreshold
double	getTerminationRespiratoryTriggerCountThreshold() Retrieves Termination Respiratory TriggerCount Threshold
double	getTerminationTimeThreshold() Retrieves Termination Time Threshold
java.lang.String	getTimeOfFlightInformationUsed() Returns whether or not Time-of-Flight information was used in creationof the image.
double	getTransverseDetectorSeparation() Retrieves Transverse DetectorSeparation
java.lang.String	getTypeOfDetectorMotion() Retrieves the activity of the Detector during acquisition.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setAcquisitionStartCondition(java.lang.String strAcquisitionStartCondition) Sets Description of how the data collection was started.
void	setAcquisitionTerminationCondition(EnumAcquisitionTerminationCondition enumAcquisitionTerminationCondition) Sets Description of how the data collection was stopped.
void	setAxialDetectorDimension(double dblAxialDetectorDimension) Sets Axial Detector Dimension
void	setCoincidenceWindowWidth(java.lang.String strCoincidenceWindowWidth) Sets The width of the coincidence timing window, in nsec.
void	setCollimatorType(EnumCollimatorType enumCollimatorType) Sets Collimator Type.
void	setDetectorGeometry(EnumDetectorGeometry enumDetectorGeometry) Sets Physical arrangement of the detectors in the acquisition system
void	setIsocenterPosition(java.lang.String[] strIsocenterPosition) Sets Isocenter Position
void	setScanProgressionDirection(java.lang.String strSUVType) Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME
void	setStartCardiacTriggerCountThreshold(double dblStartCardiacTriggerCountThreshold) Sets Start Cardiac Trigger CountThreshold
void	setStartDensityThreshold(double dblStartDensityThreshold) Sets Start Density Threshold
void	setStartRelativeDensityDifferenceThreshold(double dblStartRelativeDensityDifferenceThreshold) Sets Start Relative DensityDifference Threshold
void	setStartRespiratoryTriggerCountThreshold(double dblStartRespiratoryTriggerCountThreshold) Sets Start Respiratory TriggerCount Threshold
void	setTableMotion(EnumTableMotion enumTableMotion) Sets Table Motion value.
void	setTerminationCardiacTriggerCountThreshold(double dblTerminationCardiacTriggerCountThreshold) Sets Termination Cardiac Trigger CountThreshold
void	setTerminationCountsThreshold(double dblTerminationCountsThreshold) Sets Start Termination Counts Threshold
void	setTerminationDensityThreshold(double dblTerminationDensityThreshold) Sets Termination Density Threshold
void	setTerminationRelativeDensityThreshold(double dblTerminationRelativeDensityThreshold) Sets Termination Relative DensityThreshold
void	setTerminationRespiratoryTriggerCountThreshold(double dblTerminationRespiratoryTriggerCountThreshold) Sets Termination Respiratory TriggerCount Threshold
void	setTerminationTimeThreshold(double dblTerminationTimeThreshold) Sets Termination Time Threshold
void	setTimeOfFlightInformationUsed(EnumTimeOfFlightInformationUsed enumTimeOfFlightInformationUsed) Sets whether or not Time-of-Flight information was used in creationof the image.
void	setTransverseDetectorSeparation(double dblTransverseDetectorSeparation) Sets Transverse DetectorSeparation
void	setTypeOfDetectorMotion(java.lang.String strTypeOfDetectorMotion) Sets the activity of the Detector during acquisition.
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

EnhancedPETAcquisitionModule

public EnhancedPETAcquisitionModule(IDataSet objIDataSet)

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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setAcquisitionStartCondition

public void setAcquisitionStartCondition(java.lang.String strAcquisitionStartCondition)

Sets Description of how the data collection was started. Defined terms DENS = density (counts/sec) RDD = relative density difference(change in counts/sec) MANU = manual TIME = time AUTO = automatic, when ready TRIG = physiological trigger

Parameters:

strAcquisitionStartCondition - String value of Acquisition Start Condition

getAcquisitionStartCondition

public java.lang.String getAcquisitionStartCondition()

Return Description of how the data collection was started.

Returns:

String - String value of Acquisition Start Condition

setStartDensityThreshold

public void setStartDensityThreshold(double dblStartDensityThreshold)

Sets Start Density Threshold

Parameters:

dblStartDensityThreshold - Double value of Start Density Threshold

getStartDensityThreshold

public double getStartDensityThreshold()

Retrieves Start Density Threshold

Returns:

double - double value of Start Density Threshold

setStartRelativeDensityDifferenceThreshold

public void setStartRelativeDensityDifferenceThreshold(double dblStartRelativeDensityDifferenceThreshold)

Sets Start Relative DensityDifference Threshold

Parameters:

dblStartRelativeDensityDifferenceThreshold - value of Start Relative DensityDifference Threshold

getStartRelativeDensityDifferenceThreshold

public double getStartRelativeDensityDifferenceThreshold()

Retrieves Start Relative DensityDifference Threshold

Returns:

double - double value of Start Relative DensityDifference Threshold

setStartCardiacTriggerCountThreshold

public void setStartCardiacTriggerCountThreshold(double dblStartCardiacTriggerCountThreshold)

Sets Start Cardiac Trigger CountThreshold

Parameters:

dblStartCardiacTriggerCountThreshold - value of Start Cardiac Trigger CountThreshold

getStartCardiacTriggerCountThreshold

public double getStartCardiacTriggerCountThreshold()

Retrieves Start Cardiac Trigger CountThreshold

Returns:

double - double value of Start Cardiac Trigger CountThreshold

setStartRespiratoryTriggerCountThreshold

public void setStartRespiratoryTriggerCountThreshold(double dblStartRespiratoryTriggerCountThreshold)

Sets Start Respiratory TriggerCount Threshold

Parameters:

dblStartRespiratoryTriggerCountThreshold - value of Start Respiratory TriggerCount Threshold

getStartRespiratoryTriggerCountThreshold

public double getStartRespiratoryTriggerCountThreshold()

Retrieves Start Respiratory TriggerCount Threshold

Returns:

double - double value of Start Respiratory TriggerCount Threshold

setAcquisitionTerminationCondition

public void setAcquisitionTerminationCondition(EnumAcquisitionTerminationCondition enumAcquisitionTerminationCondition)

Sets Description of how the data collection was stopped. Defined Terms: CNTS = counts,DENS = density,MANU = manual,OVFL = data overflow,TIME = time,TRIG = physiological trigger,RDD = relative density difference

Parameters:

enumAcquisitionTerminationCondition - - Specifies how the data collection was stopped

getAcquisitionTerminationCondition

public java.lang.String getAcquisitionTerminationCondition()

Returns Description of how the data collection was stopped.

Returns:

String - String value of Acquisition Termination Condition

setTerminationCountsThreshold

public void setTerminationCountsThreshold(double dblTerminationCountsThreshold)

Sets Start Termination Counts Threshold

Parameters:

dblTerminationCountsThreshold - value of Termination Counts Threshold

getTerminationCountsThreshold

public double getTerminationCountsThreshold()

Retrieves Termination Counts Threshold

Returns:

double - double value of Termination Counts Threshold

setTerminationDensityThreshold

public void setTerminationDensityThreshold(double dblTerminationDensityThreshold)

Sets Termination Density Threshold

Parameters:

dblTerminationDensityThreshold - value of Termination Density Threshold

getTerminationDensityThreshold

public double getTerminationDensityThreshold()

Retrieves Termination Density Threshold

Returns:

double - double value of Termination Density Threshold

setTerminationRelativeDensityThreshold

public void setTerminationRelativeDensityThreshold(double dblTerminationRelativeDensityThreshold)

Sets Termination Relative DensityThreshold

Parameters:

dblTerminationRelativeDensityThreshold - value of Termination Relative DensityThreshold

getTerminationRelativeDensityThreshold

public double getTerminationRelativeDensityThreshold()

Retrieves Termination Relative DensityThreshold

Returns:

double - double value of Termination Relative DensityThreshold

setTerminationTimeThreshold

public void setTerminationTimeThreshold(double dblTerminationTimeThreshold)

Sets Termination Time Threshold

Parameters:

dblTerminationTimeThreshold - value of Termination Time Threshold

getTerminationTimeThreshold

public double getTerminationTimeThreshold()

Retrieves Termination Time Threshold

Returns:

double - double value of Termination Time Threshold

setTerminationCardiacTriggerCountThreshold

public void setTerminationCardiacTriggerCountThreshold(double dblTerminationCardiacTriggerCountThreshold)

Sets Termination Cardiac Trigger CountThreshold

Parameters:

dblTerminationCardiacTriggerCountThreshold - value of Termination Cardiac Trigger CountThreshold

getTerminationCardiacTriggerCountThreshold

public double getTerminationCardiacTriggerCountThreshold()

Retrieves Termination Cardiac Trigger CountThreshold

Returns:

double - double value of Termination Cardiac Trigger CountThreshold

setTerminationRespiratoryTriggerCountThreshold

public void setTerminationRespiratoryTriggerCountThreshold(double dblTerminationRespiratoryTriggerCountThreshold)

Sets Termination Respiratory TriggerCount Threshold

Parameters:

dblTerminationRespiratoryTriggerCountThreshold - value of Termination Respiratory TriggerCount Threshold

getTerminationRespiratoryTriggerCountThreshold

public double getTerminationRespiratoryTriggerCountThreshold()

Retrieves Termination Respiratory TriggerCount Threshold

Returns:

double - double value of Termination Respiratory TriggerCount Threshold

setTypeOfDetectorMotion

public void setTypeOfDetectorMotion(java.lang.String strTypeOfDetectorMotion)

Sets the activity of the Detector during acquisition.

Parameters:

strTypeOfDetectorMotion - Specifies the activity of the Detector during acquisition.

getTypeOfDetectorMotion

public java.lang.String getTypeOfDetectorMotion()

Retrieves the activity of the Detector during acquisition.

Returns:

String - the activity of the Detector during acquisition.

setDetectorGeometry

public void setDetectorGeometry(EnumDetectorGeometry enumDetectorGeometry)

Sets Physical arrangement of the detectors in the acquisition system

Parameters:

enumDetectorGeometry - - Specifies Detector Geometry

getDetectorGeometry

public java.lang.String getDetectorGeometry()

Returns Physical arrangement of the detectors in the acquisition system

Returns:

String - String value of DetectorGeometry

setTransverseDetectorSeparation

public void setTransverseDetectorSeparation(double dblTransverseDetectorSeparation)

Sets Transverse DetectorSeparation

Parameters:

dblTransverseDetectorSeparation - value of Transverse DetectorSeparation

getTransverseDetectorSeparation

public double getTransverseDetectorSeparation()

Retrieves Transverse DetectorSeparation

Returns:

double - double value of Transverse DetectorSeparation

setAxialDetectorDimension

public void setAxialDetectorDimension(double dblAxialDetectorDimension)

Sets Axial Detector Dimension

Parameters:

dblAxialDetectorDimension - value of Axial Detector Dimension

getAxialDetectorDimension

public double getAxialDetectorDimension()

Retrieves Axial Detector Dimension

Returns:

double - double value ofAxial Detector Dimension

setCollimatorType

public void setCollimatorType(EnumCollimatorType enumCollimatorType)

Sets Collimator Type. Defined Terms: NONE = no collimator RING = transverse septa

Parameters:

enumCollimatorType - Enum value of Collimator Type.

getCollimatorType

public java.lang.String getCollimatorType()

Retrieves the Type of Collimator.

Returns:

String - returns the type of Collimator

setCoincidenceWindowWidth

public void setCoincidenceWindowWidth(java.lang.String strCoincidenceWindowWidth)

Sets The width of the coincidence timing window, in nsec. The maximum time difference accepted between two single events.

Parameters:

strCoincidenceWindowWidth - String value of Coincidence Window Width.

getCoincidenceWindowWidth

public java.lang.String getCoincidenceWindowWidth()

Retrieves The width of the coincidence timing window, in nsec.

Returns:

String - String value of Coincidence Window Width

getEnergyWindowRangeSequence

public EnergyWindowRangeSequence getEnergyWindowRangeSequence()

Retrieves pre-initialized object of Energy Window RangeSequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

EnergyWindowRangeSequence - instance of Energy Window RangeSequence

setTableMotion

public void setTableMotion(EnumTableMotion enumTableMotion)

Sets Table Motion value. Defined terms: STATIC, DYNAMIC

Parameters:

enumTableMotion - Enum value of Table Motion

getTableMotion

public java.lang.String getTableMotion()

Return Table Motion.

Returns:

- String value of Table Motion

setTimeOfFlightInformationUsed

public void setTimeOfFlightInformationUsed(EnumTimeOfFlightInformationUsed enumTimeOfFlightInformationUsed)

Sets whether or not Time-of-Flight information was used in creationof the image.

Parameters:

enumTimeOfFlightInformationUsed - - Specifies Time of Flight InformationUsed

getTimeOfFlightInformationUsed

public java.lang.String getTimeOfFlightInformationUsed()

Returns whether or not Time-of-Flight information was used in creationof the image.

Returns:

String - String value of Time of Flight InformationUsed

getMandatoryViewandSliceProgressionDirectionMacro

public MandatoryViewandSliceProgressionDirectionMacro getMandatoryViewandSliceProgressionDirectionMacro()

Get the Instance of Mandatory View and Slice ProgressionDirection Macro Attributes .Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Mandatory View and Slice ProgressionDirection Macro Attributes

setIsocenterPosition

public void setIsocenterPosition(java.lang.String[] strIsocenterPosition)

Sets Isocenter Position

Parameters:

strIsocenterPosition - String value of Isocenter Position

getIsocenterPosition

public java.lang.String[] getIsocenterPosition()

Retrieves Isocenter Position

Returns:

String - value of Isocenter Position

setScanProgressionDirection

public void setScanProgressionDirection(java.lang.String strSUVType)

Sets the Value Type Defined in Terms of TEXT,NUMERIC,CODE,DATE,TIME,PNAME

Parameters:

strValueType - Specifies type of the value encoded in this Item

getScanProgressionDirection

public java.lang.String getScanProgressionDirection()

Retrieves type of the value encoded in this Item

Returns:

String - Type of the value encoded in this Item

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of Tags - returns the collection containing the tags