cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PETCurveModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PETCurveModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PETCurveModule
extends Module

\* This module describes the attributes in PET Curve Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PETCurveModule(IDataSet objIDataSet) Creates PET Curve Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getAxisUnits() Retrieves Units of measure for the axes.
java.lang.String[]	getCountsIncluded() Retrieves Type of counts included in this count rate data.
ISingleCollection<byte[]>	getCurveData() Return value of the attribute Curve Data.
short	getCurveDimensions() Retrieves Number of dimensions for these data.
java.lang.String	getDeadTimeCorrectionFlag() Retrieves Dead Time Correction Flag.
java.lang.String	getProcessingFunction() Retrieves A textual description of the processing that has been applied to this curve.
java.lang.String	getTypeOfData() Retrieves Dead Time Correction Flag.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAxisUnits(EnumAxisUnits[] enumAxisUnits) Sets Units of measure for the axes.
void	setCountsIncluded(EnumCountsIncluded[] enumCountsIncluded) Sets Type of counts included in this count rate data.
void	setCurveData(ISingleCollection<byte[]> objCollectionOfCurveData) Sets Curve data.
void	setCurveDimensions(short shCurveDimensions) Sets Number of dimensions for these data.
void	setDeadTimeCorrectionFlag(EnumDeadTimeCorrectionFlag enumDeadTimeCorrectionFlag) Sets Dead time correction has been applied to Curve Data (50xx,3000).
void	setProcessingFunction(java.lang.String strProcessingFunction) Sets A textual description of the processing that has been applied to this curve.
void	setTypeOfData(EnumTypeOfData enumTypeOfData) Sets Type of data in this curve.
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

PETCurveModule

public PETCurveModule(IDataSet objIDataSet)

Creates PET Curve Module with default initialization.

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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setDeadTimeCorrectionFlag

public void setDeadTimeCorrectionFlag(EnumDeadTimeCorrectionFlag enumDeadTimeCorrectionFlag)

Sets Dead time correction has been applied to Curve Data (50xx,3000). Enumerated Values: Y = yes, N = no.

Parameters:

enumDeadTimeCorrectionFlag - Enum value of Dead Time Correction Flag

getDeadTimeCorrectionFlag

public java.lang.String getDeadTimeCorrectionFlag()

Retrieves Dead Time Correction Flag.

Returns:

String - returns Dead Time Correction Flag

setCountsIncluded

public void setCountsIncluded(EnumCountsIncluded[] enumCountsIncluded)

Sets Type of counts included in this count rate data. Defined terms: TRUES, SCATTER, RANDOMS, SINGLES.

Parameters:

enumCountsIncluded - Enum value of Counts Included.

getCountsIncluded

public java.lang.String[] getCountsIncluded()

Retrieves Type of counts included in this count rate data.

Returns:

the counts included

setProcessingFunction

public void setProcessingFunction(java.lang.String strProcessingFunction)

Sets A textual description of the processing that has been applied to this curve.

Parameters:

strProcessingFunction - String value of Processing Function

getProcessingFunction

public java.lang.String getProcessingFunction()

Retrieves A textual description of the processing that has been applied to this curve.

Returns:

String - String value of Processing Function.

setCurveDimensions

public void setCurveDimensions(short shCurveDimensions)

Sets Number of dimensions for these data.

Parameters:

shCurveDimensions - Short value of Curve Dimensions.

getCurveDimensions

public short getCurveDimensions()

Retrieves Number of dimensions for these data.

Returns:

short - Number of dimensions for these data.

setTypeOfData

public void setTypeOfData(EnumTypeOfData enumTypeOfData)

Sets Type of data in this curve. Defined Terms: SYSRATE = system count rate SLICERATE = slice count rate BLDSMPL = blood samples CPM = cardiac polar map

Parameters:

enumTypeOfData - Enum value of Type of Data

getTypeOfData

public java.lang.String getTypeOfData()

Retrieves Dead Time Correction Flag.

Returns:

String - returns Dead Time Correction Flag

setAxisUnits

public void setAxisUnits(EnumAxisUnits[] enumAxisUnits)

Sets Units of measure for the axes. Defined Terms: SEC = seconds,CNTS = counts,MM = millimeters,NONE = unitless,CM = centimeters,CM2 = cm**2,DEG = degrees, MILS = milliseconds,PCNT = percent,CPS = counts/second,BQML = Becquerels/milliliter,MGMINML = milligram/minute/milliliter, UMOLMINML = micromole/minute/milliliter,MLMING = milliliter/minute/gram,MLG = milliliter/gram,1CM = 1/centimeter, UMOLML = micromole/milliliter,PROPCNTS = proportional to counts,PROPCPS = proportional to counts/sec,MLMINML = milliliter/minute/milliliter, MLML = milliliter/milliliter,GML = grams/milliliter,STDDEV = standard deviations.

Parameters:

enumAxisUnits - Enum value of Units of measure for the axes.

getAxisUnits

public java.lang.String[] getAxisUnits()

Retrieves Units of measure for the axes.

Returns:

String - returns Units of measure for the axes.

setCurveData

public void setCurveData(ISingleCollection<byte[]> objCollectionOfCurveData)

Sets Curve data.

Parameters:

objCollectionOfCurveData - ISingle Collection of bytes.

getCurveData

public ISingleCollection<byte[]> getCurveData()

Return value of the attribute Curve Data.

Returns:

Collection of byte[] - returns the collection of Curve Data

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:

vector of Tags - returns the vector containing the collection of tags