cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class DXImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DXImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class DXImageModule
extends Module

\* This module contains IOD Attributes that describe a DX Image by specializing Attributes of the General Image and Image Pixel Modules, and adding additional Attributes.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DXImageModule(IDataSet objIDataSet) Instantiates a new dX image module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDeviceProcessingCode() Retrieves code representing the device-specific processing associated with the image.
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.
java.lang.String	getCalibrationImage() Return value that indicates whether a reference object (phantom) of known size is present in the image and was used for calibration.
java.lang.String	getDerivationDescription() Retrieves a text description of how this image was derived.
short	getHighBit() Retrieves the high bit.
java.lang.String[]	getImageType() Retrieves the image Type.
java.lang.String	getLossyImageCompression() Retrieves the Lossy Image Compression.
java.lang.String[]	getLossyImageCompressionRatio() Retrieves the Lossy Image Compression.
java.lang.String[]	getPatientOrientation() Retrieves patient direction of the rows and columns of the image.
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
java.lang.String	getPixelIntensityRelationship() Retrieves relationship between the Pixel sample values and the X-Ray beam intensity.
short	getPixelIntensityRelationshipSign() Retrieves sign of the relationship between the Pixel sample values stored in Pixel Data (7FE0,0010) and the X-Ray beam intensity.
short	getPixelRepresentation() Retrieves the pixel representation.
java.lang.String	getPresentationLUTShape() Retrieves a subset of a conceptual Presentation LUT.
java.lang.String	getRescaleIntercept() Retrieves Rescale Intercept.
java.lang.String	getRescaleScope() Retrieves m in the equation specified by Rescale Intercept (0028,1052).
java.lang.String	getRescaleType() Retrieves the output units of Rescale Slope (0028,1053) and Rescale Intercept(0028,1052).
short	getSamplesPerPixel() Retrieves the samples per pixel.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
VOILUTSequence	getVOILUTSequence() Returns a sequence of VOILUTs.
java.lang.String[]	getWindowCenter() Retrieves Window Center for display.
java.lang.String[]	getWindowCenterWidthExplanation() Retrieves Free form explanation of the meaning of the Window Center and Width.
java.lang.String[]	getWindowWidth() Retrieves Window Width for display.
void	setAcquisitionDeviceProcessingCode(java.lang.String strAcquisitionDeviceProcessingCode) Sets code representing the device-specific processing associated with the image (e.g.Organ Filtering code)
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	setCalibrationImage(EnumCalibrationImage enumCalibrationImage) Sets value that indicates whether a reference object (phantom) of known size is present in the image and was used for calibration.
void	setDerivationDescription(java.lang.String strDerivationDescription) Sets a text description of how this image was derived.
void	setHighBit(EnumHighBit enumHighBit) Sets Most significant bit for pixel sample data.
void	setImageType(java.lang.String[] arrStrImageType) Sets Image identification characteristics.
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	setPatientOrientation(java.lang.String[] arrStrPatientOrientation) Sets patient direction of the rows and columns of the image.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) Sets Specifies the intended interpretation of the pixel data.
void	setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship) Sets relationship between the Pixel sample values and the X-Ray beam intensity.
void	setPixelIntensityRelationshipSign(EnumPixelIntensityRelationshipSign enumPixelIntensityRelationshipSign) Sets the sign of the relationship between the Pixel sample values stored in Pixel Data (7FE0,0010) and the X-Ray beam intensity.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Data representation of the pixel samples.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) Sets a subset of a conceptual Presentation LUT.This Attribute defines an identity transformation or inverse identity transformation.
void	setRescaleIntercept(EnumRescaleIntercept enumRescaleIntercept) Sets the value b in the relationship between stored values (SV) in Pixel Data (7FE0,0010) and the output units specified in Rescale Type (0028,1054).
void	setRescaleScope(EnumRescaleScope enumRescaleScope) Sets m in the equation specified by Rescale Intercept (0028,1052).
void	setRescaleType(EnumRescaleType enumRescaleType) Sets the value taht specifies the output units of Rescale Slope (0028,1053) and Rescale Intercept(0028,1052).
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) Sets Samples per Pixel (0028,0002) is the number of separate planes in the image.
void	setWindowCenter(java.lang.String[] arrStrWindowCenter) Sets Window Center for display.
void	setWindowCenterWidthExplanation(java.lang.String[] arrStrWindowCenterWidthExplanation) Sets Free form explanation of the meaning of the Window Center and Width.
void	setWindowWidth(java.lang.String[] arrStrWindowWidth) Sets Window Width for display.
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

