cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SegmentationImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SegmentationImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SegmentationImageModule
extends Module

\* This module describes Segmentation 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
SegmentationImageModule(IDataSet objIDataSet) Creates SegmentationImageModule.

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.
ContentIdentificationMacro	getContentIdentificationMacro() Retrieves pre-initialized instance of Content Identification Macro Attributes.
short	getHighBit() Retrieves the high bit.
java.lang.String[]	getImageType() Return Image Type.
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.
short	getMaximumFractionalValue() Retrieves MaximumFractionalValue
java.lang.String	getPhotometricInterpretation() Retrieves the photometric interpretation.
java.lang.String	getPixelRepresentation() Retrieves the PixelRepresentation
short	getSamplesPerPixel() Return the short value of the attribute Samples Per Pixel.
java.lang.String	getSegmentationFractionalType() Retrieves SegmentationFractionalType
java.lang.String	getSegmentationType() Retrieves SegmentationType
SegmentSequence	getSegmentSequence() This method provides the pre-initialized object of SegmentSequence.
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	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) Sets the approximate lossy compression ratio(s) that have been applied to this image.
void	setMaximumFractionalValue(short shMaximumFractionalValue) Sets MaximumFractionalValue
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) Sets Specifies the intended interpretation of the pixel data.
void	setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation) Sets Pixel Representation
void	setSamplesPerPixel(short sSamplesPerPixel) Method is used to set Number of samples (planes) 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.
void	setSegmentationFractionalType(java.lang.String strSegmentationFractionalType) Sets SegmentationFractionalType
void	setSegmentationType(EnumSegmentationType enumSegmentationType) Sets SegmentationType
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, getVectorOfKeys, 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

SegmentationImageModule

public SegmentationImageModule(IDataSet objIDataSet)

Creates SegmentationImageModule.

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

getContentIdentificationMacro

public ContentIdentificationMacro getContentIdentificationMacro()

Retrieves pre-initialized instance of Content Identification Macro Attributes.

Returns:

ContentIdentificationMacro - instance of ContentIdentificationMacro.

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(short sSamplesPerPixel)

Method is used to set Number of samples (planes) 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:

sSamplesPerPixel - the s samples per pixel

getSamplesPerPixel

public short getSamplesPerPixel()

Return the short value of the attribute 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 - - Enum value Photometric Interpretation

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves the photometric interpretation.

Returns:

String - returns the photometric interpretation

setPixelRepresentation

public void setPixelRepresentation(EnumPixelRepresentation enumPixelRepresentation)

Sets Pixel Representation

Parameters:

enumPixelRepresentation - - Enum value Pixel Representation

getPixelRepresentation

public java.lang.String getPixelRepresentation()

Retrieves the PixelRepresentation

Returns:

String - returns the PixelRepresentation

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. Enumerated Values: 8, 16

Parameters:

enumBitsAllocated - the enum bits allocated

getBitsAllocated

public short getBitsAllocated()

Retrieves the number of bits allocated.

Returns:

- 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. Enumerated Values: 6 to 16

Parameters:

enumBitsStored - the enum bits stored

getBitsStored

public short getBitsStored()

Retrieves the number of bits stored.

Returns:

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

- returns the high bit

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 - the enum lossy image compression

getLossyImageCompression

public java.lang.String getLossyImageCompression()

Retrieves the Lossy Image Compression.

Returns:

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

- returns the Lossy Image Compression

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

getLossyImageCompressionMethod

public java.lang.String[] getLossyImageCompressionMethod()

Retrieves the Lossy Image Compression Method.

Returns:

String[] - the Lossy Image Compression Method

setSegmentationType

public void setSegmentationType(EnumSegmentationType enumSegmentationType)

Sets SegmentationType

Parameters:

enumSegmentationType - the enum SegmentationType

getSegmentationType

public java.lang.String getSegmentationType()

Retrieves SegmentationType

Returns:

- returns the SegmentationType

setSegmentationFractionalType

public void setSegmentationFractionalType(java.lang.String strSegmentationFractionalType)

Sets SegmentationFractionalType

Parameters:

strSegmentationFractionalType - Specifies SegmentationFractionalType

getSegmentationFractionalType

public java.lang.String getSegmentationFractionalType()

Retrieves SegmentationFractionalType

Returns:

String - SegmentationFractionalType

setMaximumFractionalValue

public void setMaximumFractionalValue(short shMaximumFractionalValue)

Sets MaximumFractionalValue

Parameters:

shMaximumFractionalValue - short value of MaximumFractionalValue

getMaximumFractionalValue

public short getMaximumFractionalValue()

Retrieves MaximumFractionalValue

Returns:

short - short value of MaximumFractionalValue

getSegmentSequence

public SegmentSequence getSegmentSequence()

This method provides the pre-initialized object of SegmentSequence.

Returns:

- object of SegmentSequence. 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