cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class EnhancedXAOrXRFImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.EnhancedXAOrXRFImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class EnhancedXAOrXRFImageModule
extends Module

\* This module is used for Enhanced XA Or XRF 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
EnhancedXAOrXRFImageModule(IDataSet objIDataSet) Instantiates a new enhanced mr 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	getAcquisitionNumber() Return the String value of the attribute Acquisition Number.
java.lang.String	getAcquisitionProtocolDescription() Return Acquisition Protocol Description.
java.lang.String	getAcquisitionProtocolName() Retrieves Acquisition Protocol Name.
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.
java.lang.String	getContentQualification() Retrieves Content Qualification Indicator.
float	getExaminedBodyThickness() Retrieves ExaminedBodyThickness
short	getHighBit() Retrieves the high bit.
IconImageSequence	getIconImageSequence() Returns 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.
PatientGantryRelationshipCodeSequence	getPatientGantryRelationshipCodeSequence() Retrieves pre-initialized object of Patient Gantry RelationshipCode 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.
PatientOrientationCodeSequence	getPatientOrientationCodeSequence() Retrieves pre-initialized object of Patient Orientation Code 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.
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
short	getPixelRepresentation() Retrieves the pixel representation.
java.lang.String	getPlaneIdentification() Retrieves Plane Identification at the time the SOP Instance was created.
java.lang.String	getPlanesInAcquisition() Retrieves Planes in Acquisition at the time the SOP Instance was created.
java.lang.String	getPresentationLUTShape() Retrieves a subset of a conceptual Presentation LUT.
PurposeOfReferenceCodeSequence	getPurposeOfReferenceCodeSequence() Retrieves pre-initialized object of Purpose Of Reference Code 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.
java.lang.String	getQualityControlImage() Retrieves the Quality Control Image.
java.lang.String	getRecognizableVisualFeatures() Retrieves Recognizable Visual Features.
ReferencedImageEvidenceSequence	getReferencedImageEvidenceSequence() This method provides the pre-initialized object of Referenced ImageEvidence Sequence.
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
ReferencedOtherPlaneSequence	getReferencedOtherPlaneSequence() This method provides the pre-initialized object of Referenced Other PlaneSequence.
short	getSamplesPerPixel() Retrieves the samples per pixel.
java.lang.String[]	getScanOptions() Return the String values of the attribute Scan Options.
SourceImageEvidenceSequence	getSourceImageEvidenceSequence() This method provides the pre-initialized object of Source Image EvidenceSequence.
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	setAcquisitionNumber(java.lang.String strAcquisitionNumber) Sets a number identifying the single continuous gathering of data over a period of time which resulted in this image.
void	setAcquisitionProtocolDescription(java.lang.String strAcquisitionProtocolDescription) Sets Acquisition Protocol Description.
void	setAcquisitionProtocolName(java.lang.String strAcquisitionProtocolName) Sets Acquisition Protocol Name.
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	setExaminedBodyThickness(float fExaminedBodyThickness) Sets ExaminedBodyThickness
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	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Data representation of the pixel samples.
void	setPlaneIdentification(EnumPlaneIdentification enumPlaneIdentification) Sets Plane Identification at the time the SOP Instance was created.
void	setPlanesInAcquisition(EnumPlanesInAcquisition enumPlanesInAcquisition) Sets Planes in Acquisition at the time the SOP Instance was created.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) Sets a subset of a conceptual Presentation LUT.
void	setQualityControlImage(EnumQualityControlImage enumQualityControlImage) The method is used to set whether or not this image is a quality control or phantom image.
void	setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures) Sets Recognizable Visual Features.
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) Sets Samples per Pixel (0028,0002) is the number of separate planes in the image.
void	setScanOptions(java.lang.String[] arrStrScanOptions) This method is used to set Parameters of scanning sequence.
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

EnhancedXAOrXRFImageModule

public EnhancedXAOrXRFImageModule(IDataSet objIDataSet)

Instantiates a new enhanced mr 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:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

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.

setPlanesInAcquisition

public void setPlanesInAcquisition(EnumPlanesInAcquisition enumPlanesInAcquisition)

Sets Planes in Acquisition at the time the SOP Instance was created. Enumerated Values: 1) SINGLE PLANE Image is a single plane acquisition 2 ) BIPLANE Image is part of a Bi-plane acquisition 3 ) UNDEFINED Image is created by using data from one or two planes (e.g., reconstructed projection). May only be used whenImage Type Value 1 equals DERIVED.

Parameters:

enumPlanesInAcquisition - the enum Planes in Acquisitions

getPlanesInAcquisition

public java.lang.String getPlanesInAcquisition()

Retrieves Planes in Acquisition at the time the SOP Instance was created.

Returns:

String - String value of Planes in Acquisition.

setPlaneIdentification

public void setPlaneIdentification(EnumPlaneIdentification enumPlaneIdentification)

Sets Plane Identification at the time the SOP Instance was created. Enumerated Values: 1) MONOPLANE 2 ) PLANE A 3 ) PLANE B

Parameters:

enumPlaneIdentification - the enum Plane Identification

getPlaneIdentification

