cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralImageModule
extends Module

This class specifies the Attributes that identify and describe an image within a particular series.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GeneralImageModule(IDataSet objIDataSet) Instantiates a new general image module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDate() Retrieves the Date and Date of Acquisition.
java.lang.String	getAcquisitionDatetime() Retrieves the Date and Time of Acquisition.
java.lang.String	getAcquisitionNumber() Retrieves the Acquisition Number.
java.lang.String	getAcquisitionTime() Retrieves the Date and Time of Acquisition.
java.lang.String	getBurnedInAnnotation() Retrieves the Burned In Annotation.
java.lang.String	getContentDate() Retrieves the Content Date.
java.lang.String	getContentTime() Retrieves the Content Time.
DerivationCodeSequence	getDerivationCodeSequence() This method Returns provides the pre-initialized object of Derivation Code Sequence return - object of Derivation Code Sequence.
java.lang.String	getDerivationDescription() Retrieves the derivation description.
IconImageSequence	getIconImageSequence() This method Returns provides the pre-initialized object of Icon Image Sequence return - object of Icon Image Sequence.
java.lang.String	getImageComments() Retrieves the Image Contents.
java.lang.String	getImagesInAcquisition() Retrieves the Images In Acquisition.
java.lang.String[]	getImageType() Retrieves the Tmage Type.
java.lang.String	getInstanceNumber() Retrieves the Instance number.
java.lang.String	getIrradiationEventUID() Retrieves the Irradiation Event UID.
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 Ratio.
java.lang.String[]	getPatientOrientation() Retrieves the Patient Orientation.
java.lang.String	getPresentationLUTShape() Retrieves the Presentation LUT shape.
java.lang.String	getQualityControlImage() Retrieves the Quality Control Image.
RealWorldValueMappingSequence	getRealWorldValueMappingSequence() This method provides the pre-initialized object of Real World Value Mapping Sequence.
ReferencedImageSequence	getReferencedImageSequence() This method Returns provides the pre-initialized object of Referenced Image Sequence return - object of Referenced Image Sequence.
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 custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setAcquisitionDate(java.lang.String strAcquisitionDate) The method is used to set The date 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	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) The method is used to set A number identifying the single continuous gathering of data over a period of time that resulted in this image.
void	setAcquisitionTime(java.lang.String strAcquisitionTime) The method is used to set The 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) The method is used to set Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.
void	setContentDate(java.lang.String strContentDate) The method is used to set The date on image pixel data creation started.
void	setContentTime(java.lang.String strContentTime) The method is used to set The time at which image pixel data creation started.
void	setDerivationDescription(java.lang.String strDerivationDescription) The method is used to set A text description of how this image was derived.
void	setImageComments(java.lang.String strImageComments) The method is used to set User-defined comments about the image The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setImagesInAcquisition(java.lang.String strImagesInAcquisition) The method is used to set Number of images that resulted from this acquisition of data The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setImageType(java.lang.String[] arrStrImageType) This method is used to set Image identification characteristics.
void	setInstanceNumber(java.lang.String strInstanceNumber) The method is used to set A number that identifies this image.
void	setIrradiationEventUID(java.lang.String strIrradiationEventUID) Sets Irradiation Event UID.
void	setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression) The method is used to set 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) The method is used to set the approximate lossy compression ratio(s) that have been applied to this image.
void	setPatientOrientation(EnumPatientOrientation[] enumStrPatientOrientation) The method is used to set Patient direction of the rows and columns of the image.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) The method is used to set identity transformation for the Presentation LUT.
void	setQualityControlImage(EnumQualityControlImage enumQualityControlImage) The method is used to set whether or not this image is a quality control or phantom image.
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

GeneralImageModule

public GeneralImageModule(IDataSet objIDataSet)

Instantiates a new general 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

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

setPatientOrientation

public void setPatientOrientation(EnumPatientOrientation[] enumStrPatientOrientation)

The method is used to set Patient direction of the rows and columns of the 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:

enumStrPatientOrientation - the enum str patient orientation

setContentDate

public void setContentDate(java.lang.String strContentDate)

The method is used to set The date on image pixel data creation 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:

strContentDate - - String value of Content Date

setContentTime

public void setContentTime(java.lang.String strContentTime)

The method is used to set The time at which image pixel data creation 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:

strContentTime - - String value of Content Time

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.

setAcquisitionNumber

public void setAcquisitionNumber(java.lang.String strAcquisitionNumber)

The method is used to set A number identifying the single continuous gathering of data over a period of time that resulted 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:

strAcquisitionNumber - - String value of Acquisition Number

setAcquisitionDate

public void setAcquisitionDate(java.lang.String strAcquisitionDate)

The method is used to set The date 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:

strAcquisitionDate - - String value of Acquisition Date

setAcquisitionTime

public void setAcquisitionTime(java.lang.String strAcquisitionTime)

The method is used to set The 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:

strAcquisitionTime - - String value of Acquisition Time

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

setDerivationDescription

public void setDerivationDescription(java.lang.String strDerivationDescription)

The method is used to set A text description of how this image was derived. 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:

strDerivationDescription - - String value of Derivation Description

setImagesInAcquisition

public void setImagesInAcquisition(java.lang.String strImagesInAcquisition)

The method is used to set Number of images that resulted from this acquisition of 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:

strImagesInAcquisition - - String value of Images In Acquisition

setImageComments

public void setImageComments(java.lang.String strImageComments)