DXImageModule

public DXImageModule(IDataSet objIDataSet)

Instantiates a new dX 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:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setImageType

public void setImageType(java.lang.String[] arrStrImageType)

Sets Image identification characteristics.

Parameters:

arrStrImageType - :Image identification characteristics.

getImageType

public java.lang.String[] getImageType()

Retrieves the image Type.

Returns:

- returns the Image Type

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. Enumerated Value of 1.

Parameters:

enumSamplesPerPixel - the enum samples per pixel

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves the samples per pixel.

Returns:

- returns the samples per pixel

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

Sets Specifies the intended interpretation of the pixel data. Enumerated Values: MONOCHROME1 MONOCHROME2

Parameters:

enumPhotometricInterpretation - the enum photometric interpretation

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves the photometric interpretation.

Returns:

- 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. Enumerated Values: 8, 16

Parameters:

enumBitsAllocated - the enum bits allocated

getBitsAllocated

public short getBitsAllocated()

Retrieves the number of bits allocated.

Returns:

- 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. Enumerated Values: 6 to 16

Parameters:

enumBitsStored - the enum bits stored

getBitsStored

public short getBitsStored()

Retrieves the number of bits stored.

Returns:

- 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 - the enum high bit

getHighBit

public short getHighBit()

Retrieves the high bit.

Returns:

- returns the high bit

setPixelRepresentation

public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)

Sets Data representation of the pixel samples. Each sample shall have the same pixel representation. Enumerated Values: 0000H = unsigned integer. 0001H = 2's complement

Parameters:

enumPixelRepresentation - the enum pixel representation

getPixelRepresentation

public short getPixelRepresentation()

Retrieves the pixel representation.

Returns:

- returns the pixel representation

setPixelIntensityRelationship

public void setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship)

Sets relationship between the Pixel sample values and the X-Ray beam intensity.

Parameters:

enumPixelIntensityRelationship - the enum pixel intensity relationship

getPixelIntensityRelationship

public java.lang.String getPixelIntensityRelationship()

Retrieves relationship between the Pixel sample values and the X-Ray beam intensity.

Returns:

- String value of Pixel Intensity Relationship

setPixelIntensityRelationshipSign

public void setPixelIntensityRelationshipSign(EnumPixelIntensityRelationshipSign enumPixelIntensityRelationshipSign)

Sets the sign of the relationship between the Pixel sample values stored in Pixel Data (7FE0,0010) and the X-Ray beam intensity. Enumerated Values: 1 = Lower pixel values correspond to less X-Ray beam intensity, -1 = Higher pixel values correspond to less X-Ray beam intensity

Parameters:

enumPixelIntensityRelationshipSign - the enum pixel intensity relationship sign

getPixelIntensityRelationshipSign

public short getPixelIntensityRelationshipSign()

Retrieves sign of the relationship between the Pixel sample values stored in Pixel Data (7FE0,0010) and the X-Ray beam intensity.

Returns:

- String value of Pixel Intensity Relationship Sign

setRescaleIntercept

public void setRescaleIntercept(EnumRescaleIntercept enumRescaleIntercept)

Sets the value b in the relationship between stored values (SV) in Pixel Data (7FE0,0010) and the output units specified in Rescale Type (0028,1054). Output units = m*SV + b. Enumerated Value: 0

Parameters:

enumRescaleIntercept - the enum rescale intercept

getRescaleIntercept

public java.lang.String getRescaleIntercept()

Retrieves Rescale Intercept.

Returns:

- String value of Rescale Intercept

setRescaleScope

public void setRescaleScope(EnumRescaleScope enumRescaleScope)

Sets m in the equation specified by Rescale Intercept (0028,1052). Enumerated Value: 1

Parameters:

enumRescaleScope - the enum rescale scope

getRescaleScope

public java.lang.String getRescaleScope()

Retrieves m in the equation specified by Rescale Intercept (0028,1052).

Returns:

the rescale scope

