NMImageModule

java.lang.Object
- cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module
- - cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NMImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable
```
public class NMImageModule
extends Module
```
\* This module contains the Attributes that describe Nuclear Medicine Images.

Field Summary

Fields
Modifier and Type Field and Description

static ISingleCollection<ITag> objSingleCollection
The obj single collection.

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

Constructor Summary

Constructors
Constructor and Description

NMImageModule(IDataSet objIDataSet)
Instantiates a new nM image module.

Constructors
Constructor and Description
`NMImageModule(IDataSet objIDataSet)` Instantiates a new nM image module.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcquisitionTerminationCondition()` Returns Description of how the data collection was stopped.
`java.lang.String`	`getActualFrameDuration()` Returns Elapsed time for data acquisition in msec.
`java.lang.String[]`	`getCorrectedImage()` Returns a value that indicates which, if any, corrections have been applied to the image.
`java.lang.String`	`getCountRate()` Returns Maximum count rate achieved during the acquisition in counts/sec.
`java.lang.String`	`getCountsAccumulated()` Returns Sum of all gamma events for all frames in the image.
`GeneralAnatomyOptionalMacro`	`getGeneralAnatomyOptionalMacro()` Retrieves the instance of GeneralAnatomyOptionalMacro.
`java.lang.String`	`getImageID()` Returns User or equipment generated Image identifier.
`java.lang.String[]`	`getImageType()` Returns Image identification characteristics.
`java.lang.String`	`getLossImageCompression()` Returns value that specifies whether an Image has undergone lossy compression.
`java.lang.String`	`getProcessingFunction()` Returns Code or description of processing functions applied to the data.
`ReferencedCurveSequence`	`getReferencedCurveSequence()` Returns a sequence which provides reference to a set of SOP Class/Instance pairs which are related independent Curves.
`ReferencedOverlaySequence`	`getReferencedOverlaySequence()` Returns a sequence which provides reference to a set of SOP Class/Instance pairs which are related independent Overlays.
`java.lang.String`	`getScanLength()` Returns size of the imaged area in the direction of scanning motion, in mm.
`java.lang.String`	`getScanVelocity()` Returns the speed of the camera motion over the body in mm/sec.
`java.lang.String`	`getTableHeight()` Returns the height of the patient table in mm.
`java.lang.String`	`getTableTraverse()` Returns Location of the patient table (or gantry relative to the table) in mm.
`java.lang.String`	`getTriggerSourceOrType()` Returns Text indicating trigger source.
`ISingleCollection<ITag>`	`getVectorOfKeys()` This method returns the vector of keys representing the DataElements that belong to this module.
`java.lang.String[]`	`getWholeBodyTechnique()` Returns the type of scan performed.
`void`	`setAcquisitionTerminationCondition(EnumAcquisitionTerminationCondition enumAcquisitionTerminationCondition)` Sets Description of how the data collection was stopped.
`void`	`setActualFrameDuration(java.lang.String strActualFrameDuration)` Sets Elapsed time for data acquisition in msec.
`void`	`setCorrectedImage(EnumCorrectedImage[] enumCorrectedImage)` Sets a value that indicates which, if any, corrections have been applied to the image.
`void`	`setCountRate(java.lang.String strCountRate)` Sets Maximum count rate achieved during the acquisition in counts/sec.
`void`	`setCountsAccumulated(java.lang.String strCountsAccumulated)` Sets Sum of all gamma events for all frames in the image.
`void`	`setImageID(java.lang.String strImageID)` Sets User or equipment generated Image identifier.
`void`	`setImageType(java.lang.String[] arrStrImageType)` Sets Image identification characteristics.
`void`	`setLossImageCompression(EnumLossyImageCompression enumLossyImageCompression)` Sets value that specifies whether an Image has undergone lossy compression.
`void`	`setProcessingFunction(java.lang.String strProcessingFunction)` Sets Code or description of processing functions applied to the data.
`void`	`setScanLength(java.lang.String strScanLength)` Sets size of the imaged area in the direction of scanning motion, in mm.
`void`	`setScanVelocity(java.lang.String strScanVelocity)` Sets the speed of the camera motion over the body in mm/sec.
`void`	`setTableHeight(java.lang.String strTableHeight)` Sets the height of the patient table in mm.
`void`	`setTableTraverse(java.lang.String strTableTraverse)` Sets Location of the patient table (or gantry relative to the table) in mm.
`void`	`setTriggerSourceOrType(EnumTriggerSourceOrType enumTriggerSourceOrType)` Sets Text indicating trigger source.
`void`	`setWholeBodyTechnique(EnumWholeBodyTechnique[] enumWholeBodyTechnique)` Sets the type of scan performed.
`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
  - NMImageModule
```
public NMImageModule(IDataSet objIDataSet)
```
    Instantiates a new nM image 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:
    true, if validate module
    
    Throws:
    
    InvalidModuleException - - If validation of Module fails
  - setImageType