The method is used to set User-defined comments about the 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:

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

setBurnedInAnnotation

public void setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation)

The method is used to set Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired. 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:

enumBurnedInAnnotation - - Enum value of Burned In Annotation(Yes or No)

setLossyImageCompression

public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)

The method is used to set Specifies whether an Image has undergone lossy compression. 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: 00 = Image has NOT been subjected to lossy compression. 01 = Image has been subjected to lossy compression.

Parameters:

enumLossyImageCompression - the enum lossy image compression

setLossyImageCompressionRatio

public void setLossyImageCompressionRatio(java.lang.String[] arrStrLossyImageCompressionRatio)

The method is used to set the approximate lossy compression ratio(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:

arrStrLossyImageCompressionRatio - - String value of Lossy Image Compression Ratio

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

setPresentationLUTShape

public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)

The method is used to set identity transformation for the Presentation LUT. 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 are: IDENTITY - output is in P-Values - shall be used if Photometric Interpretation (0028,0004) is MONOCHROME2 or any color photometric interpretation. INVERSE - output after inversion is in PValues - shall be used if Photometric Interpretation (0028,0004) is MONOCHROME1.

Parameters:

enumPresentationLUTShape - the enum presentation lut shape

setIrradiationEventUID

public void setIrradiationEventUID(java.lang.String strIrradiationEventUID)

Sets Irradiation Event UID. Unique identification of the irradiation event(s) associated with the acquisition of this image.

Parameters:

strIrradiationEventUID - - Irradiation Event UID.

getReferencedImageSequence

public ReferencedImageSequence getReferencedImageSequence()

This method Returns provides the pre-initialized object of Referenced Image Sequence return - object of Referenced Image Sequence. If the module contans the sequence object it retruns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ReferencedImageSequence - the referenced image sequence

getDerivationDescription

public java.lang.String getDerivationDescription()

Retrieves the derivation description.

Returns:

String - the derivation description

getDerivationCodeSequence

public DerivationCodeSequence getDerivationCodeSequence()

This method Returns provides the pre-initialized object of Derivation Code Sequence return - object of Derivation Code Sequence. If the module contans the sequence object it retruns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

DerivationCodeSequence - the derivation code sequence

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

getIconImageSequence

public IconImageSequence getIconImageSequence()

This method Returns provides the pre-initialized object of Icon Image Sequence return - 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 - the icom image sequence

getImagesInAcquisition

public java.lang.String getImagesInAcquisition()

Retrieves the Images In Acquisition.

Returns:

String - returns the Images In Acquisition

getImageComments

public java.lang.String getImageComments()

Retrieves the Image Contents.

Returns:

String - returns the image contents

getQualityControlImage

public java.lang.String getQualityControlImage()

Retrieves the Quality Control Image.

Returns:

String - the Quality Control Image

getBurnedInAnnotation

public java.lang.String getBurnedInAnnotation()

Retrieves the Burned In Annotation.

Returns:

String - the Burned In Annotation

getLossyImageCompression

public java.lang.String getLossyImageCompression()

Retrieves the Lossy Image Compression.

Returns:

String - the Lossy Image Compression

getLossyImageCompressionRatio

public java.lang.String[] getLossyImageCompressionRatio()

Retrieves the Lossy Image Compression Ratio.

Returns:

String[] - the Lossy Image Compression Ratio

getLossyImageCompressionMethod

public java.lang.String[] getLossyImageCompressionMethod()

Retrieves the Lossy Image Compression Method.

Returns:

String[] - the Lossy Image Compression Method

getPresentationLUTShape

public java.lang.String getPresentationLUTShape()

Retrieves the Presentation LUT shape.

Returns:

String - the Presentation LUT shape

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves the Instance number.

Returns:

String - the instance number

getPatientOrientation

public java.lang.String[] getPatientOrientation()

Retrieves the Patient Orientation.

Returns:

String[] - the Patient Orientation

getContentDate

public java.lang.String getContentDate()

Retrieves the Content Date.

Returns:

String - the Content Date

getContentTime

public java.lang.String getContentTime()

Retrieves the Content Time.

Returns:

String - the Content Time

getImageType

public java.lang.String[] getImageType()

Retrieves the Tmage Type.

Returns:

String[] - the Image Type

getAcquisitionNumber

public java.lang.String getAcquisitionNumber()

Retrieves the Acquisition Number.

Returns:

String - Acquisition Number

getAcquisitionDate

public java.lang.String getAcquisitionDate()

Retrieves the Date and Date of Acquisition.

Returns:

String - the Date of Acquisition

getAcquisitionTime

public java.lang.String getAcquisitionTime()

Retrieves the Date and Time of Acquisition.

Returns:

String - the Time of Acquisition

getAcquisitionDatetime

public java.lang.String getAcquisitionDatetime()

Retrieves the Date and Time of Acquisition.

Returns:

String - returns the Date and Time of Acquisition

getIrradiationEventUID

public java.lang.String getIrradiationEventUID()

Retrieves the Irradiation Event UID. Unique identification of the irradiation event(s) associated with the acquisition of this image.

Returns:

- returns the Irradiation Event UID

getRealWorldValueMappingSequence

public RealWorldValueMappingSequence getRealWorldValueMappingSequence()

This method provides the pre-initialized object of Real World Value Mapping Sequence.

Returns:

- object of Real World Value Mapping 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

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

ISingleCollection - custom collection containing the list of DataElements belonging to the CT Image Module