public java.lang.String getPlaneIdentification()

Retrieves Plane Identification at the time the SOP Instance was created.

Returns:

String - String value of Planes in Acquisition.

setAcquisitionNumber

public void setAcquisitionNumber(java.lang.String strAcquisitionNumber)

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

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

setSamplesPerPixel

public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)

Sets 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 - - specifies the samples per pixel in the image

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves the samples per pixel.

Returns:

short - returns the samples per pixel

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

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

Sets Specifies the intended interpretation of the pixel data.

Parameters:

enumPhotometricInterpretation - the enum photometric interpretation

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves the photometric interpretation.

Returns:

String - returns the photometric interpretation

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.

Parameters:

enumBitsAllocated - the enum bits allocated

getBitsAllocated

public short getBitsAllocated()

Retrieves the number of bits allocated.

Returns:

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

Parameters:

enumBitsStored - the enum bits stored

getBitsStored

public short getBitsStored()

Retrieves the number of bits stored.

Returns:

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

Short - returns the high bit

setAcquisitionProtocolName

public void setAcquisitionProtocolName(java.lang.String strAcquisitionProtocolName)

Sets Acquisition Protocol Name.

Parameters:

strAcquisitionProtocolName - String value of Acquisition Protocol Name.

getAcquisitionProtocolName

public java.lang.String getAcquisitionProtocolName()

Retrieves Acquisition Protocol Name.

Returns:

String - String value of Acquisition Protocol Name.

setAcquisitionProtocolDescription

public void setAcquisitionProtocolDescription(java.lang.String strAcquisitionProtocolDescription)

Sets Acquisition Protocol Description.

Parameters:

strAcquisitionProtocolDescription - - String value of Acquisition Protocol Description

getAcquisitionProtocolDescription

public java.lang.String getAcquisitionProtocolDescription()

Return Acquisition Protocol Description.

Returns:

- String value of Acquisition Protocol Description

setScanOptions

public void setScanOptions(java.lang.String[] arrStrScanOptions)

This method is used to set Parameters of scanning sequence. 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:

arrStrScanOptions - :Parameters of scanning sequence.

getScanOptions

public java.lang.String[] getScanOptions()

Return the String values of the attribute Scan Options.

Returns:

String[] - returns the Scan Options

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.

getPatientOrientationCodeSequence

public PatientOrientationCodeSequence getPatientOrientationCodeSequence()

Retrieves pre-initialized object of Patient Orientation Code 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:

PatientOrientationCodeSequence - instance of Patient Orientation Code Sequence.

getPatientGantryRelationshipCodeSequence

public PatientGantryRelationshipCodeSequence getPatientGantryRelationshipCodeSequence()

Retrieves pre-initialized object of Patient Gantry RelationshipCode 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:

PatientGantryRelationshipCodeSequence - instance of Patient Gantry RelationshipCode Sequence.

setExaminedBodyThickness

public void setExaminedBodyThickness(float fExaminedBodyThickness)

Sets ExaminedBodyThickness

Parameters:

fExaminedBodyThickness - Float value of the ExaminedBodyThickness

getExaminedBodyThickness

public float getExaminedBodyThickness()

Retrieves ExaminedBodyThickness

Returns:

float - Float value of the ExaminedBodyThickness

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.

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

getLossyImageCompression

public java.lang.String getLossyImageCompression()

Retrieves the Lossy Image Compression.

Returns:

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

String [] - 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

getReferencedOtherPlaneSequence

public ReferencedOtherPlaneSequence getReferencedOtherPlaneSequence()

This method provides the pre-initialized object of Referenced Other PlaneSequence.

Returns:

- object of Referenced Other PlaneSequence. 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

getReferencedImageEvidenceSequence

public ReferencedImageEvidenceSequence getReferencedImageEvidenceSequence()

This method provides the pre-initialized object of Referenced ImageEvidence Sequence.

Returns:

- object of Referenced ImageEvidence 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

getSourceImageEvidenceSequence

public SourceImageEvidenceSequence getSourceImageEvidenceSequence()

This method provides the pre-initialized object of Source Image EvidenceSequence.

Returns:

- object of Source Image EvidenceSequence. 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

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.

getPurposeOfReferenceCodeSequence

public PurposeOfReferenceCodeSequence getPurposeOfReferenceCodeSequence()

Retrieves pre-initialized object of Purpose Of Reference Code 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:

PurposeOfReferenceCodeSequence - instance of PurposeOfReferenceCodeSequence.

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.

setQualityControlImage

public void setQualityControlImage(EnumQualityControlImage enumQualityControlImage)

The method is used to set whether or not this image is a quality control or phantom 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 Enumerated Values: YES NO

Parameters:

enumQualityControlImage - the enum quality control image

getQualityControlImage

public java.lang.String getQualityControlImage()

Retrieves the Quality Control Image.

Returns:

String - the Quality Control Image

getIconImageSequence

public IconImageSequence getIconImageSequence()

Returns provides the pre-initialized 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.

Returns:

IconImageSequence - instance of the icom image sequence.

setPresentationLUTShape

public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)

Sets a subset of a conceptual Presentation LUT. 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