EnhancedCTImageModule

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

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable
```
public class EnhancedCTImageModule
extends Module
```
\* This module specifies the attributes of the Enhanced CT Image Module.

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

EnhancedCTImageModule(IDataSet objIDataSet)
Instantiates a new enhanced ct image module.

Constructors
Constructor and Description
`EnhancedCTImageModule(IDataSet objIDataSet)` Instantiates a new enhanced ct image module.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcquisitionDatetime()` Retrieves the Date and Time of Acquisition.
`double`	`getAcquisitionDuration()` Retrieves the time in seconds needed to run the prescribed pulse sequence.
`java.lang.String`	`getAcquisitionNumber()` Return the String value of the attribute Acquisition Number.
`short`	`getBitsAllocated()` Retrieves the number of bits allocated.
`short`	`getBitsStored()` Retrieves the number of bits stored.
`java.lang.String`	`getBurnedInAnnotation()` Retrieves value that indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.
`CommonCTOrMRImageDescriptionMacro`	`getCommonCTOrMRImageDescriptionMacro()` Retrieves pre-initialized instance of CommonCTOrMRImageDescriptionMacro.
`java.lang.String`	`getContentQualification()` Retrieves Content Qualification Indicator.
`short`	`getHighBit()` Retrieves the high bit.
`IconImageSequence`	`getIconImageSequence()` Returns provides the pre-initialized object of Icon Image Sequence.
`java.lang.String`	`getImageComments()` Retrieves User-defined comments about the image.
`java.lang.String[]`	`getImageType()` Return Image Type.
`java.lang.String[]`	`getIsocenterPosition()` Retrieves Isocenter Position.
`java.lang.String`	`getLossyImageCompression()` Retrieves the Lossy Image Compression.
`java.lang.String[]`	`getLossyImageCompressionRatio()` Retrieves the Lossy Image Compression.
`java.lang.String`	`getPhotometricInterpretation()` Retrieves the photometric interpretation.
`java.lang.String`	`getPresentationLUTShape()` Retrieves a subset of a conceptual Presentation LUT.
`java.lang.String`	`getRecognizableVisualFeatures()` Retrieves Recognizable Visual Features.
`ReferencedGrayscalePresentationStateSequence`	`getReferencedGrayscalePresentationStateSequence()` Retrieves References to Grayscale Presentation State instances acquired in conjunction with this instance.
`ReferencedImageEvidenceSequence`	`getReferencedImageEvidenceSequence()` Retrieves full set of Composite SOP Instances referred to inside the Referenced Image Sequences of this Enhanced MR Image SOP Instance.
`ReferencedRawDataSequence`	`getReferencedRawDataSequence()` Retrieves a sequence that identifies the set of Raw Data SOP Class/Instance pairs of the Raw data which were used to derive this Image.
`ReferencedWaveformSequence`	`getReferencedWaveformSequence()` Retrieves a sequence of waveforms acquired in conjunction with this image.
`RTEquipmentCorrelationMacro`	`getRTEquipmentCorrelationMacro()` Retrieves pre-initialized instance of RTEquipmentCorrelationMacro.
`short`	`getSamplesPerPixel()` Retrieves the samples per pixel.
`SourceImageEvidenceSequence`	`getSourceImageEvidenceSequence()` Retrieves full set of Composite SOP Instances used as source image SOP Instances inside the frames of this Enhanced CT Image SOP Instance.
`ISingleCollection<ITag>`	`getVectorOfKeys()` This method returns the vector of keys representing the DataElements that belong to this module.
`void`	`setAcquisitionDatetime(java.lang.String strAcquisitionDatetime)` The method is used to set The Date and Time the acquisition of data that resulted in this image started The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
`void`	`setAcquisitionDuration(double dAcquisitionDuration)` Sets the time in seconds needed to run the prescribed pulse sequence.
`void`	`setAcquisitionNumber(java.lang.String strAcquisitionNumber)` Sets a number identifying the single continuous gathering of data over a period of time which resulted in this image.
`void`	`setBitsAllocated(EnumBitsAllocated enumBitsAllocated)` Sets Number of bits allocated for each pixel sample.
`void`	`setBitsStored(EnumBitsStored enumBitsStored)` Sets Number of bits stored for each pixel sample.
`void`	`setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation)` Sets value that indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.
`void`	`setContentQualification(EnumContentQualification enumContentQualification)` Sets Content Qualification Indicator.
`void`	`setHighBit(EnumHighBit enumHighBit)` Sets Most significant bit for pixel sample data.
`void`	`setImageComments(java.lang.String strImageComments)` Sets User-defined comments about the image.
`void`	`setImageType(java.lang.String[] arrStrImageType)` Sets Image identification characteristics.
`void`	`setIsocenterPosition(java.lang.String[] strIsocenterPositionString)` Sets Isocenter Position
`void`	`setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)` Sets a value that specifies whether an Image has undergone lossy compression.
`void`	`setLossyImageCompressionRatio(java.lang.String[] arrStrLossyImageCompressionRatio)` Sets the approximate lossy compression ratio(s) that have been applied to this image.
`void`	`setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)` Sets Specifies the intended interpretation of the pixel data.
`void`	`setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)` Sets a subset of a conceptual Presentation LUT.
`void`	`setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures)` Sets Recognizable Visual Features.
`void`	`setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)` Sets Samples per Pixel (0028,0002) is the number of separate planes in the image.
`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
  - EnhancedCTImageModule