setRescaleType

public void setRescaleType(EnumRescaleType enumRescaleType)

Sets the value taht specifies the output units of Rescale Slope (0028,1053) and Rescale Intercept(0028,1052). Required if Rescale Intercept is present. Enumerated Value: US = Unspecified

Parameters:

enumRescaleType - the enum rescale type

getRescaleType

public java.lang.String getRescaleType()

Retrieves the output units of Rescale Slope (0028,1053) and Rescale Intercept(0028,1052).

Returns:

- String value of Rescale Type

setPresentationLUTShape

public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)

Sets a subset of a conceptual Presentation LUT.This Attribute defines an identity transformation or inverse identity transformation. Enumerated Values: IDENTITY - output is in P-Values - shall be used if Photometric Interpretation (0028,0004) is MONOCHROME2. INVERSE - output after inversion is in PValues - shall be used if Photometric Interpretation (0028,0004) is MONOCHROME1.

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

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:

- 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:

- returns the Lossy Image Compression

setDerivationDescription

public void setDerivationDescription(java.lang.String strDerivationDescription)

Sets a text description of how this image was derived.

Parameters:

strDerivationDescription - - String value of Derivation Description

getDerivationDescription

public java.lang.String getDerivationDescription()

Retrieves a text description of how this image was derived.

Returns:

- returns the Lossy Image Compression

setAcquisitionDeviceProcessingCode

public void setAcquisitionDeviceProcessingCode(java.lang.String strAcquisitionDeviceProcessingCode)

Sets code representing the device-specific processing associated with the image (e.g.Organ Filtering code)

Parameters:

strAcquisitionDeviceProcessingCode - - String value of Acquisition Device Processing Code

getAcquisitionDeviceProcessingCode

public java.lang.String getAcquisitionDeviceProcessingCode()

Retrieves code representing the device-specific processing associated with the image.

Returns:

- String value of Acquisition Device Processing Code

setPatientOrientation

public void setPatientOrientation(java.lang.String[] arrStrPatientOrientation)

Sets patient direction of the rows and columns of the image.

Parameters:

arrStrPatientOrientation - - String array of Patient Orientation

getPatientOrientation

public java.lang.String[] getPatientOrientation()

Retrieves patient direction of the rows and columns of the image.

Returns:

- String array of Patient Orientation

setCalibrationImage

public void setCalibrationImage(EnumCalibrationImage enumCalibrationImage)

Sets value that indicates whether a reference object (phantom) of known size is present in the image and was used for calibration. Enumerated Values: YES,NO.

Parameters:

enumCalibrationImage - the enum calibration image

getCalibrationImage

public java.lang.String getCalibrationImage()

Return value that indicates whether a reference object (phantom) of known size is present in the image and was used for calibration.

Returns:

- String value of Calibration Image

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)

getVOILUTSequence

public VOILUTSequence getVOILUTSequence()

Returns a sequence of VOILUTs.

Returns:

- instance of VOILUT Sequence

setWindowCenter

public void setWindowCenter(java.lang.String[] arrStrWindowCenter)

Sets Window Center for display.

Parameters:

arrStrWindowCenter - - String value of Window Center for display.

getWindowCenter

public java.lang.String[] getWindowCenter()

Retrieves Window Center for display.

Returns:

- String array of Window Center

setWindowWidth

public void setWindowWidth(java.lang.String[] arrStrWindowWidth)

Sets Window Width for display.

Parameters:

arrStrWindowWidth - - String value of Window Width for display.

getWindowWidth

public java.lang.String[] getWindowWidth()

Retrieves Window Width for display.

Returns:

- String array of Window Width.

setWindowCenterWidthExplanation

public void setWindowCenterWidthExplanation(java.lang.String[] arrStrWindowCenterWidthExplanation)

Sets Free form explanation of the meaning of the Window Center and Width. Multiple values correspond to multiple Window Center and Width values.

Parameters:

arrStrWindowCenterWidthExplanation - - String array of Window Center and Width.

getWindowCenterWidthExplanation

public java.lang.String[] getWindowCenterWidthExplanation()

Retrieves Free form explanation of the meaning of the Window Center and Width.

Returns:

- String array of Window Center and Width Explanation

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:

- returns the customized collection containing the dataelement tags that belong to this module