cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ImagePlaneModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImagePlaneModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ImagePlaneModule
extends Module

This Class is specifies the Attributes that define the transmitted pixel array of a two dimensional image plane.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ImagePlaneModule(IDataSet objIDataSet) Creates Image Plane Module with defaultinitialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getImageOrientationPatient() Retrieves the Patient Image Orientation.
java.lang.String[]	getImagePositionPatient() Retrieves the Patient Image Position.
java.lang.String[]	getPixelSpacing() Retrieves the specing between pixels.
java.lang.String	getSliceLocation() Retrieves the slice location.
java.lang.String	getSliceThickness() Retrieves the slice thickness.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setImageOrientationPatient(java.lang.String[] arrStrImageOrientationPatient) This method is used to set the direction cosines of the first row and the first column with respect to the patient.
void	setImagePositionPatient(java.lang.String[] arrStrImagePositionPatient) This method is used to set the x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm.
void	setPixelSpacing(java.lang.String[] arrStrPixelSpacing) This method is used to set physical distance in the patient between the center of each pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing in mm.
void	setSliceLocation(java.lang.String strSliceLocation) The method is used to set Relative position of exposure expressed in mm.
void	setSliceThickness(java.lang.String strSliceThickness) The method is used to set Nominal slice thickness, in mm.
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

ImagePlaneModule

public ImagePlaneModule(IDataSet objIDataSet)

Creates Image Plane Module with defaultinitialization.

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 - - If validation of Module fails

setPixelSpacing

public void setPixelSpacing(java.lang.String[] arrStrPixelSpacing)

This method is used to set physical distance in the patient between the center of each pixel, specified by a numeric pair - adjacent row spacing (delimiter) adjacent column spacing in mm. 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:

arrStrPixelSpacing - :physical distances in the patient between the center of each pixel.

setImageOrientationPatient

public void setImageOrientationPatient(java.lang.String[] arrStrImageOrientationPatient)

This method is used to set the direction cosines of the first row and the first column with respect to the patient. 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:

arrStrImageOrientationPatient - :the direction cosines of the first row and the first column with respect to the patient.

setImagePositionPatient

public void setImagePositionPatient(java.lang.String[] arrStrImagePositionPatient)

This method is used to set the x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm. 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:

arrStrImagePositionPatient - :Specifies the x, y, and z coordinates of the upper left hand corner (center of the first voxel transmitted) of the image, in mm. to the patient.

setSliceThickness

public void setSliceThickness(java.lang.String strSliceThickness)

The method is used to set Nominal slice thickness, in mm. The function accepts a String Value as the strStudyInstanceUID 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:

strSliceThickness - : nominal slice thickness, in mm.

setSliceLocation

public void setSliceLocation(java.lang.String strSliceLocation)

The method is used to set Relative position of exposure expressed in mm. The function accepts a String Value as the strStudyInstanceUID 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:

strSliceLocation - : relative position of exposure expressed in mm.

getPixelSpacing

public java.lang.String[] getPixelSpacing()

Retrieves the specing between pixels.

Returns:

String[] - returna the spacing between pixels

getImageOrientationPatient

public java.lang.String[] getImageOrientationPatient()

Retrieves the Patient Image Orientation.

Returns:

String[] - returns the patient image orientation

getImagePositionPatient

public java.lang.String[] getImagePositionPatient()

Retrieves the Patient Image Position.

Returns:

String[] - returns the patient image position

getSliceThickness

public java.lang.String getSliceThickness()

Retrieves the slice thickness.

Returns:

String - returns the slice thickness

getSliceLocation

public java.lang.String getSliceLocation()

Retrieves the slice location.

Returns:

String - returns the slice location

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

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