cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class CornealTopographyMapImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CornealTopographyMapImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class CornealTopographyMapImageModule
extends Module

\* This module is used for Corneal Topography 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
CornealTopographyMapImageModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
BasicPixelSpacingCalibrationMacro	getBasicPixelSpacingCalibrationMacro() Get the Instance of Basic Pixel Spacing Calibration Macro Attributes .Calling this method multiple times will return the same Marco Instance that was created at first.
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.
java.lang.String	getContentDate() Retrieves date the data creation was started.
java.lang.String	getContentTime() Retrieves time the data creation was started.
GeneralAnatomyMandatoryMacro	getGeneralAnatomyMandatoryMacro() Get the Instance of General Anatomy Mandatory Macro .Calling this method multiple times will return the same Marco Instance that was created at first.
short	getHighBit() Most significant bit for pixel sample data.
java.lang.String	getImageLaterality() Returns Image Laterality
java.lang.String[]	getImageType() Returns Image identification characteristics.
java.lang.String	getInstanceNumber() Retrieves a number that identifies this presentation.
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.
java.lang.String[]	getPixelAspectRatio() Retrieves Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the verticalpixel size, and the second value is the horizontal pixel size.
java.lang.String	getPixelRepresentation() Returns Data representation of pixel samples.
RealWorldValueMappingMacro	getRealWorldValueMappingMacro() Get the Instance of RealWorldValueMappingMacroAttributes .Calling this method multiple times will return the same Marco Instance that was created at first.
java.lang.String	getRecognizableVisualFeatures() Returns Recognizable Visual Features
short	getSamplesPerPixel() Return the number of separate planes in the image.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
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	setContentDate(java.lang.String strContentDate) Sets date the data creation was started.
void	setContentTime(java.lang.String strContentTime) Sets time the data creation was started.
void	setHighBit(EnumHighBit enumHighBit) Most significant bit for pixel sample data.
void	setImageLaterality(EnumImageLaterality enumImageLaterality) Sets Image Laterality
void	setImageType(java.lang.String[] arrStrImageType) This method is used to set Image identification characteristics.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets a number that identifies this presentation (SOP Instance).
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	setPixelAspectRatio(java.lang.String strPixelAspectRatio) Sets Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the vertical pixel size, and the second value is the horizontal pixel size.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Data representation of pixel samples.
void	setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumBurnedInAnnotation) Sets Recognizable Visual Features
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

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

CornealTopographyMapImageModule

public CornealTopographyMapImageModule(IDataSet objIDataSet)

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

Throws:

InvalidModuleException

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets a number that identifies this presentation (SOP Instance).

Parameters:

strInstanceNumber - String value of number that identifies this presentation

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves a number that identifies this presentation.

Returns:

String - String value of a number that identifies this presentation.

setContentDate

public void setContentDate(java.lang.String strContentDate)

Sets date the data creation was started.

Parameters:

strContentDate - String value of date the data creation was started.

getContentDate

public java.lang.String getContentDate()

Retrieves date the data creation was started.

Returns:

String - value of date the data creation was started.

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets time the data creation was started.

Parameters:

strContentTime - String value of time the data creation was started.

getContentTime

public java.lang.String getContentTime()

Retrieves time the data creation was started.

Returns:

String - value of time the data creation was started.

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.

setSamplesPerPixel

public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)

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.

setPixelRepresentation

public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)

Sets Data representation of pixel samples.

Parameters:

enumPixelRepresentation - : Enum value of PixelRepresentation

getPixelRepresentation

public java.lang.String getPixelRepresentation()

Returns Data representation of pixel samples.

Returns:

String - String value of PixelRepresentation

getBasicPixelSpacingCalibrationMacro

public BasicPixelSpacingCalibrationMacro getBasicPixelSpacingCalibrationMacro()

Get the Instance of Basic Pixel Spacing Calibration Macro Attributes .Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Basic Pixel Spacing Calibration Macro Attributes which the user programmer can populate

setPixelAspectRatio

public void setPixelAspectRatio(java.lang.String strPixelAspectRatio)

Sets Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the vertical pixel size, and the second value is the horizontal pixel size.

Parameters:

strPixelAspectRatio - String Value OF Pixel Aspect Ratio

getPixelAspectRatio

public java.lang.String[] getPixelAspectRatio()

Retrieves Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the verticalpixel size, and the second value is the horizontal pixel size.

Returns:

String Array - Value component of Pixel Aspect Ratio

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.

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 enumBurnedInAnnotation)

Sets Recognizable Visual Features

Parameters:

enumRecognizableVisualFeatures - enum value of RecognizableVisualFeatures

getRecognizableVisualFeatures

public java.lang.String getRecognizableVisualFeatures()

Returns Recognizable Visual Features

Returns:

String - value of RecognizableVisualFeatures

setImageLaterality

public void setImageLaterality(EnumImageLaterality enumImageLaterality)

Sets Image Laterality

Parameters:

enumImageLaterality - enum value of ImageLaterality

getImageLaterality

public java.lang.String getImageLaterality()

Returns Image Laterality

Returns:

String - value of ImageLaterality

getRealWorldValueMappingMacro

public RealWorldValueMappingMacro getRealWorldValueMappingMacro()

Get the Instance of RealWorldValueMappingMacroAttributes .Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of RealWorldValueMappingMacro Attributes which the user programmer can populate

getGeneralAnatomyMandatoryMacro

public GeneralAnatomyMandatoryMacro getGeneralAnatomyMandatoryMacro()

Get the Instance of General Anatomy Mandatory Macro .Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of General Anatomy Mandatory Macro which the user programmer can populate

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