cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ParametricMapImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ParametricMapImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ParametricMapImageModule
extends Module

\* This module specifies the attributes of Parametric Map Image Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ParametricMapImageModule(IDataSet objIDataSet) Instantiates a new ParametricMapImageModule.

Method Summary

Methods

Modifier and Type	Method and Description
short	getBitsAllocated() Return Number of bits allocated for each pixel sample.
short	getBitsStored() Number of bits stored for each pixel sample.
java.lang.String	getBurnedInAnnotation() Returns Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.
ContentIdentificationMacro	getContentIdentificationMacro()
java.lang.String	getContentQualification() Returns ContentQualification
short	getHighBit() Most significant bit for pixel sample data.
java.lang.String[]	getImageType() Returns Image identification characteristics.
java.lang.String	getLossyImageCompression() Return whether an Image has undergone lossy compression.
java.lang.String[]	getLossyImageCompressionMethod() Retrieves Numeric Value component of LossyImageCompressionMethod
java.lang.String[]	getLossyImageCompressionRatio() Retrieves the approximate lossy compression ratio(s) that have been applied to this image.
java.lang.String	getPhotometricInterpretation() Return the intended interpretation of the pixel data.
short	getPresentationLUTShape() Retrieves PresentationLUTShape
java.lang.String	getRecognizableVisualFeatures() Returns Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.
short	getSamplesPerPixel() Return the number of separate planes in the image.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setBitsAllocated(EnumBitsAllocated enumBitsAllocated) Number of bits allocated for each pixel sample.
void	setBitsStored(EnumBitsStored enumBitsStored) Number of bits stored for each pixel sample.
void	setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation) Sets Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.
void	setContentQualification(EnumContentQualification enumContentQualification) Sets ContentQualification
void	setHighBit(EnumHighBit enumHighBit) Most significant bit for pixel sample data.
void	setImageType(java.lang.String[] arrStrImageType) This method is used to set Image identification characteristics.
void	setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression) Specifies whether an Image has undergone lossy compression.
void	setLossyImageCompressionMethod(java.lang.String strLossyImageCompressionMethod) Sets LossyImageCompressionMethod
void	setLossyImageCompressionRatio(java.lang.String[] strLossyImageCompressionRatio) Sets the approximate lossy compression ratio(s) that have been applied to this image.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) The method is used to set Specifies the intended interpretation of the pixel data.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) Sets the PresentationLUTShape
void	setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures) Sets Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) 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

ParametricMapImageModule

public ParametricMapImageModule(IDataSet objIDataSet)

Instantiates a new ParametricMapImageModule.

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)

This method is used to set Image identification characteristics. 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:

arrStrImageType - : Image identification characteristics.

getImageType

public java.lang.String[] getImageType()

Returns Image identification characteristics.

Returns:

String[] - String value of Image type.

getContentIdentificationMacro

public ContentIdentificationMacro getContentIdentificationMacro()

setSamplesPerPixel

public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)

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 - Number of samples (planes) in this image.

getSamplesPerPixel

public short getSamplesPerPixel()

Return the number of separate planes in the image.

Returns:

short - Short value of Samples Per Pixel.

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

The method is used to set Specifies the intended interpretation of the pixel data. 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:

enumPhotometricInterpretation - : Enum value of Photometric Interpretation

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Return the intended interpretation of the pixel data.

Returns:

String - String value of Photometric Interpretation.

setBitsAllocated

public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)

Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated.

Parameters:

enumBitsAllocated - Enum value of Bits Allocated.

getBitsAllocated

public short getBitsAllocated()

Return Number of bits allocated for each pixel sample.

Returns:

short - Short value of Bits Allocated.

setBitsStored

public void setBitsStored(EnumBitsStored enumBitsStored)

Number of bits stored for each pixel sample. Each sample shall have the same number of bits stored.

Parameters:

enumBitsStored - Enum value of Bits Stored.

getBitsStored

public short getBitsStored()

Number of bits stored for each pixel sample.

Returns:

short - short value of Bits Stored.

setHighBit

public void setHighBit(EnumHighBit enumHighBit)

Most significant bit for pixel sample data. Each sample shall have the same high bit.

Parameters:

enumHighBit - Enum value of high bit.

getHighBit

public short getHighBit()

Most significant bit for pixel sample data.

Returns:

short - Short value of High Bit.

setPresentationLUTShape

public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)

Sets the PresentationLUTShape

Parameters:

enumPresentationLUTShape - Enum value of PresentationLUTShape

getPresentationLUTShape

public short getPresentationLUTShape()

Retrieves PresentationLUTShape

Returns:

short - Short value of PresentationLUTShape

setLossyImageCompression

public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)

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 - Enum value of Lossy Image Compression.

getLossyImageCompression

public java.lang.String getLossyImageCompression()

Return whether an Image has undergone lossy compression.

Returns:

String - String value of Lossy Image Compression.

setLossyImageCompressionRatio

public void setLossyImageCompressionRatio(java.lang.String[] strLossyImageCompressionRatio)

Sets the approximate lossy compression ratio(s) that have been applied to this image.

Parameters:

strLossyImageCompressionRatio - String value of Lossy ImageCompression Ratio

getLossyImageCompressionRatio

public java.lang.String[] getLossyImageCompressionRatio()

Retrieves the approximate lossy compression ratio(s) that have been applied to this image.

Returns:

String - value of Lossy ImageCompression Ratio

setLossyImageCompressionMethod

public void setLossyImageCompressionMethod(java.lang.String strLossyImageCompressionMethod)

Sets LossyImageCompressionMethod

Parameters:

strLossyImageCompressionMethod - String Value component of LossyImageCompressionMethod

getLossyImageCompressionMethod

public java.lang.String[] getLossyImageCompressionMethod()

Retrieves Numeric Value component of LossyImageCompressionMethod

Returns:

String Array - Value component of LossyImageCompressionMethod

setBurnedInAnnotation

public void setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation)

Sets Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.

Parameters:

enumBurnedInAnnotation - enum value of BurnedInAnnotation

getBurnedInAnnotation

public java.lang.String getBurnedInAnnotation()

Returns Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.

Returns:

String - value of BurnedInAnnotation

setRecognizableVisualFeatures

public void setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures)

Sets Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.

Parameters:

enumRecognizableVisualFeatures - enum value of Recognizable VisualFeatures

getRecognizableVisualFeatures

public java.lang.String getRecognizableVisualFeatures()

Returns Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.

Returns:

String - value of Recognizable VisualFeatures

setContentQualification

public void setContentQualification(EnumContentQualification enumContentQualification)

Sets ContentQualification

Parameters:

enumContentQualification - enum value of ContentQualification

getContentQualification

public java.lang.String getContentQualification()

Returns ContentQualification

Returns:

String - value of ContentQualification

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

- the customized collection containing the dataelement tags that beling to this module