cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class OphthalmicPhotographyImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OphthalmicPhotographyImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class OphthalmicPhotographyImageModule
extends Module

\* This module specifies the Attributes that describe an Ophthalmic Photography Image produced by Ophthalmic Photography equipment (OP) imaging Modalities.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OphthalmicPhotographyImageModule(IDataSet objIDataSet) Instantiates a new ophthalmic photography image module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDatetime() Retrieves the Date and Time of Acquisition.
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	getContentDate() Retrieves the date the document content creation started.
java.lang.String	getContentTime() Retrieves the time the document content creation started.
java.lang.String[]	getImageType() Retrieves the image Type.
java.lang.String	getInstanceNumber() Retrieves the Instance number.
java.lang.String	getLossyImageCompression() Retrieves the Lossy Image Compression.
java.lang.String[]	getLossyImageCompressionMethod() Retrieves the Lossy Image Compression Method.
java.lang.String[]	getLossyImageCompressionRatio() Retrieves the Lossy Image Compression.
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
short	getPixelRepresentation() Retrieves the pixel representation.
java.lang.String[]	getPixelSpacing() Retrieves physical distance in the patient between the center of each pixel.
short	getPlanarConfiguration() Retrieves the planar configuration.
java.lang.String	getPresentationLUTShape() Retrieves a subset of a conceptual Presentation LUT.
java.lang.String	getRecognizableVisualFeatures() Retrieves Recognizable Visual Features.
short	getSamplesPerPixel() Return the short value of the attribute Samples Per Pixel.
short	getSamplesPerPixelUsed() Return the number of samples (planes) containing information.
SourceImageSequence	getSourceImageSequence() This method Returns provides the pre-initialized object of Source Image Sequence return - object of Source Image Sequence.
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	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	setContentDate(java.lang.String strContentDate) Sets the date the document content creation started.
void	setContentTime(java.lang.String strContentTime) Sets the time the document content creation started.
void	setImageType(java.lang.String[] arrStrImageType) Sets Image identification characteristics.
void	setInstanceNumber(java.lang.String strInstanceNumber) The method is used to set A number that identifies this image.
void	setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression) Sets a value that specifies whether an Image has undergone lossy compression.
void	setLossyImageCompressionMethod(java.lang.String[] arrStrLossyImageCompressionMethod) The method is used to set lossy compression method(s) that have been applied to this image.
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	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Data representation of the pixel samples.
void	setPixelSpacing(java.lang.String[] arrStrPixelSpacing) Sets physical distance in the patient between the center of each pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing in mm.
void	setPlanarConfiguration(EnumPlanarConfiguration enumPlanarConfiguration) Indicates whether the pixel data are sent color-by-plane or color-by-pixel.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) Sets a subset of a conceptual Presentation LUT.This Attribute defines an identity transformation or inverse identity transformation.
void	setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures) Sets Recognizable Visual Features.
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) Method is used to set Number of samples (planes) in this image The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setSamplesPerPixelUsed(EnumSamplesPerPixelUsed enumSamplesPerPixelUsed) Method is used to The number of samples (planes) containing information.
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

OphthalmicPhotographyImageModule

public OphthalmicPhotographyImageModule(IDataSet objIDataSet)

Instantiates a new ophthalmic photography image module.

Parameters:

objIDataSet - the obj i data set

Method Detail

setImageType

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

Sets Image identification characteristics.

Parameters:

arrstrImageType - the arrstr image type

getImageType

public java.lang.String[] getImageType()

Retrieves the image Type.

Returns:

- returns the Image Type

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

The method is used to set A number that identifies this image. 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:

strInstanceNumber - - String value of Instance Number

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves the Instance number.

Returns:

String - the instance number

setSamplesPerPixel

public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)

Method is used to set Number of samples (planes) in this image 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:

enumSamplesPerPixel - the enum samples per pixel

getSamplesPerPixel

public short getSamplesPerPixel()

Return the short value of the attribute Samples Per Pixel.

Returns:

short - returns the Samples per pixel

setSamplesPerPixelUsed

public void setSamplesPerPixelUsed(EnumSamplesPerPixelUsed enumSamplesPerPixelUsed)

Method is used to The number of samples (planes) containing information. 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:

enumSamplesPerPixelUsed - the enum samples per pixel used

getSamplesPerPixelUsed

public short getSamplesPerPixelUsed()

Return the number of samples (planes) containing information.

Returns:

short - number of samples (planes) containing information

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

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:

short - returns the pixel representation

setPlanarConfiguration

public void setPlanarConfiguration(EnumPlanarConfiguration enumPlanarConfiguration)

Indicates whether the pixel data are sent color-by-plane or color-by-pixel.

Parameters:

enumPlanarConfiguration - the enum planar configuration

getPlanarConfiguration

public short getPlanarConfiguration()

Retrieves the planar configuration.

Returns:

short - returns the planar configuration

setPixelSpacing

public void setPixelSpacing(java.lang.String[] arrStrPixelSpacing)

Sets physical distance in the patient between the center of each pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing in mm.

Parameters:

arrStrPixelSpacing - : String array of Pixel Spacing.

getPixelSpacing

public java.lang.String[] getPixelSpacing()

Retrieves physical distance in the patient between the center of each pixel.

Returns:

String[] - String array of Pixel Spacing.

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets the time the document content creation started.

Parameters:

strContentTime - String value of time

getContentTime

public java.lang.String getContentTime()

Retrieves the time the document content creation started.

Returns:

String - String value of a time

setContentDate

public void setContentDate(java.lang.String strContentDate)

Sets the date the document content creation started.

Parameters:

strContentDate - String value of date

getContentDate

public java.lang.String getContentDate()

Retrieves the date the document content creation started.

Returns:

String - String value of a date

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

getSourceImageSequence

public SourceImageSequence getSourceImageSequence()

This method Returns provides the pre-initialized object of Source Image Sequence return - object of Source Image Sequence. If the module contans 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:

SourceImageSequence - the source image sequence

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

setLossyImageCompressionMethod

public void setLossyImageCompressionMethod(java.lang.String[] arrStrLossyImageCompressionMethod)

The method is used to set lossy compression method(s) that have been applied to this image. 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:

arrStrLossyImageCompressionMethod - - Lossy Image Compression Method

getLossyImageCompressionMethod

public java.lang.String[] getLossyImageCompressionMethod()

Retrieves the Lossy Image Compression Method.

Returns:

String[] - the Lossy Image Compression Method

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

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)

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.

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

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