```
public void setImageType(java.lang.String[] arrStrImageType)
```
    Sets Image identification characteristics.
    
    Parameters:
    arrStrImageType - : String array of Image identification characteristics.
  - setImageID
```
public void setImageID(java.lang.String strImageID)
```
    Sets User or equipment generated Image identifier.
    
    Parameters:
    strImageID - - specifies the Image identifier
  - setLossImageCompression
```
public void setLossImageCompression(EnumLossyImageCompression enumLossyImageCompression)
```
    Sets value that specifies whether an Image has undergone lossy compression. Enumerated Values: 00 = Image has NOT been subjected to lossy compression. 01 = Image has been subjected to lossy compression.
    
    Parameters:
    enumLossyImageCompression - - Specifies if image is applied Lossy Compression
  - setCountsAccumulated
```
public void setCountsAccumulated(java.lang.String strCountsAccumulated)
```
    Sets Sum of all gamma events for all frames in the image.
    
    Parameters:
    strCountsAccumulated - - specifies Sum of all gamma events
  - 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
    
    Parameters:
    enumAcquisitionTerminationCondition - - Specifies how the data collection was stopped
  - setTableHeight
```
public void setTableHeight(java.lang.String strTableHeight)
```
    Sets the height of the patient table in mm. The range and values of this element are determined by the manufacturer. Should not be included if Image Type (0008,0008), Value 3, is TOMO, GATED TOMO, RECON TOMO or RECON GATED TOMO.
    
    Parameters:
    strTableHeight - - Specifies height of the patient table
  - setTableTraverse
```
public void setTableTraverse(java.lang.String strTableTraverse)
```
    Sets Location of the patient table (or gantry relative to the table) in mm. The range and values of this element are determined by the manufacturer. Should not be included if Image Type (0008,0008), Value 3, is TOMO, GATED TOMO, RECON TOMO or RECON GATED TOMO.
    
    Parameters:
    strTableTraverse - - Specifies Location of the patient table
  - setActualFrameDuration
```
public void setActualFrameDuration(java.lang.String strActualFrameDuration)
```
    Sets Elapsed time for data acquisition in msec. Required if Image Type (0008,0008) Value 3 is: WHOLE BODY or STATIC.
    
    Parameters:
    strActualFrameDuration - - specifies Elapsed time for data acquisition
  - setCountRate
```
public void setCountRate(java.lang.String strCountRate)
```
    Sets Maximum count rate achieved during the acquisition in counts/sec.
    
    Parameters:
    strCountRate - - String value of Count Rate
  - setProcessingFunction
```
public void setProcessingFunction(java.lang.String strProcessingFunction)
```
    Sets Code or description of processing functions applied to the data.
    
    Parameters:
    strProcessingFunction - - String value of Processing Function
  - setCorrectedImage
```
public void setCorrectedImage(EnumCorrectedImage[] enumCorrectedImage)
```
    Sets a value that indicates which, if any, corrections have been applied to the image. Corrections are applied to all frames in the image. Defined Terms: UNIF = flood corrected, COR = center of rotation corrected, NCO = non-circular orbit corrected, DECY = decay corrected, ATTN = attenuation corrected, SCAT = scatter corrected, DTIM = dead time corrected, NRGY = energy corrected, LIN = linearity corrected, MOTN = motion corrected, CLN = count loss normalization. Any type of normalization applied to correct for count loss in Time Slots.
    
    Parameters:
    enumCorrectedImage - - Enum array of Corrected Image.
  - setWholeBodyTechnique
```
public void setWholeBodyTechnique(EnumWholeBodyTechnique[] enumWholeBodyTechnique)
```
    Sets the type of scan performed. Used only if Image Type (0008,0008), Value 3, contains the value WHOLE BODY. Enumerated Values: 1PS = one pass, 2PS = two pass, PCN = patient contour following employed, MSP = multiple static frames collected into a whole body frame.
    
    Parameters:
    enumWholeBodyTechnique - - Enum array of Whole Body Technique.
  - setScanVelocity
```
public void setScanVelocity(java.lang.String strScanVelocity)
```
    Sets the speed of the camera motion over the body in mm/sec. Required if Image Type (0008,0008) Value 3 contains the value WHOLE BODY.
    
    Parameters:
    strScanVelocity - the str scan velocity
  - setScanLength
```
public void setScanLength(java.lang.String strScanLength)
```
    Sets size of the imaged area in the direction of scanning motion, in mm. Required if Image Type (0008,0008) Value 3 contains the value WHOLE BODY.
    
    Parameters:
    strScanLength - - String value of Scan Length.
  - getReferencedOverlaySequence
```
public ReferencedOverlaySequence getReferencedOverlaySequence()
```
    Returns a sequence which provides reference to a set of SOP Class/Instance pairs which are related independent Overlays. Uniquely identifies Overlays significantly related toth is Image. Zero or more Items may be included in this sequence.
    
    Returns:
    - instance of ReferencedOverlaySequence.
  - getReferencedCurveSequence
