cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class EnhancedMRImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.EnhancedMRImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class EnhancedMRImageModule
extends Module

\* This module specifies the attributes of the Enhanced MR 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
EnhancedMRImageModule(IDataSet objIDataSet) Instantiates a new enhanced mr 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.
CommonCTOrMRImageDescriptionMacro	getCommonCTOrMRImageDescriptionMacro() Retrieves pre-initialized instance of CommonCTOrMRImageDescriptionMacro.
short	getHighBit() Retrieves the high bit.
IconImageSequence	getIconImageSequence() Returns provides the pre-initialized object of Icon Image Sequence.
java.lang.String[]	getImageType() Return Image Type.
java.lang.String	getLossyImageCompression() Retrieves the Lossy Image Compression.
java.lang.String[]	getLossyImageCompressionRatio() Retrieves the Lossy Image Compression.
MRImageAndSpectroscopyInstanceMacro	getMRImageAndSpectroscopyInstanceMacro() Retrieves pre-initialized instance of MRImageAndSpectroscopyInstanceMacro.
MRImageDescriptionMacro	getMRImageDescriptionMacro() Retrieves pre-initialized instance of MRImageDescriptionMacro.
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
short	getSamplesPerPixel() Retrieves the samples per pixel.
java.lang.String	getSpacingBetweenSlices() Retrieves value of the prescribed spacing to be applied between the slices in a volume that is to be acquired.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
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	setHighBit(EnumHighBit enumHighBit) Sets Most significant bit for pixel sample data.
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	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	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) Sets Samples per Pixel (0028,0002) is the number of separate planes in the image.
void	setSpacingBetweenSlices(java.lang.String strSpacingBetweenSlices) Sets value of the prescribed spacing to be applied between the slices in a volume that is to be acquired.
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

EnhancedMRImageModule

public EnhancedMRImageModule(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.

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

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

setSpacingBetweenSlices

public void setSpacingBetweenSlices(java.lang.String strSpacingBetweenSlices)

Sets value of the prescribed spacing to be applied between the slices in a volume that is to be acquired. The spacing in mm is defined as the center-to-center distance of adjacent slices.

Parameters:

strSpacingBetweenSlices - - String value of Spacing Between Slices.

getSpacingBetweenSlices

public java.lang.String getSpacingBetweenSlices()

Retrieves value of the prescribed spacing to be applied between the slices in a volume that is to be acquired. The spacing in mm is defined as the center-to-center distance of adjacent slices.

Returns:

String - String value of Spacing Between Slices.

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

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.

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:

ISingleCollection - the customized collection containing the dataelement tags that beling to this module

getCommonCTOrMRImageDescriptionMacro

public CommonCTOrMRImageDescriptionMacro getCommonCTOrMRImageDescriptionMacro()

Retrieves pre-initialized instance of CommonCTOrMRImageDescriptionMacro.

Returns:

CommonCTOrMRImageDescriptionMacro - instance of CommonCTOrMRImageDescriptionMacro.

getMRImageAndSpectroscopyInstanceMacro

public MRImageAndSpectroscopyInstanceMacro getMRImageAndSpectroscopyInstanceMacro()

Retrieves pre-initialized instance of MRImageAndSpectroscopyInstanceMacro.

Returns:

MRImageAndSpectroscopyInstanceMacro - instance of MRImageAndSpectroscopyInstanceMacro.

getMRImageDescriptionMacro

public MRImageDescriptionMacro getMRImageDescriptionMacro()

Retrieves pre-initialized instance of MRImageDescriptionMacro.

Returns:

MRImageDescriptionMacro - instance of MRImageDescriptionMacro.