cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class WholeSlideMicroscopyImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.WholeSlideMicroscopyImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class WholeSlideMicroscopyImageModule
extends Module

\* This module describes attributes related to Whole Slide Microscopy 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
WholeSlideMicroscopyImageModule(IDataSet objIDataSet) Instantiates a new rT general plan module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDatetime() Retrieves the Date and Time of Acquisition.
java.lang.String	getAcquisitionDeviceProcessingCode() Gets the acquisition device processing code.
java.lang.String	getAcquisitionDeviceProcessingDescription() Gets the acquisition device processing description.
double	getAcquisitionDuration() Retrieves the time in seconds needed to run the prescribed pulse sequence.
short	getBitsAllocated() Retrieves the Bits Allocated.
short	getBitsStored() Retrieves the BitsStored.
java.lang.String	getBurnedInAnnotation() Retrieves BurnedInAnnotation .
java.lang.String[]	getConvolutionKernel() Return the String values of the attribute Convolution Kernel.
float	getDistanceBetweenFocalPlanes() Retrieves DistanceBetweenFocalPlanes
java.lang.String	getExtendedDepthofField() Retrieves Extended Depth of Field .
java.lang.String	getFocusMethod() Retrieves Focus Method .
short	getHighBit() Retrieves the HighBit.
float	getImagedVolumeDepth() Retrieves ImagedVolumeDepth
float	getImagedVolumeHeight() Retrieves ImagedVolumeHeight
float	getImagedVolumeWidth() Retrieves ImagedVolumeWidth
java.lang.String[]	getImageOrientationSlide() Return Image Orientation Slide .
java.lang.String	getImageType() Retrieves ImageType.
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	getNumberofFocalPlanes() Retrieves the Number of Focal Planes.
java.lang.String	getNumberOfFrames() Return number of Number Of Frames.
java.lang.String	getPhotometricInterpretation() Retrieves Photometric Interpretation.
short	getPixelRepresentation() Retrieves the PixelRepresentation.
short	getPlanarConfiguration() Retrieves the Planar Configuration.
java.lang.String	getPresentationLUTShape() Retrieves a subset of a conceptual Presentation LUT.
short	getRecommendedAbsentPixelCIELabValue() Retrieves the RecommendedAbsentPixelCIELabValue.
TotalPixelMatrixOriginSequence	getReferencedVisitSequence() This method provides the pre-initialized object of TotalPixelMatrixOriginSequence.
java.lang.String	getRescaleIntercept() Return the String value of the attribute Rescale Intercept.
java.lang.String	getRescaleScope() Return the String value of the attribute Rescale Scope.
short	getSamplesPerPixel() Retrieves the Samples per Pixel.
java.lang.String	getSpecimenLabelInImage() Retrieves SpecimenLabelInImage .
int	getTotalPixelMatrixColumns() Retrieves Total Pixel Matrix Columns.
int	getTotalPixelMatrixRows() Retrieves Total Pixel Matrix Rows.
java.lang.String	getVolumetricProperties() Retrieves Volumetric Properties .
void	setAcquisitionDatetime(java.lang.String strAcquisitionDatetime) Set The date and time that the acquisition of data that resulted in this image started.
void	setAcquisitionDuration(double dAcquisitionDuration) Sets the time in seconds needed to run the prescribed pulse sequence.
void	setAnnotationPosition(short sPixelRepresentation) Sets the Pixel Representation.
void	setBitsAllocated(short sBitsAllocated) Sets the Bits Allocated.
void	setBitsStored(short sBitsStored) Sets the BitsStored.
void	setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation) Sets Burned In Annotation .
void	setConvolutionKernel(java.lang.String[] arrStrConvolutionKernel) This method is used to set the convolution kernel The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setDistanceBetweenFocalPlanes(float fDistanceBetweenFocalPlanes) Sets DistanceBetweenFocalPlanes
void	setExtendedDepthofField(EnumExtendedDepthofField enumFocusMethod) Sets Extended Depth of Field .
void	setFocusMethod(EnumFocusMethod enumFocusMethod) Sets Focus Method .
void	setHighBit(short sHighBit) Sets the HighBit.
void	setImagedVolumeDepth(float fImagedVolumeDepth) Sets Imaged Volume Depth.
void	setImagedVolumeHeight(float fImagedVolumeHeight) Sets Imaged Volume Height.
void	setImagedVolumeWidth(float fImagedVolumeWidth) Sets Imaged Volume Width.
void	setImageOrientationSlide(java.lang.String[] strArrImageOrientationSlide) Sets the Image Orientation (Slide).
void	setImageType(EnumImageType enumImageType) Sets Image Type.
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	setNumberofFocalPlanes(short sNumberofFocalPlanes) Sets the Number of Focal Planes.
void	setNumberOfFrames(java.lang.String strNumberOfFrames) Sets Number of Frames.
void	setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation) Sets Photometric Interpretation.
void	setPlanarConfiguration(short sPlanarConfiguration) Sets the Planar Configuration.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) Sets a subset of a conceptual Presentation LUT.This Attribute defines an identity transformation or inverse identity transformation.
void	setRecommendedAbsentPixelCIELabValue(short sRecommendedAbsentPixelCIELabValue) Sets the RecommendedAbsentPixelCIELabValue.
void	setRescaleIntercept(java.lang.String strRescaleIntercept) The method is used to setThe value b in relationship between stored values (SV) and Hounsfield (HU).
void	setRescaleScope(java.lang.String strRescaleScope) The method is used to set the equation specified in Rescale Intercept The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values.
void	setSamplesPerPixel(short sSamplesPerPixel) Sets the Samples per Pixel.
void	setSpecimenLabelInImage(EnumSpecimenLabelInImage enumSpecimenLabelInImage) Sets SpecimenLabelInImage.
void	setTotalPixelMatrixColumns(int iTotalPixelMatrixColumns) Sets Total Pixel Matrix Columns.
void	setTotalPixelMatrixRows(int iTotalPixelMatrixRows) Sets Total Pixel Matrix Rows.
void	setVolumetricProperties(EnumVolumetricProperties enumVolumetricProperties) Sets Volumetric Properties .
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