```
public ReferencedCurveSequence getReferencedCurveSequence()
```
    Returns a sequence which provides reference to a set of SOP Class/Instance pairs which are related independent Curves. Uniquely identifies Curves significantly related to this Image. Zero or more Items may be included in this sequence.
    
    Returns:
    - intance of ReferencedCurveSequence.
  - setTriggerSourceOrType
```
public void setTriggerSourceOrType(EnumTriggerSourceOrType enumTriggerSourceOrType)
```
    Sets Text indicating trigger source. Defined Term: EKG
    
    Parameters:
    enumTriggerSourceOrType - - enum value of Trigger Source Or Type.
  - getImageType
```
public java.lang.String[] getImageType()
```
    Returns Image identification characteristics.
    
    Returns:
    String[] - String array of Image identification characteristics.
  - getImageID
```
public java.lang.String getImageID()
```
    Returns User or equipment generated Image identifier.
    
    Returns:
    String - String value of Image ID
  - getLossImageCompression
```
public java.lang.String getLossImageCompression()
```
    Returns value that specifies whether an Image has undergone lossy compression.
    
    Returns:
    String - String value that specifies Loss Image Compression
  - getCountsAccumulated
```
public java.lang.String getCountsAccumulated()
```
    Returns Sum of all gamma events for all frames in the image.
    
    Returns:
    String - String value of Counts Accumulated.
  - getAcquisitionTerminationCondition
```
public java.lang.String getAcquisitionTerminationCondition()
```
    Returns Description of how the data collection was stopped.
    
    Returns:
    String - String value of Acquisition Termination Condition
  - getTableHeight
```
public java.lang.String getTableHeight()
```
    Returns the height of the patient table in mm.
    
    Returns:
    String - String value of Table Height.
  - getTableTraverse
```
public java.lang.String getTableTraverse()
```
    Returns Location of the patient table (or gantry relative to the table) in mm.
    
    Returns:
    String - String value of Table Traverse.
  - getActualFrameDuration
```
public java.lang.String getActualFrameDuration()
```
    Returns Elapsed time for data acquisition in msec.
    
    Returns:
    String - String value of Actual Frame Duration.
  - getCountRate
```
public java.lang.String getCountRate()
```
    Returns Maximum count rate achieved during the acquisition in counts/sec.
    
    Returns:
    String - String value of Count Rate.
  - getProcessingFunction
```
public java.lang.String getProcessingFunction()
```
    Returns Code or description of processing functions applied to the data.
    
    Returns:
    String - String value of Processing Function.
  - getCorrectedImage
```
public java.lang.String[] getCorrectedImage()
```
    Returns a value that indicates which, if any, corrections have been applied to the image.
    
    Returns:
    String[] - String array of Corrected Image.
  - getWholeBodyTechnique
```
public java.lang.String[] getWholeBodyTechnique()
```
    Returns the type of scan performed.
    
    Returns:
    String[] - String array of Whole Body Technique.
  - getScanVelocity
```
public java.lang.String getScanVelocity()
```
    Returns the speed of the camera motion over the body in mm/sec.
    
    Returns:
    String - String value of Scan Velocity.
  - getScanLength
```
public java.lang.String getScanLength()
```
    Returns size of the imaged area in the direction of scanning motion, in mm.
    
    Returns:
    String - String value of Scan Length.
  - getTriggerSourceOrType
```
public java.lang.String getTriggerSourceOrType()
```
    Returns Text indicating trigger source.
    
    Returns:
    String - String value of Trigger Source Or Type.
  - getGeneralAnatomyOptionalMacro
```
public GeneralAnatomyOptionalMacro getGeneralAnatomyOptionalMacro()
```
    Retrieves the instance of GeneralAnatomyOptionalMacro. If GeneralAnatomyOptionalMacro instance is NULL new instance is created and returned.
    
    Returns:
    - instance of GeneralAnatomyOptionalMacro
  - 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

Class NMImageModule

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

objSingleCollection

Constructor Detail

NMImageModule

Method Detail

validateModule

setImageType

setImageID

setLossImageCompression

setCountsAccumulated

setAcquisitionTerminationCondition

setTableHeight

setTableTraverse

setActualFrameDuration

setCountRate

setProcessingFunction

setCorrectedImage

setWholeBodyTechnique

setScanVelocity

setScanLength

getReferencedOverlaySequence

getReferencedCurveSequence

setTriggerSourceOrType

getImageType

getImageID

getLossImageCompression

getCountsAccumulated

getAcquisitionTerminationCondition

getTableHeight

getTableTraverse

getActualFrameDuration

getCountRate

getProcessingFunction

getCorrectedImage

getWholeBodyTechnique

getScanVelocity

getScanLength

getTriggerSourceOrType

getGeneralAnatomyOptionalMacro

getVectorOfKeys