cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class BasicFilmBoxPresentationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.BasicFilmBoxPresentationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class BasicFilmBoxPresentationModule
extends Module

\* This module is used for Basic Film Box 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
BasicFilmBoxPresentationModule(IDataSet objIDataSet) Instantiates a new basic film box presentation module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAnnotationDisplayFormatID() Return identification of annotation display format.
java.lang.String	getBorderDensity() Return density of the film areas surrounding and between images on the film.
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.
java.lang.String	getEmptyImageDensity() Return density of the image box area on the film that contains no image.
java.lang.String	getFilmOrientation() Return Film orientation.
java.lang.String	getFilmSizeID() Return Film size identification.
ISingleCollection<byte[]>	getICCProfile() Return the String value of ICC Profile.
short	getIllumination() Return luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.
java.lang.String	getImageDisplayFormat() Return Type of image display format.
java.lang.String	getMagnificationType() Return interpolation type by which the printer magnifies or decimates the image in order to fit the image in the image box on film.
short	getMaxDensity() Return maximum density of the images on the film, expressed in hundredths of OD.
short	getMinDensity() Return minimum density of the images on the film, expressed in hundredths of OD.
short	getReflectedAmbientLight() Return luminance contribution due to reflected ambient light.
java.lang.String	getRequestedResolutionID() Return the resolution at which images in this Film Box are to be printed.
java.lang.String	getSmoothingType() Return value that specifies the type of the interpolation function.
java.lang.String	getTrim() Return whether a trim box shall be printed surrounding each image on the film.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAnnotationDisplayFormatID(java.lang.String strAnnotationDisplayFormatID) Sets identification of annotation display format.
void	setBorderDensity(EnumBorderDensity enumBorderDensity) Sets density of the film areas surrounding and between images on the film.
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	setEmptyImageDensity(EnumEmptyImageDensity enumEmptyImageDensity) Sets density of the image box area on the film that contains no image.
void	setFilmOrientation(EnumFilmOrientation enumFilmOrientation) Sets Film orientation.
void	setFilmSizeID(EnumFilmSizeID enumFilmSizeID) Sets Film size identification.
void	setICCProfile(ISingleCollection<byte[]> objCollectionICCProfile) Sets ICC Profile.
void	setIllumination(short shIllumination) Sets luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.
void	setImageDisplayFormat(EnumImageDisplayFormat enumImageDisplayFormat) Sets Type of image display format.
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	setMaxDensity(short shMaxDensity) Sets maximum density of the images on the film, expressed in hundredths of OD.
void	setMinDensity(short shMinDensity) Sets minimum density of the images on the film, expressed in hundredths of OD.
void	setReflectedAmbientLight(short shReflectedAmbientLight) Sets luminance contribution due to reflected ambient light.
void	setRequestedResolutionID(EnumRequestedResolutionID enumRequestedResolutionID) Sets the resolution at which images in this Film Box are to be printed.
void	setSmoothingType(java.lang.String strSmoothingType) Sets value that specifies the type of the interpolation function.
void	setTrim(EnumTrim enumTrim) Sets whether a trim box shall be printed surrounding each image on the film.
boolean	validateModule() 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

BasicFilmBoxPresentationModule

public BasicFilmBoxPresentationModule(IDataSet objIDataSet)

Instantiates a new basic film box presentation module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

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:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setImageDisplayFormat

public void setImageDisplayFormat(EnumImageDisplayFormat enumImageDisplayFormat)

Sets Type of image display format. Enumerated Values: STANDARD\C,R : film contains equal size rectangular image boxes with R rows of image boxes and C columns of image boxes; C and R are integers. ROW\R1,R2,R3, etc. : film contains rows with equal size rectangular image boxes with R1 image boxes in the first row, R2 image boxes in second row, R3 image boxes in third row, etc.; R1, R2, R3, etc. are integers. COL\C1,C2,C3, etc. : film contains columns with equal size rectangular image boxes with C1 image boxes in the first column, C2 image boxes in second column, C3 image boxes in third column, etc.; C1,C2, C3, etc. are integers. SLIDE : film contains 35mm slides; the number of slides for a particular film size is configuration dependent. SUPERSLIDE : film contains 40mm slides; the number of slides for a particular film size is configuration dependent. CUSTOM\i : film contains a customized ordering of rectangular image boxes; i identifies the image display format; the definition of the image display formats is defined in the Conformance Statement; i is an integer.

Parameters:

enumImageDisplayFormat - the enum image display format

getImageDisplayFormat

public java.lang.String getImageDisplayFormat()

Return Type of image display format.

Returns:

String - String value of Image Display Format.

setAnnotationDisplayFormatID

public void setAnnotationDisplayFormatID(java.lang.String strAnnotationDisplayFormatID)

Sets identification of annotation display format. The definition of the annotation display formats and the annotation box position sequence are defined in the Conformance Statement.

Parameters:

strAnnotationDisplayFormatID - String value of Annotation Display Format ID.

getAnnotationDisplayFormatID

public java.lang.String getAnnotationDisplayFormatID()

Return identification of annotation display format.

Returns:

String - String value of Annotation Display Format ID.