WholeSlideMicroscopyImageModule

public WholeSlideMicroscopyImageModule(IDataSet objIDataSet)

Instantiates a new rT general plan 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(EnumImageType enumImageType)

Sets Image Type. Image identification characteristics.

Parameters:

enumImageType - the enum approval status

getImageType

public java.lang.String getImageType()

Retrieves ImageType.

Returns:

String - String value of ImageType.

setImagedVolumeWidth

public void setImagedVolumeWidth(float fImagedVolumeWidth)

Sets Imaged Volume Width. Width of total imaged volume (distance in the direction of rows in each frame) in mm.

Parameters:

fImagedVolumeWidth - Float value of the Imaged Volume Width

getImagedVolumeWidth

public float getImagedVolumeWidth()

Retrieves ImagedVolumeWidth

Returns:

float - Float value of the ImagedVolumeWidth

setImagedVolumeHeight

public void setImagedVolumeHeight(float fImagedVolumeHeight)

Sets Imaged Volume Height. Height of total imaged volume (distance in the direction of columns in each frame) in mm.

Parameters:

fImagedVolumeHeight - Float value of the Imaged Volume Width

getImagedVolumeHeight

public float getImagedVolumeHeight()

Retrieves ImagedVolumeHeight

Returns:

float - Float value of the ImagedVolumeWidth

setImagedVolumeDepth

public void setImagedVolumeDepth(float fImagedVolumeDepth)

Sets Imaged Volume Depth. Depth of total imaged volume (distance in the Z direction of focal planes) in μm.

Parameters:

fImagedVolumeDepth - Float value of the Imaged Volume Width

getImagedVolumeDepth

public float getImagedVolumeDepth()

Retrieves ImagedVolumeDepth

Returns:

float - Float value of the ImagedVolumeDepth

setTotalPixelMatrixColumns

public void setTotalPixelMatrixColumns(int iTotalPixelMatrixColumns)

Sets Total Pixel Matrix Columns. Total number of columns in pixel matrix; i.e., width of total imaged volume in pixels.

Parameters:

iTotalPixelMatrixColumns - int value of Offset of the First Directory Record of the Root Directory.

getTotalPixelMatrixColumns

public int getTotalPixelMatrixColumns()

Retrieves Total Pixel Matrix Columns.

Returns:

int - int value of Total Pixel Matrix Columns.

setTotalPixelMatrixRows

public void setTotalPixelMatrixRows(int iTotalPixelMatrixRows)

Sets Total Pixel Matrix Rows. Total number of Rows in pixel matrix; i.e., width of total imaged volume in pixels.

Parameters:

iTotalPixelMatrixRows - int value of Offset of the First Directory Record of the Root Directory.

getTotalPixelMatrixRows

public int getTotalPixelMatrixRows()

Retrieves Total Pixel Matrix Rows.

Returns:

int - int value of Total Pixel Matrix Rows.

getReferencedVisitSequence

public TotalPixelMatrixOriginSequence getReferencedVisitSequence()

This method provides the pre-initialized object of TotalPixelMatrixOriginSequence.

Returns:

- object of Total Pixel Matrix Origin 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

setImageOrientationSlide

public void setImageOrientationSlide(java.lang.String[] strArrImageOrientationSlide)

Sets the Image Orientation (Slide).

Parameters:

strArrImageOrientationSlide - String value of Image Orientation Slide.

getImageOrientationSlide

public java.lang.String[] getImageOrientationSlide()