```
public EnhancedCTImageModule(IDataSet objIDataSet)
```
    Instantiates a new enhanced ct 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:
    Boolean - status indicating success or failure
    
    Throws:
    
    InvalidModuleException - - Throws when validation for any Module.
  - setImageType
```
public void setImageType(java.lang.String[] arrStrImageType)
```
    Sets Image identification characteristics.
    
    Parameters:
    arrStrImageType - - String array of Image identification characteristics.
  - getImageType
```
public java.lang.String[] getImageType()
```
    Return Image Type.
    
    Returns:
    String[]- String array of Image identification characteristics.
  - setAcquisitionNumber
```
public void setAcquisitionNumber(java.lang.String strAcquisitionNumber)
```
    Sets a number identifying the single continuous gathering of data over a period of time which resulted in this image.
    
    Parameters:
    strAcquisitionNumber - - String value of Acquisition Number.
  - getAcquisitionNumber
```
public java.lang.String getAcquisitionNumber()
```
    Return the String value of the attribute Acquisition Number.
    
    Returns:
    String - returns the Acquisition Number
  - setAcquisitionDatetime
```
public void setAcquisitionDatetime(java.lang.String strAcquisitionDatetime)
```
    The method is used to set The Date and Time the acquisition of data that resulted in this image started The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap
    
    Parameters:
    strAcquisitionDatetime - - String value of Acquisition Date and Time
  - getAcquisitionDatetime
```
public java.lang.String getAcquisitionDatetime()
```
    Retrieves the Date and Time of Acquisition.
    
    Returns:
    String - returns the Date and Time of Acquisition
  - setAcquisitionDuration
```
public void setAcquisitionDuration(double dAcquisitionDuration)
```
    Sets the time in seconds needed to run the prescribed pulse sequence.
    
    Parameters:
    dAcquisitionDuration - - double value of Acquisition Duration.
  - getAcquisitionDuration
```
public double getAcquisitionDuration()
```
    Retrieves the time in seconds needed to run the prescribed pulse sequence.
    
    Returns:
    double - double value of Acquisition Duration.
  - getReferencedRawDataSequence
```
public ReferencedRawDataSequence getReferencedRawDataSequence()
```
    Retrieves a sequence that identifies the set of Raw Data SOP Class/Instance pairs of the Raw data which were used to derive this Image.
    
    Returns:
    ReferencedRawDataSequence - instance of ReferencedRawDataSequence.
  - getReferencedWaveformSequence
```
public ReferencedWaveformSequence getReferencedWaveformSequence()
```
    Retrieves a sequence of waveforms acquired in conjunction with this image. These Waveforms may or may not be temporally synchronized with this image.
    
    Returns:
    ReferencedWaveformSequence - instance of ReferencedWaveformSequence.
  - getReferencedImageEvidenceSequence
```
public ReferencedImageEvidenceSequence getReferencedImageEvidenceSequence()
```
    Retrieves full set of Composite SOP Instances referred to inside the Referenced Image Sequences of this Enhanced MR Image SOP Instance.
    
    Returns:
    ReferencedImageEvidenceSequence - instance of ReferencedImageEvidenceSequence.
  - getSourceImageEvidenceSequence
