cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class IntravascularOCTImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IntravascularOCTImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class IntravascularOCTImageModule
extends Module

\* This module describes attributes in Intravascular OCT 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
IntravascularOCTImageModule(IDataSet objIDataSet) Creates Intravascular OCT Image Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDateTime() Retrieves The date and time that the acquisition of data started.
double	getAcquisitionDuration() Retrieves the scan time in seconds used to create all frames of an Intravascular Optical Coherence Tomography image..
java.lang.String	getAcquisitionNumber() Return the String value of the attribute Acquisition Number.
short	getBitsAllocated() Return the short value of the attribute Bits Allocated.
short	getBitsStored() Return the short value of the attribute 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.
short	getHighBit() Return the short value of the attribute High Bit.
java.lang.String	getImageComments() Retrieves User-defined comments about the image.
java.lang.String[]	getImageType() Return the String values of the attribute Image Type.
java.lang.String	getInterpolationType() Returns Interpolation Type
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() Return the String value of the attribute Photometric Interpretation.
java.lang.String	getPixelPresentation() Retrieves Pixel Presentation.
short	getPixelRepresentation() Retrieves the pixel representation.
java.lang.String	getPresentationLUTShape() Retrieves a subset of a conceptual Presentation LUT.
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.
java.lang.String	getRecommendedDisplayFrameRate() Retrieves recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.
java.lang.String	getReferencedColorPaletteInstanceUID() Retrieves the Referenced Color Palette Instance UID.
ReferencedInstanceSequence	getReferencedInstanceSequence() Retrieves pre-initialized object of Referenced Instance 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
short	getSamplesPerPixel() Return the short value of the attribute Samples Per Pixel.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
java.lang.String	getVolumetricProperties() Retrieves Volumetric Properties .
void	setAcquisitionDateTime(java.lang.String strAcquisitionDateTime) Sets The date and time that the acquisition of data started.
void	setAcquisitionDuration(double dAcquisitionDuration) Sets the scan time in seconds used to create all frames of an Intravascular Optical Coherence Tomography image..
void	setAcquisitionNumber(java.lang.String strAcquisitionNumber) Sets Acquisition Number A number identifying the single continuous gathering of data over a period of time that resulted in this image.
void	setBitsAllocated(EnumBitsAllocated enumBitsAllocated) Sets Bits Allocated Number of bits allocated for each pixel sample.
void	setBitsStored(EnumBitsStored enumBitsStored) Sets Bits Stored 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	setHighBit(short sHighBit) Sets High Bit 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 Type.
void	setInterpolationType(EnumInterpolationType enumInterpolationType) Sets Interpolation Type.
void	setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression) Sets a Lossy Image Compression.
void	setLossyImageCompressionMethod(java.lang.String[] arrStrLossyImageCompressionMethod) Sets Lossy Image Compression Method.
void	setLossyImageCompressionRatio(java.lang.String[] arrStrLossyImageCompressionRatio) Sets the approximate lossy compression ratio(s) that have been applied to this image.
void	setPhotometricInterpretation(java.lang.String strPhotometricInterpretation) Sets Photometric Interpretation.
void	setPixelPresentation(EnumPixelPresentation enumPixelPresentation) Sets Pixel Presentation.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Data representation of the pixel samples.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) Sets a Presentation LUT Shape Enumerated Values: IDENTITY - output is in P-Values
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	setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate) Sets recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.
void	setReferencedColorPaletteInstanceUID(java.lang.String strReferencedColorPaletteInstanceUID) Sets Referenced Color Palette Instance UID.
void	setSamplesPerPixel(short sSamplesPerPixel) Sets Samples Per Pixel.
void	setVolumetricProperties(EnumVolumetricProperties enumVolumetricProperties) Sets Volumetric Properties .
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

IntravascularOCTImageModule

public IntravascularOCTImageModule(IDataSet objIDataSet)

Creates Intravascular OCT Image Module with default initialization.

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)

Sets Image Type. Image identification characteristics.

Parameters:

arrStrImageType - :Image identification characteristics.

getImageType

public java.lang.String[] getImageType()

Return the String values of the attribute Image Type.

Returns:

String[] - returns the type of image

setVolumetricProperties

public void setVolumetricProperties(EnumVolumetricProperties enumVolumetricProperties)

Sets Volumetric Properties .

Parameters:

enumVolumetricProperties - the enum approval status

getVolumetricProperties

public java.lang.String getVolumetricProperties()

Retrieves Volumetric Properties .

Returns:

String - String value of Volumetric Properties.

setPixelPresentation

public void setPixelPresentation(EnumPixelPresentation enumPixelPresentation)

Sets Pixel Presentation.

Parameters:

enumPixelPresentation - the enum approval status

getPixelPresentation

public java.lang.String getPixelPresentation()

Retrieves Pixel Presentation.

Returns:

String - String value of Pixel Presentation.

setSamplesPerPixel

public void setSamplesPerPixel(short sSamplesPerPixel)

Sets Samples Per Pixel. Number of samples (planes) in this image.

Parameters:

sSamplesPerPixel - the s samples per pixel

getSamplesPerPixel

public short getSamplesPerPixel()

Return the short value of the attribute Samples Per Pixel.

Returns:

short - returns the Samples per pixel

setPhotometricInterpretation

public void setPhotometricInterpretation(java.lang.String strPhotometricInterpretation)

Sets Photometric Interpretation. Specifies the intended interpretation of the pixel data.

Parameters:

strPhotometricInterpretation - :String value Photometric Interpretation

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Return the String value of the attribute Photometric Interpretation.

Returns:

String - returns the Photometric Interpretation

setBitsAllocated

public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)

Sets Bits Allocated Number of bits allocated for each pixel sample.

Parameters:

enumBitsAllocated - the enum bits allocated

getBitsAllocated

public short getBitsAllocated()

Return the short value of the attribute Bits Allocated.

Returns:

short - returns teh Bits Allocated

setBitsStored

public void setBitsStored(EnumBitsStored enumBitsStored)

Sets Bits Stored Number of bits stored for each pixel sample.

Parameters:

enumBitsStored - the enum bits stored

getBitsStored

public short getBitsStored()

Return the short value of the attribute Bits Stored.

Returns:

short - returns the Number of Bits Stored

setHighBit

public void setHighBit(short sHighBit)

Sets High Bit Most significant bit for pixel sample data.

Parameters:

sHighBit - : Most significant bit for pixel sample data

getHighBit

public short getHighBit()

Return the short value of the attribute High Bit.

Returns:

short - returns High Bit

setAcquisitionDateTime

public void setAcquisitionDateTime(java.lang.String strAcquisitionDateTime)

Sets The date and time that the acquisition of data started.

Parameters:

strAcquisitionDateTime - String value of The date and time that the acquisition of data started.

getAcquisitionDateTime

public java.lang.String getAcquisitionDateTime()

Retrieves The date and time that the acquisition of data started.

Returns:

String - value of The date and time that the acquisition of data started.

setAcquisitionDuration

public void setAcquisitionDuration(double dAcquisitionDuration)

Sets the scan time in seconds used to create all frames of an Intravascular Optical Coherence Tomography image..

Parameters:

dAcquisitionDuration - - double value of Acquisition Duration.

getAcquisitionDuration

public double getAcquisitionDuration()

Retrieves the scan time in seconds used to create all frames of an Intravascular Optical Coherence Tomography image..

Returns:

double - double value of Acquisition Duration.

setAcquisitionNumber

public void setAcquisitionNumber(java.lang.String strAcquisitionNumber)

Sets Acquisition Number A number identifying the single continuous gathering of data over a period of time that 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

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

setPresentationLUTShape

public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)

Sets a Presentation LUT Shape 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

setLossyImageCompression

public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)

Sets a Lossy Image 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)

Sets Lossy Image Compression Method. A label for the lossy compression method(s) that have been appliedto this image. *

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

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

getReferencedInstanceSequence

public ReferencedInstanceSequence getReferencedInstanceSequence()

Retrieves pre-initialized object of Referenced Instance 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:

ReferencedInstanceSequence - instance of Referenced Instance Sequence.

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.

setRecommendedDisplayFrameRate

public void setRecommendedDisplayFrameRate(java.lang.String strRecommendedDisplayFrameRate)

Sets recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.

Parameters:

strRecommendedDisplayFrameRate - String value of Recommended Display Frame Rate.

getRecommendedDisplayFrameRate

public java.lang.String getRecommendedDisplayFrameRate()

Retrieves recommended rate at which the frames of a Multi-frame image should be displayed in frames/second.

Returns:

String - String value of Recommended Display Frame Rate.

setInterpolationType

public void setInterpolationType(EnumInterpolationType enumInterpolationType)

Sets Interpolation Type. The type of interpolation used for the Polar to Cartesian scan-conversion.

Parameters:

enumInterpolationType - enum value of Interpolation Type

getInterpolationType

public java.lang.String getInterpolationType()

Returns Interpolation Type

Returns:

String - value of Interpolation Type

setReferencedColorPaletteInstanceUID

public void setReferencedColorPaletteInstanceUID(java.lang.String strReferencedColorPaletteInstanceUID)

Sets Referenced Color Palette Instance UID.

Parameters:

strReferencedColorPaletteInstanceUID - - Referenced Color Palette Instance UID.

getReferencedColorPaletteInstanceUID

public java.lang.String getReferencedColorPaletteInstanceUID()

Retrieves the Referenced Color Palette Instance UID.

Returns:

- returns the Referenced Color Palette Instance UID

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of Tags - returns the collection containing the tags