cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class HCColorImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.HCColorImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class HCColorImageModule
extends Module

\* This module describes a printable 8 bit RGB Color image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HCColorImageModule(IDataSet objIDataSet) Instantiates a new hC color 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.
short	getColumns() Retrieves the number of columns.
short	getHighBit() Retrieves the high bit.
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
java.lang.String[]	getPixelAspectRatio() Retrieves the pixel aspect ratio.
ISingleCollection<byte[]>	getPixelData() Retrieves the collection of pixel data.
short	getPixelRepresentation() Retrieves the pixel representation.
short	getPlanarConfiguration() Retrieves the planar configuration.
short	getRows() Retrieves the number of rows.
short	getSamplesPerPixel() Retrieves the samples per pixel.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the HCColor Image Module specified by DICOM Standard.
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	setColumns(short sColumns) Sets number of columns in the image.
void	setHighBit(EnumHighBit enumHighBit) Sets most significant bit for pixel sample data.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) Sets the intended interpretation of the pixel data.
void	setPixelAspectRatio(java.lang.String strPixelAspectRatio) Sets Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the vertical pixel size.
void	setPixelData(IDicomStream objIDicomStream, int[] iFrameSizeArr, EnumPixelDataVRType enumPixelDataVRType, boolean isUndefined) Sets a data stream of the pixel samples that comprise the Image.
void	setPixelData(ISingleCollection<byte[]> objCollectionOfPixelData, EnumPixelDataVRType enumPixelDataVRType, boolean isUndefined) Sets a data stream of the pixel samples that comprise the Image.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Data representation of the pixel samples.
void	setPlanarConfiguration(EnumPlanarConfiguration enumPlanarConfiguration) Sets Indicates whether the pixel data are sent color-by-plane or color-by-pixel.
void	setRows(short sRows) Sets number of rows in the image.This describes the images's height.
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) Sets Samples per Pixel (0028,0002) that is the number of separate planes in the 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

HCColorImageModule

public HCColorImageModule(IDataSet objIDataSet)

Instantiates a new hC color 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:

true, if validate module

Throws:

InvalidModuleException - the invalid module exception

setSamplesPerPixel

public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)

Sets Samples per Pixel (0028,0002) that 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

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

Sets the intended interpretation of the pixel 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 Enumerated Value: RGB

Parameters:

enumPhotometricInterpretation - - Enum value Photometric Interpretation

setRows

public void setRows(short sRows)

Sets number of rows in the image.This describes the images's height.

Parameters:

sRows - the s rows

setColumns

public void setColumns(short sColumns)

Sets number of columns in the image. This describes the images's width.

Parameters:

sColumns - the s columns

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 - - specifies 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 - - specifies 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. Enumerated Value: 7

Parameters:

enumHighBit - - specifies the high bit

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

setPixelData

public void setPixelData(ISingleCollection<byte[]> objCollectionOfPixelData,
                EnumPixelDataVRType enumPixelDataVRType,
                boolean isUndefined)

Sets a data stream of the pixel samples that comprise the Image.

Parameters:

objCollectionOfPixelData - the obj collection of pixel data

enumPixelDataVRType - VR type pf the pixel data . It can be OW/OB.

isUndefined - true then the Data Element created is of undefined length. false then the Data Element created is of defined length.

setPixelData

public void setPixelData(IDicomStream objIDicomStream,
                int[] iFrameSizeArr,
                EnumPixelDataVRType enumPixelDataVRType,
                boolean isUndefined)
                  throws java.io.IOException

Sets a data stream of the pixel samples that comprise the Image.

Parameters:

objIDicomStream - the Dicom Stream Containing pixel data

iFrameSizeArr - int array containing size of each frame.

enumPixelDataVRType - VR type pf the pixel data . It can be OW/OB.

isUndefined - true then the Data Element created is of undefined length. false then the Data Element created is of defined length.

Throws:

java.io.IOException

setPlanarConfiguration

public void setPlanarConfiguration(EnumPlanarConfiguration enumPlanarConfiguration)

Sets Indicates whether the pixel data are sent color-by-plane or color-by-pixel. Enumerated Value: 0001H (frame interleave)

Parameters:

enumPlanarConfiguration - the enum planar configuration

setPixelAspectRatio

public void setPixelAspectRatio(java.lang.String strPixelAspectRatio)

Sets Ratio of the vertical size and horizontal size of the pixels in the image specified by a pair of integer values where the first value is the vertical pixel size.

Parameters:

strPixelAspectRatio - the str pixel aspect ratio

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves the samples per pixel.

Returns:

short - returns the samples per pixel

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves the photometric interpretation.

Returns:

String - returns the photometric interpretation

getRows

public short getRows()

Retrieves the number of rows.

Returns:

short - returns the number of rows

getColumns

public short getColumns()

Retrieves the number of columns.

Returns:

short - returns the number of columns

getBitsAllocated

public short getBitsAllocated()

Retrieves the number of bits allocated.

Returns:

short - returns the number of bits allocated

getBitsStored

public short getBitsStored()

Retrieves the number of bits stored.

Returns:

short - returns the number of bits stored

getHighBit

public short getHighBit()

Retrieves the high bit.

Returns:

short - returns the high bit

getPixelRepresentation

public short getPixelRepresentation()

Retrieves the pixel representation.

Returns:

short - returns the pixel representation

getPixelData

public ISingleCollection<byte[]> getPixelData()

Retrieves the collection of pixel data.

Returns:

collection of byte[] - returns the collection pixel data

getPlanarConfiguration

public short getPlanarConfiguration()

Retrieves the planar configuration.

Returns:

short - returns the planar configuration

getPixelAspectRatio

public java.lang.String[] getPixelAspectRatio()

Retrieves the pixel aspect ratio.

Returns:

short[] - returns the pixel aspect ratio

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

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