```
public SourceImageEvidenceSequence getSourceImageEvidenceSequence()
```
    Retrieves full set of Composite SOP Instances used as source image SOP Instances inside the frames of this Enhanced CT Image SOP Instance.
    
    Returns:
    SourceImageEvidenceSequence - instance of SourceImageEvidenceSequence.
  - getReferencedGrayscalePresentationStateSequence
```
public ReferencedGrayscalePresentationStateSequence getReferencedGrayscalePresentationStateSequence()
```
    Retrieves References to Grayscale Presentation State instances acquired in conjunction with this instance.
    
    Returns:
    ReferencedGrayscalePresentationStateSequence - instance of ReferencedGrayscalePresentationStateSequence.
  - setSamplesPerPixel
```
public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)
```
    Sets Samples per Pixel (0028,0002) is the number of separate planes in the image. One, three, and four image planes are defined. For monochrome (gray scale) and palette color images, the number of planes is 1. For RGB and other three vector color models, the value of this attribute is 3. For four vector color models, the value of this attribute is 4.
    
    Parameters:
    enumSamplesPerPixel - - specifies the samples per pixel in the image
  - getSamplesPerPixel
```
public short getSamplesPerPixel()
```
    Retrieves the samples per pixel.
    
    Returns:
    Short - returns the samples per pixel
  - setPhotometricInterpretation
```
public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)
```
    Sets Specifies the intended interpretation of the pixel data.
    
    Parameters:
    enumPhotometricInterpretation - - Enum value Photometric Interpretation
  - getPhotometricInterpretation
```
public java.lang.String getPhotometricInterpretation()
```
    Retrieves the photometric interpretation.
    
    Returns:
    String - returns the photometric interpretation
  - setBitsAllocated
```
public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)
```
    Sets Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated.
    
    Parameters:
    enumBitsAllocated - - specifies the number of bits allocated
  - getBitsAllocated
```
public short getBitsAllocated()
```
    Retrieves the number of bits allocated.
    
    Returns:
    Short - returns the number of bits allocated
  - setBitsStored
```
public void setBitsStored(EnumBitsStored enumBitsStored)
```
    Sets Number of bits stored for each pixel sample. Each sample shall have the same number of bits stored.
    
    Parameters:
    enumBitsStored - - specifies the number of bits stored
  - getBitsStored
```
public short getBitsStored()
```
    Retrieves the number of bits stored.
    
    Returns:
    Short - returns the number of bits stored
  - setHighBit
```
public void setHighBit(EnumHighBit enumHighBit)
```
    Sets Most significant bit for pixel sample data. Each sample shall have the same high bit.
    
    Parameters:
    enumHighBit - - specifies the high bit
  - getHighBit
```
public short getHighBit()
```
    Retrieves the high bit.
    
    Returns:
    Short - returns the high bit
  - setContentQualification
```
public void setContentQualification(EnumContentQualification enumContentQualification)
```
    Sets Content Qualification Indicator. Enumerated Values: 1) PRODUCT. 2) RESEARCH. 3) SERVICE.
    
    Parameters:
    enumContentQualification - - Enum value of Content Qualification.
  - getContentQualification
```
public java.lang.String getContentQualification()
```
    Retrieves Content Qualification Indicator.
    
    Returns:
    String - String value of Content Qualification.
  - setImageComments
```
public void setImageComments(java.lang.String strImageComments)
```
    Sets User-defined comments about the image.
    
    Parameters:
    strImageComments - - String value of Image Comments.
  - getImageComments
```
public java.lang.String getImageComments()
```
    Retrieves User-defined comments about the image.
    
    Returns:
    String - String value of Image Comments.
  - setBurnedInAnnotation
```
public void setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation)
```
    Sets value that indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired. Enumerated Values: YES NO
    
    Parameters:
    enumBurnedInAnnotation - the enum burned in annotation
  - getBurnedInAnnotation
```
public java.lang.String getBurnedInAnnotation()
```
    Retrieves value that indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.
    
    Returns:
    - String value of Burned In Annotation(Yes or No)
  - setRecognizableVisualFeatures
```
public void setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures)
```
    Sets Recognizable Visual Features. Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set of images to identify the patient. Enumerated Values: 1) YES 2) NO
    
    Parameters:
    enumRecognizableVisualFeatures - the enum Recognizable Visual Features
  - getRecognizableVisualFeatures