Return Image Orientation Slide .

Returns:

String - String value of Image Orientation Slide.

setSamplesPerPixel

public void setSamplesPerPixel(short sSamplesPerPixel)

Sets the Samples per Pixel.

Parameters:

sSamplesPerPixel - short value of Samples per Pixel.

getSamplesPerPixel

public short getSamplesPerPixel()

Retrieves the Samples per Pixel.

Returns:

short - short value of Samples per Pixel.

setPhotometricInterpretation

public void setPhotometricInterpretation(EnumPhotometricInterpretation enumPhotometricInterpretation)

Sets Photometric Interpretation.

Parameters:

enumPhotometricInterpretation - the enum approval status

getPhotometricInterpretation

public java.lang.String getPhotometricInterpretation()

Retrieves Photometric Interpretation.

Returns:

String - String value of Photometric Interpretation.

setPlanarConfiguration

public void setPlanarConfiguration(short sPlanarConfiguration)

Sets the Planar Configuration.

Parameters:

sPlanarConfiguration - short value of PlanarConfiguration.

getPlanarConfiguration

public short getPlanarConfiguration()

Retrieves the Planar Configuration.

Returns:

short - short value of Planar Configuration.

setNumberOfFrames

public void setNumberOfFrames(java.lang.String strNumberOfFrames)

Sets Number of Frames. Number of frames in a multi-frame image.

Parameters:

strNumberOfFrames - String value of Number Of Frames.

getNumberOfFrames

public java.lang.String getNumberOfFrames()

Return number of Number Of Frames.

Returns:

String - String value of NumberOfFrames.

setBitsAllocated

public void setBitsAllocated(short sBitsAllocated)

Sets the Bits Allocated. Number of bits allocated for each pixel sample

Parameters:

sBitsAllocated - short value of Bits Allocated.

getBitsAllocated

public short getBitsAllocated()

Retrieves the Bits Allocated.

Returns:

short - short value of Bits Allocated.

setBitsStored

public void setBitsStored(short sBitsStored)

Sets the BitsStored. Number of bits stored for each pixel sample. Shall be equal to Bits Allocated (0028,0100).

Parameters:

sBitsStored - short value of Bits Stored.

getBitsStored

public short getBitsStored()

Retrieves the BitsStored.

Returns:

short - short value of BitsStored.

setHighBit

public void setHighBit(short sHighBit)

Sets the HighBit. Most significant bit for pixel sample data. High Bit (0028,0102) shall be one less than Bits Stored (0028,0101).

Parameters:

sHighBit - short value of HighBit.

getHighBit

public short getHighBit()

Retrieves the HighBit.

Returns:

short - short value of HighBit

setAnnotationPosition

public void setAnnotationPosition(short sPixelRepresentation)

Sets the Pixel Representation. Data representation of pixel samples.

Parameters:

sPixelRepresentation - short value of Pixel Representation.

getPixelRepresentation

public short getPixelRepresentation()

Retrieves the PixelRepresentation.

Returns:

short - short value of Pixel Representation.

setAcquisitionDatetime

public void setAcquisitionDatetime(java.lang.String strAcquisitionDatetime)

Set The date and time that the acquisition of data that resulted in this image started.

Parameters:

strAcquisitionDatetime - - String value of AAcquisition DateTime

getAcquisitionDatetime

public java.lang.String getAcquisitionDatetime()

Retrieves the Date and Time of Acquisition.

Returns:

String - returns the Date and Time of Acquisition

setAcquisitionDuration

public void setAcquisitionDuration(double dAcquisitionDuration)

Sets the time in seconds needed to run the prescribed pulse sequence. Duration of the image acquisition in seconds.

Parameters:

dAcquisitionDuration - - double value of Acquisition Duration.

getAcquisitionDuration

public double getAcquisitionDuration()

Retrieves the time in seconds needed to run the prescribed pulse sequence.

Returns:

double - double value of Acquisition Duration.

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

setPresentationLUTShape

public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)

Sets a subset of a conceptual Presentation LUT.This Attribute defines an identity transformation or inverse identity transformation. Enumerated Values: IDENTITY - output is in P-Values - shall be used if Photometric Interpretation (0028,0004) is MONOCHROME2. INVERSE - output after inversion is in PValues - shall be used if Photometric Interpretation (0028,0004) is MONOCHROME1.

Parameters:

enumPresentationLUTShape - the enum presentation lut shape

getPresentationLUTShape

public java.lang.String getPresentationLUTShape()

Retrieves a subset of a conceptual Presentation LUT.

Returns:

- String value of Presentation LUT Shape

setRescaleIntercept

public void setRescaleIntercept(java.lang.String strRescaleIntercept)

The method is used to setThe value b in relationship between stored values (SV) and Hounsfield (HU). 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:

strRescaleIntercept - :String value of Rescale Intercept

