cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ImageBoxPixelPresentationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageBoxPixelPresentationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ImageBoxPixelPresentationModule
extends Module

\* This module describes attributes in Image Box Pixel Presentation Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ImageBoxPixelPresentationModule(IDataSet objIDataSet) Creates Clinical Trial Series Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
BasicColorImageSequence	getBasicColorImageSequence() Retrieves a sequence which provides the content of the color image pixel data to be printed.
BasicGrayscaleImageSequence	getBasicGrayscaleImageSequence() Retrieves a sequence which provides the content of the grayscale image pixel data to be printed.
java.lang.String	getConfigurationInformation() Return character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g.
short	getImagePosition() Retrieves the position of the image on the film, based on Image Display Format (2010,0010).
java.lang.String	getMagnificationType() Retrieves Magnification Type.
java.lang.String	getPolarity() Retrieves whether minimum pixel values (after VOI LUT transformation) are to printed black or white.
java.lang.String	getRequestedDecimateOrCropBehavior() Return whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box.
java.lang.String	getRequestedImageSize() Return width (x-dimension) in mm of the image to be printed.
java.lang.String	getSmoothingType() Return value that specifies the type of the interpolation function.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the Image Box Pixel Presentation Module.
void	setConfigurationInformation(java.lang.String strConfigurationInformation) Sets character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g.
void	setImagePosition(short sImagePosition) Sets the position of the image on the film, based on Image Display Format (2010,0010).
void	setMagnificationType(EnumMagnificationType enumMagnificationType) Sets interpolation type by which the printer magnifies or decimates the image in order to fit the image in the image box on film.
void	setPolarity(EnumPolarity enumPolarity) Sets whether minimum pixel values (after VOI LUT transformation) are to printed black or white.
void	setRequestedDecimateOrCropBehavior(EnumDecimateOrCropBehavior enumDecimateOrCropBehavior) Sets whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box.
void	setRequestedImageSize(java.lang.String strRequestedImageSize) Sets width (x-dimension) in mm of the image to be printed.
void	setSmoothingType(java.lang.String strSmoothingType) Sets value that specifies the type of the interpolation function.
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

ImageBoxPixelPresentationModule

public ImageBoxPixelPresentationModule(IDataSet objIDataSet)

Creates Clinical Trial Series Module with default initialization.

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

setImagePosition

public void setImagePosition(short sImagePosition)

Sets the position of the image on the film, based on Image Display Format (2010,0010).

Parameters:

sImagePosition - - short value of Image Position.

getImagePosition

public short getImagePosition()

Retrieves the position of the image on the film, based on Image Display Format (2010,0010).

Returns:

short - short value of Image Position.

setPolarity

public void setPolarity(EnumPolarity enumPolarity)

Sets whether minimum pixel values (after VOI LUT transformation) are to printed black or white. Enumerated Values: 1) NORMAL = pixels shall be printed as specified by the Photometric Interpretation (0028,0004) 2) REVERSE = pixels shall be printed with the opposite polarity as specified by the Photometric Interpretation (0028,0004). If Polarity (2020,0020) is not specified by the SCU, the SCP shall print with NORMAL polarity.

Parameters:

enumPolarity - - Enum value of Polarity.

getPolarity

public java.lang.String getPolarity()

Retrieves whether minimum pixel values (after VOI LUT transformation) are to printed black or white.

Returns:

String - String value of Polarity.

setMagnificationType

public void setMagnificationType(EnumMagnificationType enumMagnificationType)

Sets interpolation type by which the printer magnifies or decimates the image in order to fit the image in the image box on film. Defined Terms: 1) REPLICATE 2) BILINEAR 3) CUBIC 4) NONE

Parameters:

enumMagnificationType - - Enum value of Magnification Type.

getMagnificationType

public java.lang.String getMagnificationType()

Retrieves Magnification Type.

Returns:

String - String value of Magnification Type.

setSmoothingType

public void setSmoothingType(java.lang.String strSmoothingType)

Sets value that specifies the type of the interpolation function. Values are defined in Conformance Statement. Only valid for Magnification Type (2010,0060) = CUBIC.

Parameters:

strSmoothingType - - String value of Smoothing Type.

getSmoothingType

public java.lang.String getSmoothingType()

Return value that specifies the type of the interpolation function.

Returns:

String - String value of Smoothing Type.

setConfigurationInformation

public void setConfigurationInformation(java.lang.String strConfigurationInformation)

Sets character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g. perception LUT related parameters) or one or more configuration data values, encoded as characters.

Parameters:

strConfigurationInformation - - String value of Configuration Information.

getConfigurationInformation

public java.lang.String getConfigurationInformation()

Return character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g. perception LUT related parameters) or one or more configuration data values, encoded as characters.

Returns:

String - String value of Configuration Information.

setRequestedImageSize

public void setRequestedImageSize(java.lang.String strRequestedImageSize)

Sets width (x-dimension) in mm of the image to be printed. This value overrides the size that corresponds with optimal filling of the Image Box.

Parameters:

strRequestedImageSize - - String value of Requested Image Size.

getRequestedImageSize

public java.lang.String getRequestedImageSize()

Return width (x-dimension) in mm of the image to be printed. This value overrides the size that corresponds with optimal filling of the Image Box.

Returns:

String - String value of Requested Image Size.

setRequestedDecimateOrCropBehavior

public void setRequestedDecimateOrCropBehavior(EnumDecimateOrCropBehavior enumDecimateOrCropBehavior)

Sets whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box. Enumerated Values: 1) DECIMATE = a magnification factor <1 to be applied to the image. 2) CROP = some image rows and/or columns are to be deleted before printing. The specific algorithm for cropping shall be described in the SCP Conformance Statement. 3) FAIL = the SCP shall not crop or decimate.

Parameters:

enumDecimateOrCropBehavior - - Enum value of Requested Decimate/Crop Behavior.

getRequestedDecimateOrCropBehavior

public java.lang.String getRequestedDecimateOrCropBehavior()

Return whether image pixels are to be decimated or cropped if the image rows or columns is greater than the available printable pixels in an Image Box.

Returns:

String - String value of Requested Decimate/Crop Behavior.

getBasicGrayscaleImageSequence

public BasicGrayscaleImageSequence getBasicGrayscaleImageSequence()

Retrieves a sequence which provides the content of the grayscale image pixel data to be printed.

Returns:

BasicGrayscaleImageSequence - instance of BasicGrayscaleImageSequence.

getBasicColorImageSequence

public BasicColorImageSequence getBasicColorImageSequence()

Retrieves a sequence which provides the content of the color image pixel data to be printed.

Returns:

BasicColorImageSequence - instance of BasicColorImageSequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

collection of Tags - custom collection containing the list of DataElements belonging to the Image Box Pixel Presentation Module