```
public java.lang.String getRecognizableVisualFeatures()
```
    Retrieves Recognizable Visual Features.
    
    Returns:
    String - String value of Recognizable Visual Features.
  - setLossyImageCompression
```
public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)
```
    Sets a 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 - the enum lossy image compression
  - getLossyImageCompression
```
public java.lang.String getLossyImageCompression()
```
    Retrieves the Lossy Image Compression.
    
    Returns:
    String - returns the Lossy Image Compression
  - setLossyImageCompressionRatio
```
public void setLossyImageCompressionRatio(java.lang.String[] arrStrLossyImageCompressionRatio)
```
    Sets the approximate lossy compression ratio(s) that have been applied to this image.
    
    Parameters:
    arrStrLossyImageCompressionRatio - - String array of Lossy Image Compression Ratio
  - getLossyImageCompressionRatio
```
public java.lang.String[] getLossyImageCompressionRatio()
```
    Retrieves the Lossy Image Compression.
    
    Returns:
    String[] - returns the Lossy Image Compression
  - setPresentationLUTShape
```
public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)
```
    Sets a subset of a conceptual Presentation LUT. Enumerated Values: IDENTITY - output is in P-Values.
    
    Parameters:
    enumPresentationLUTShape - the enum presentation lut shape
  - getPresentationLUTShape
```
public java.lang.String getPresentationLUTShape()
```
    Retrieves a subset of a conceptual Presentation LUT.
    
    Returns:
    - String value of Presentation LUT Shape
  - getIconImageSequence
```
public IconImageSequence getIconImageSequence()
```
    Returns provides the pre-initialized object of Icon Image Sequence. 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:
    IconImageSequence - instance of the icom image sequence.
  - setIsocenterPosition
```
public void setIsocenterPosition(java.lang.String[] strIsocenterPositionString)
```
    Sets Isocenter Position
    
    Parameters:
    strIsocenterPositionString - value of Isocenter Position.
  - getIsocenterPosition
```
public java.lang.String[] getIsocenterPosition()
```
    Retrieves Isocenter Position.
    
    Returns:
    String - value of Isocenter Position.
  - 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:
    ISingleCollection - the customized collection containing the dataelement tags that beling to this module
  - getCommonCTOrMRImageDescriptionMacro
```
public CommonCTOrMRImageDescriptionMacro getCommonCTOrMRImageDescriptionMacro()
```
    Retrieves pre-initialized instance of CommonCTOrMRImageDescriptionMacro.
    
    Returns:
    CommonCTOrMRImageDescriptionMacro - instance of CommonCTOrMRImageDescriptionMacro.
  - getRTEquipmentCorrelationMacro
```
public RTEquipmentCorrelationMacro getRTEquipmentCorrelationMacro()
```
    Retrieves pre-initialized instance of RTEquipmentCorrelationMacro.
    
    Returns:
    RTEquipmentCorrelationMacro - instance of RTEquipmentCorrelationMacro.

Class EnhancedCTImageModule

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

EnhancedCTImageModule

Method Detail

validateModule

setImageType

getImageType

setAcquisitionNumber

getAcquisitionNumber

setAcquisitionDatetime

getAcquisitionDatetime

setAcquisitionDuration

getAcquisitionDuration

getReferencedRawDataSequence

getReferencedWaveformSequence

getReferencedImageEvidenceSequence

getSourceImageEvidenceSequence

getReferencedGrayscalePresentationStateSequence

setSamplesPerPixel

getSamplesPerPixel

setPhotometricInterpretation

getPhotometricInterpretation

setBitsAllocated

getBitsAllocated

setBitsStored

getBitsStored

setHighBit

getHighBit

setContentQualification

getContentQualification

setImageComments

getImageComments

setBurnedInAnnotation

getBurnedInAnnotation

setRecognizableVisualFeatures

getRecognizableVisualFeatures

setLossyImageCompression

getLossyImageCompression

setLossyImageCompressionRatio

getLossyImageCompressionRatio

setPresentationLUTShape

getPresentationLUTShape

getIconImageSequence

setIsocenterPosition

getIsocenterPosition

getVectorOfKeys

getCommonCTOrMRImageDescriptionMacro

getRTEquipmentCorrelationMacro