cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XRayImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XRayImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XRayImageModule
extends Module

\* This module describes attributes related to X-Ray Image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XRayImageModule(IDataSet objIDataSet) Instantiates a new x ray image module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDeviceProcessingDescription() Return value that Indicates any visual processing performed on the images prior to exchange.
short	getBitsAllocated() Retrieves the number of bits allocated.
short	getBitsStored() Retrieves the number of bits stored.
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	getDerivationDescription() Return a text description of how this image was derived.
short[]	getFrameDimensionPointer() Return value that contains the Data Element Tags of one or more attributes that vary or increment.
ISingleCollection<ITag>	getFrameIncrementPointer() Return value that is Used to specify multiple values for Frame Increment Pointer.
java.lang.String[]	getFrameLabelVector() Return multi-valued attribute that contains a descriptive label for each of the image.
GeneralAnatomyOptionalMacro	getGeneralAnatomyOptionalMacro() Retrieves the Instance of GeneralAnatomyOptionalMacro.
short	getHighBit() Retrieves the high bit.
java.lang.String[]	getImageType() Retrieves the Tmage Type.
java.lang.String	getLossyImageCompression() Retrieves the Lossy Image Compression.
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
java.lang.String	getPixelIntensityRelationship() Return relationship between the Pixel sample values and the X-Ray beam intensity.
short	getPixelRepresentation() Retrieves the pixel representation.
ReferencedImageSequence	getReferencedImageSequence() This method Returns provides the pre-initialized object of Referenced Image Sequence return objReferencedImageSequence - object of Referenced Image Sequence.
short[]	getRWavePointer() Return the location(s) of the R Wave in the cardiac cycles by referencing frame numbers; frame numbers begin with 1.
short	getSamplesPerPixel() Retrieves the samples per pixel.
java.lang.String[]	getScanOptions() Return Parameters of scanning sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAcquisitionDeviceProcessingDescription(java.lang.String strAcquisitionDeviceProcessingDescription) Sets value that Indicates any visual processing performed on the images prior to exchange.
void	setBitsAllocated(EnumBitsAllocated enumBitsAllocated) Number of bits allocated for each pixel sample.
void	setBitsStored(EnumBitsStored enumBitsStored) Number of bits stored for each pixel sample.
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	setDerivationDescription(java.lang.String strDerivationDescription) Sets a text description of how this image was derived.
void	setFrameDimensionPointer(short[] arrShDimensionPointer) Sets value that contains the Data Element Tags of one or more attributes that vary or increment for the frames of a multi-frame image.
void	setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection) Sets value that is Used to specify multiple values for Frame Increment Pointer.
void	setFrameLabelVector(java.lang.String[] arrStrFrameLabelVector) Sets a multi-valued attribute that contains a descriptive label for each of the image frames.
void	setHighBit(EnumHighBit enumHighBit) Most significant bit for pixel sample data.
void	setImageType(java.lang.String[] arrStrImageType) This method is used to set Image identification characteristics.
void	setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression) The method is used to set Specifies whether an Image has undergone lossy compression.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) The method is used to set Specifies the intended interpretation of the pixel data.
void	setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship) Sets relationship between the Pixel sample values and the X-Ray beam intensity.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Data representation of the pixel samples.
void	setRWavePointer(short[] arrShRWavePointer) Sets the location(s) of the R Wave in the cardiac cycles by referencing frame numbers; frame numbers begin with 1.
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) Samples per Pixel (0028,0002) is the number of separate planes in the image.
void	setScanOptions(java.lang.String[] arrStrScanOptions) Sets 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, 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

XRayImageModule

public XRayImageModule(IDataSet objIDataSet)

Instantiates a new x ray 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

getGeneralAnatomyOptionalMacro

public GeneralAnatomyOptionalMacro getGeneralAnatomyOptionalMacro()

Retrieves the Instance of GeneralAnatomyOptionalMacro.

Returns:

GeneralAnatomyOptionalMacro Instance of GeneralAnatomyOptionalMacro

setFrameIncrementPointer

public void setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection)

Sets value that is Used to specify multiple values for Frame Increment Pointer.

Parameters:

objSingleCollection - Collection of Tags (GroupNumber and ElementNumbers)

getFrameIncrementPointer

public ISingleCollection<ITag> getFrameIncrementPointer()

Return value that is Used to specify multiple values for Frame Increment Pointer.

Returns:

ISingleCollection - Collection of Tags

setLossyImageCompression

public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)

The method is used to set Specifies whether an Image has undergone lossy compression.

Parameters:

enumLossyImageCompression - :Enum value of Lossy Image Compression(Yes or No)

