cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class VLImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.VLImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class VLImageModule
extends Module

\* This module is part of VL Endoscopic Image IOD which specifies the Attributes of Single-frame VL Endoscopic Images.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VLImageModule(IDataSet objIDataSet) Instantiates a new vL image module.

Method Summary

Methods

Modifier and Type	Method and Description
short	getBitsAllocated() Retrieves the short value of the attribute Bits Allocated.
short	getBitsStored() Retrieves the short value of the attribute Bits Stored.
java.lang.String	getContentTime() Retrieves the time when the data creation was started.
short	getHighBit() Retrieves the short value of the attribute High Bit.
java.lang.String[]	getImageType() Retrieves the String values of the attribute Image Type.
java.lang.String	getLossyImageCompression() Retrieves value which Specifies whether an Image has undergone lossy compression.
java.lang.String	getPhotometricInterpretation() Retrieves the intended interpretation of the pixel data.
short	getPixelRepresentation() Retrieves the pixel representation.
short	getPlanarConfiguration() Retrieves the value which shows the pixel data are sent color-by-plane or color-by-pixel.
short	getSamplesPerPixel() Retrieves the value of separate planes in the image.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setBitsAllocated(EnumBitsAllocated enumBitsAllocated) Method is used to set Number of bits allocated for each pixel sample The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setBitsStored(EnumBitsStored enumBitsStored) Method is used to set Number of bits stored for each pixel sample The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setContentTime(java.lang.String strContentTime) Sets the time when the data creation was started.
void	setHighBit(EnumHighBit enumHighBit) Method is used to set Most significant bit for pixel sample 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	setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression) Sets the value which 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	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Data representation of the pixel samples.
void	setPlanarConfiguration(EnumPlanarConfiguration enumPlanarConfiguration) Sets the value which shows the pixel data are sent color-by-plane or color-by-pixel.
void	setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel) Sets 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

VLImageModule

public VLImageModule(IDataSet objIDataSet)

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

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 Defined Terms for Value 3: AXIAL identifies a CT Axial Image LOCALIZER identifies a CT Localizer Image

Parameters:

arrStrImageType - :Image identification characteristics.

getImageType

public java.lang.String[] getImageType()

Retrieves the String values of the attribute Image Type.

Returns:

String[] - returns the type of image

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

The method is used to set Specifies the intended interpretation of the pixel data. The function accepts a Enum 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: MONOCHROME2 RGB YBR_FULL_422 YBR_FULL_420 YBR_RCT YBR_ICT

Parameters:

enumPhotometricInterpretation - Enum value Photometric Interpretation.

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves the intended interpretation of the pixel data.

Returns:

String - String value of Photometric Interpretation.

setBitsAllocated

public void setBitsAllocated(EnumBitsAllocated enumBitsAllocated)

Method is used to set Number of bits allocated for each pixel sample 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:

enumBitsAllocated - Enum value of Bits Allocated

getBitsAllocated

public short getBitsAllocated()

Retrieves the short value of the attribute Bits Allocated.

Returns:

short - short value of Bits Allocated

setBitsStored

public void setBitsStored(EnumBitsStored enumBitsStored)

Method is used to set Number of bits stored for each pixel sample 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:

enumBitsStored - Enum value of Bits Stored

getBitsStored

public short getBitsStored()

Retrieves the short value of the attribute Bits Stored.

Returns:

short - short value of Bits Stored

setHighBit

public void setHighBit(EnumHighBit enumHighBit)

Method is used to set Most significant bit for pixel sample 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:

enumHighBit - Enum short value of significant bit for pixel sample data

getHighBit

public short getHighBit()

Retrieves the short value of the attribute High Bit.

Returns:

short - short value of High Bit

setPixelRepresentation

public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)

Sets Data representation of the pixel samples. Each sample shall have the same pixel representation.

Parameters:

enumPixelRepresentation - Enum short value specifies the pixel representation

getPixelRepresentation

public short getPixelRepresentation()

Retrieves the pixel representation.

Returns:

short - short value of pixel representation

setSamplesPerPixel

public void setSamplesPerPixel(EnumSamplesPerPixel enumSamplesPerPixel)

Sets the number of separate planes in the image. One, three, and four image planes are defined.

Parameters:

enumSamplesPerPixel - Enum short value specifies the samples per pixel in the image

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves the value of separate planes in the image.

Returns:

short - short value of samples per pixel

setPlanarConfiguration

public void setPlanarConfiguration(EnumPlanarConfiguration enumPlanarConfiguration)

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

Parameters:

enumPlanarConfiguration - Enum short value specifies planar configuration of the image

getPlanarConfiguration

public short getPlanarConfiguration()

Retrieves the value which shows the pixel data are sent color-by-plane or color-by-pixel.

Returns:

short - short value of the planar configuration

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets the time when the data creation was started.

Parameters:

strContentTime - String value of the time when the data creation was started.

getContentTime

public java.lang.String getContentTime()

Retrieves the time when the data creation was started.

Returns:

String - String value of Content Time.

setLossyImageCompression

public void setLossyImageCompression(EnumLossyImageCompression enumLossyImageCompression)

Sets the value which Specifies whether an Image has undergone lossy compression.

Parameters:

enumLossyImageCompression - Enum value of Lossy Image Compression.

getLossyImageCompression

public java.lang.String getLossyImageCompression()

Retrieves value which Specifies whether an Image has undergone lossy compression.

Returns:

String - String value of Lossy Image Compression.

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.