cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XRay3DImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XRay3DImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XRay3DImageModule
extends Module

\* This module describes attributes related to X-Ray 3D 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
XRay3DImageModule(IDataSet objIDataSet) Creates Ophthalmic Tomography Image Module.

Method Summary

Methods

Modifier and Type	Method and Description
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.
CommonCTOrMRImageDescriptionMacro	getCommonCTOrMRImageDescriptionMacro() Retrieves pre-initialized instance of CommonCTOrMRImageDescriptionMacro.
java.lang.String	getContentQualification() Retrieves Content Qualification Indicator.
short	getHighBit() Retrieves the high bit.
IconImageSequence	getIconImageSequence() This method provides the pre-initialized object of Icon Image Sequence.
java.lang.String	getImageComments() Retrieves User-defined comments about the image.
java.lang.String[]	getImageType() Return Image 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() Retrieves the photometric interpretation.
java.lang.String	getPresentationLUTShape() Retrieves a subset of a conceptual Presentation LUT.
java.lang.String	getQualityControlImage() Retrieves Quality Control Image.
java.lang.String	getRecognizableVisualFeatures() Retrieves Recognizable Visual Features.
ReferencedImageEvidenceSequence	getReferencedImageEvidenceSequence() Retrieves full set of Composite SOP Instances referred to inside the Referenced Image Sequences of this Enhanced MR Image SOP Instance.
short	getSamplesPerPixel() Return the short value of the attribute Samples Per Pixel.
SourceIrradiationEventSequence	getSourceIrradiationEventSequence() This method provides the pre-initialized object of Source Irradiation EventSequence.
void	setApprovalStatus(EnumQualityControlImage enumQualityControlImage) Sets Quality Control Image.
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	setContentQualification(EnumContentQualification enumContentQualification) Sets Content Qualification Indicator.
void	setHighBit(EnumHighBit enumHighBit) Sets 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 identification characteristics.
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	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(short sSamplesPerPixel) 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.
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, getVectorOfKeys, 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

XRay3DImageModule

public XRay3DImageModule(IDataSet objIDataSet)

Creates Ophthalmic Tomography 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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getCommonCTOrMRImageDescriptionMacro

public CommonCTOrMRImageDescriptionMacro getCommonCTOrMRImageDescriptionMacro()

Retrieves pre-initialized instance of CommonCTOrMRImageDescriptionMacro.

Returns:

CommonCTOrMRImageDescriptionMacro - instance of CommonCTOrMRImageDescriptionMacro.

setImageType

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

Sets Image identification characteristics.

Parameters:

arrStrImageType - - String array of Image identification characteristics.

getImageType

public java.lang.String[] getImageType()

Return Image Type.

Returns:

String[]- String array of Image identification characteristics.

setSamplesPerPixel

public void setSamplesPerPixel(short sSamplesPerPixel)

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:

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

setContentQualification

public void setContentQualification(EnumContentQualification enumContentQualification)

Sets Content Qualification Indicator. Enumerated Values: 1) PRODUCT. 2) RESEARCH. 3) SERVICE.

Parameters:

enumContentQualification - - Enum value of Content Qualification.

getContentQualification

public java.lang.String getContentQualification()

Retrieves Content Qualification Indicator.

Returns:

String - String value of Content Qualification.

getReferencedImageEvidenceSequence

public ReferencedImageEvidenceSequence getReferencedImageEvidenceSequence()

Retrieves full set of Composite SOP Instances referred to inside the Referenced Image Sequences of this Enhanced MR Image SOP Instance.

Returns:

ReferencedImageEvidenceSequence - instance of ReferencedImageEvidenceSequence.

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

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

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

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.

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.

setApprovalStatus

public void setApprovalStatus(EnumQualityControlImage enumQualityControlImage)

Sets Quality Control Image. Enumerated Values: 1) YES 2) NO

Parameters:

enumQualityControlImage - the enum Quality Control Image

getQualityControlImage

public java.lang.String getQualityControlImage()

Retrieves Quality Control Image.

Returns:

String - String value of Quality Control Image.

getIconImageSequence

public IconImageSequence getIconImageSequence()

This method provides the pre-initialized object of Icon Image Sequence.

Returns:

- object of Icon Image 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

getSourceIrradiationEventSequence

public SourceIrradiationEventSequence getSourceIrradiationEventSequence()

This method provides the pre-initialized object of Source Irradiation EventSequence.

Returns:

- object of Source Irradiation EventSequence. 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