getRescaleIntercept

public java.lang.String getRescaleIntercept()

Return the String value of the attribute Rescale Intercept.

Returns:

String - returns the Rescale Intercept

setRescaleScope

public void setRescaleScope(java.lang.String strRescaleScope)

The method is used to set the equation specified in Rescale Intercept 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:

strRescaleScope - :String value of Rescale Scope

getRescaleScope

public java.lang.String getRescaleScope()

Return the String value of the attribute Rescale Scope.

Returns:

String - returns the Rescale Scope

setVolumetricProperties

public void setVolumetricProperties(EnumVolumetricProperties enumVolumetricProperties)

Sets Volumetric Properties .

Parameters:

enumVolumetricProperties - the enum approval status

getVolumetricProperties

public java.lang.String getVolumetricProperties()

Retrieves Volumetric Properties .

Returns:

String - String value of Volumetric Properties.

setSpecimenLabelInImage

public void setSpecimenLabelInImage(EnumSpecimenLabelInImage enumSpecimenLabelInImage)

Sets SpecimenLabelInImage.

Parameters:

enumSpecimenLabelInImage - the enum Specimen Label In Image

getSpecimenLabelInImage

public java.lang.String getSpecimenLabelInImage()

Retrieves SpecimenLabelInImage .

Returns:

String - String value of SpecimenLabelInImage.

setBurnedInAnnotation

public void setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation)

Sets Burned In Annotation .

Parameters:

enumBurnedInAnnotation - the enum Burned In Annotation .

getBurnedInAnnotation

public java.lang.String getBurnedInAnnotation()

Retrieves BurnedInAnnotation .

Returns:

String - String value of BurnedInAnnotation.

setFocusMethod

public void setFocusMethod(EnumFocusMethod enumFocusMethod)

Sets Focus Method .

Parameters:

enumFocusMethod - the enum Focus Method .

getFocusMethod

public java.lang.String getFocusMethod()

Retrieves Focus Method .

Returns:

String - String value of FocusMethod.

setExtendedDepthofField

public void setExtendedDepthofField(EnumExtendedDepthofField enumFocusMethod)

Sets Extended Depth of Field .

Parameters:

enumFocusMethod - the enum Extended Depth of Field .

getExtendedDepthofField

public java.lang.String getExtendedDepthofField()

Retrieves Extended Depth of Field .

Returns:

String - String value of ExtendedDepthofField.

setNumberofFocalPlanes

public void setNumberofFocalPlanes(short sNumberofFocalPlanes)

Sets the Number of Focal Planes.

Parameters:

sNumberofFocalPlanes - short value of Number of Focal Planes.

getNumberofFocalPlanes

public short getNumberofFocalPlanes()

Retrieves the Number of Focal Planes.

Returns:

short - short value of Number of Focal Planes.

setDistanceBetweenFocalPlanes

public void setDistanceBetweenFocalPlanes(float fDistanceBetweenFocalPlanes)

Sets DistanceBetweenFocalPlanes

Parameters:

fDistanceBetweenFocalPlanes - Float value of the DistanceBetweenFocalPlanes

getDistanceBetweenFocalPlanes

public float getDistanceBetweenFocalPlanes()

Retrieves DistanceBetweenFocalPlanes

Returns:

float - Float value of the DistanceBetweenFocalPlanes

getAcquisitionDeviceProcessingDescription

public java.lang.String getAcquisitionDeviceProcessingDescription()

Gets the acquisition device processing description.

Returns:

the acquisition device processing description

getAcquisitionDeviceProcessingCode

public java.lang.String getAcquisitionDeviceProcessingCode()

Gets the acquisition device processing code.

Returns:

the acquisition device processing code

setConvolutionKernel

public void setConvolutionKernel(java.lang.String[] arrStrConvolutionKernel)

This method is used to set the convolution kernel 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:

arrStrConvolutionKernel - :Image Convolution Kernel

getConvolutionKernel

public java.lang.String[] getConvolutionKernel()

Return the String values of the attribute Convolution Kernel.

Returns:

the convolution kernel

setRecommendedAbsentPixelCIELabValue

public void setRecommendedAbsentPixelCIELabValue(short sRecommendedAbsentPixelCIELabValue)

Sets the RecommendedAbsentPixelCIELabValue. A color value with which it is recommended to display the pixels of the Total Pixel Matrix that are not encoded. The units are specified in PCS-Values, and the value is encoded as CIELab

Parameters:

sRecommendedAbsentPixelCIELabValue - short value of RecommendedAbsentPixelCIELabValue.

getRecommendedAbsentPixelCIELabValue

public short getRecommendedAbsentPixelCIELabValue()

Retrieves the RecommendedAbsentPixelCIELabValue.

Returns:

short - short value of RecommendedAbsentPixelCIELabValue.