getLossyImageCompression

public java.lang.String getLossyImageCompression()

Retrieves the Lossy Image Compression.

Returns:

String - returns the Lossy Image Compression

setImageType

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

This method is used to set Image identification characteristics.

Parameters:

arrStrImageType - : Image identification characteristics.

getImageType

public java.lang.String[] getImageType()

Retrieves the Tmage Type.

Returns:

String[] - returns the Image Type

setPixelIntensityRelationship

public void setPixelIntensityRelationship(EnumPixelIntensityRelationship enumPixelIntensityRelationship)

Sets relationship between the Pixel sample values and the X-Ray beam intensity.

Parameters:

enumPixelIntensityRelationship - Enum value of Pixel Intensity Relationship

getPixelIntensityRelationship

public java.lang.String getPixelIntensityRelationship()

Return relationship between the Pixel sample values and the X-Ray beam intensity.

Returns:

String - String value of Pixel Intensity Relationship

setSamplesPerPixel

public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)

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

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

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

setBitsAllocated

public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)

Number of bits allocated for each pixel sample. Each sample shall have the same number of bits allocated.

Parameters:

enumBitsAllocated - specifies the number of 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)

Number of bits stored for each pixel sample. Each sample shall have the same number of bits stored.

Parameters:

enumBitsStored - specifies the number of 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)

Most significant bit for pixel sample data. Each sample shall have the same high bit.

Parameters:

enumHighBit - specifies the high bit

getHighBit

public short getHighBit()

Retrieves the high bit.

Returns:

short - returns the high bit

setPixelRepresentation

public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)

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 - specifies the pixel representation

getPixelRepresentation

public short getPixelRepresentation()

Retrieves the pixel representation.

Returns:

short - returns the pixel representation

setScanOptions

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

Sets parameters of scanning sequence.

Parameters:

arrStrScanOptions - the arr str scan options

getScanOptions

public java.lang.String[] getScanOptions()

Return Parameters of scanning sequence.

Returns:

String Array of Scan Options.

setRWavePointer

public void setRWavePointer(short[] arrShRWavePointer)

Sets the location(s) of the R Wave in the cardiac cycles by referencing frame numbers; frame numbers begin with 1.

Parameters:

arrShRWavePointer - the arr sh r wave pointer

getRWavePointer

public short[] getRWavePointer()

Return the location(s) of the R Wave in the cardiac cycles by referencing frame numbers; frame numbers begin with 1.

Returns:

short Array - short array of RWavePointer

getReferencedImageSequence

public ReferencedImageSequence getReferencedImageSequence()

This method Returns provides the pre-initialized object of Referenced Image Sequence return objReferencedImageSequence - 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:

the referenced image sequence

setDerivationDescription

public void setDerivationDescription(java.lang.String strDerivationDescription)

Sets a text description of how this image was derived.

Parameters:

strDerivationDescription - String value of Derivation Description

getDerivationDescription

public java.lang.String getDerivationDescription()

Return a text description of how this image was derived.

Returns:

String - String value of Derivation Description

setAcquisitionDeviceProcessingDescription

public void setAcquisitionDeviceProcessingDescription(java.lang.String strAcquisitionDeviceProcessingDescription)

Sets value that Indicates any visual processing performed on the images prior to exchange.

Parameters:

strAcquisitionDeviceProcessingDescription - String value of Acquisition Device Processing Description

getAcquisitionDeviceProcessingDescription

public java.lang.String getAcquisitionDeviceProcessingDescription()

Return value that Indicates any visual processing performed on the images prior to exchange.

Returns:

String - String value of Acquisition Device Processing Description

setFrameLabelVector

public void setFrameLabelVector(java.lang.String[] arrStrFrameLabelVector)

Sets a multi-valued attribute that contains a descriptive label for each of the image frames. The number of values shall equal the number of frames.

Parameters:

arrStrFrameLabelVector - the arr str frame label vector

getFrameLabelVector

public java.lang.String[] getFrameLabelVector()

Return multi-valued attribute that contains a descriptive label for each of the image.

Returns:

String[] - String Array of String array of Frame Label Vector

setFrameDimensionPointer

public void setFrameDimensionPointer(short[] arrShDimensionPointer)

Sets value that contains the Data Element Tags of one or more attributes that vary or increment for the frames of a multi-frame image.

Parameters:

arrShDimensionPointer - the arr sh dimension pointer

getFrameDimensionPointer

public short[] getFrameDimensionPointer()

Return value that contains the Data Element Tags of one or more attributes that vary or increment.

Returns:

short[] - short array of Frame Dimension Pointer

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 - enum value of 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 - String value of Calibration Image

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