setFilmOrientation

public void setFilmOrientation(EnumFilmOrientation enumFilmOrientation)

Sets Film orientation. Enumerated Values: PORTRAIT = vertical film position. LANDSCAPE = horizontal film position.

Parameters:

enumFilmOrientation - String value of Film Orientation.

getFilmOrientation

public java.lang.String getFilmOrientation()

Return Film orientation.

Returns:

String - String value of Film orientation.

setFilmSizeID

public void setFilmSizeID(EnumFilmSizeID enumFilmSizeID)

Sets Film size identification. Defined Terms: 8INX10IN,8_5INX11IN,10INX12IN,10INX14IN,11INX14IN,,11INX17IN,14INX14IN, 14INX17IN,24CMX24CM,24CMX30CM,A4,A3.

Parameters:

enumFilmSizeID - String value of Film Size ID.

getFilmSizeID

public java.lang.String getFilmSizeID()

Return Film size identification.

Returns:

String - String value of Film size ID.

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: REPLICATE, BILINEAR,CUBIC,NONE.

Parameters:

enumMagnificationType - String value of Magnification Type.

getMagnificationType

public java.lang.String getMagnificationType()

Return interpolation type by which the printer magnifies or decimates the image in order to fit the image in the image box on film.

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.

setBorderDensity

public void setBorderDensity(EnumBorderDensity enumBorderDensity)

Sets density of the film areas surrounding and between images on the film. Defined Terms: 1) BLACK 2) WHITE 3) i where i represents the desired density in hundreds of OD (e.g. 150 corresponds with 1.5 OD)

Parameters:

enumBorderDensity - the enum border density

getBorderDensity

public java.lang.String getBorderDensity()

Return density of the film areas surrounding and between images on the film.

Returns:

String - String value of Border Density.

setEmptyImageDensity

public void setEmptyImageDensity(EnumEmptyImageDensity enumEmptyImageDensity)

Sets density of the image box area on the film that contains no image. Defined Terms: 1) BLACK 2) WHITE 3) i where i represents the desired density in hundreds of OD (e.g. 150 corresponds with 1.5 OD)

Parameters:

enumEmptyImageDensity - the enum empty image density

getEmptyImageDensity

public java.lang.String getEmptyImageDensity()

Return density of the image box area on the film that contains no image.

Returns:

String - String value of Empty Image Density.

setMinDensity

public void setMinDensity(short shMinDensity)

Sets minimum density of the images on the film, expressed in hundredths of OD. If Min Density is lower than minimum printer density than Min Density is set to minimum printer density.

Parameters:

shMinDensity - - short value of Min Density.

getMinDensity

public short getMinDensity()

Return minimum density of the images on the film, expressed in hundredths of OD.

Returns:

short - short value of Min Density.

setMaxDensity

public void setMaxDensity(short shMaxDensity)

Sets maximum density of the images on the film, expressed in hundredths of OD. If Max Density is higher than maximum printer density than Max Density is set to maximum printer density.

Parameters:

shMaxDensity - - short value of Max Density.

getMaxDensity

public short getMaxDensity()

Return maximum density of the images on the film, expressed in hundredths of OD.

Returns:

short - short value of Max Density.

setTrim

public void setTrim(EnumTrim enumTrim)

Sets whether a trim box shall be printed surrounding each image on the film. Enumerated Values: 1) YES 2) NO.

Parameters:

enumTrim - the enum trim

getTrim

public java.lang.String getTrim()

Return whether a trim box shall be printed surrounding each image on the film.

Returns:

String - String value of Trim.

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.

setIllumination

public void setIllumination(short shIllumination)

Sets luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.

Parameters:

shIllumination - - short value of Illumination.

getIllumination

public short getIllumination()

Return luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.

Returns:

short - short value of Illumination.

setReflectedAmbientLight

public void setReflectedAmbientLight(short shReflectedAmbientLight)

Sets luminance contribution due to reflected ambient light.

Parameters:

shReflectedAmbientLight - the sh reflected ambient light

getReflectedAmbientLight

public short getReflectedAmbientLight()

Return luminance contribution due to reflected ambient light.

Returns:

short - short value of Reflected Ambient Light.

setRequestedResolutionID

public void setRequestedResolutionID(EnumRequestedResolutionID enumRequestedResolutionID)

Sets the resolution at which images in this Film Box are to be printed. Defined Terms: 1) STANDARD = approximately 4k x 5k printable pixels on a 14 x 17 inch film 2) HIGH = Approximately twice the resolution of STANDARD.

Parameters:

enumRequestedResolutionID - the enum requested resolution id

getRequestedResolutionID

public java.lang.String getRequestedResolutionID()

Return the resolution at which images in this Film Box are to be printed.

Returns:

String - String value of Requested Resolution ID.

setICCProfile

public void setICCProfile(ISingleCollection<byte[]> objCollectionICCProfile)

Sets ICC Profile.

Parameters:

objCollectionICCProfile - : ISingle Collection of bytes.

getICCProfile

public ISingleCollection<byte[]> getICCProfile()

Return the String value of ICC Profile.

Returns:

Collection of byte[] - returns the collection of ICC Profile

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