cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SCMultiFrameImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SCMultiFrameImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SCMultiFrameImageModule
extends Module

\* This module describes SC Multi-Frame 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
SCMultiFrameImageModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
BasicPixelSpacingCalibrationMacro	getBasicPixelSpacingCalibrationMacro() Returns instance of Basic Pixel Spacing Calibration Macro.
java.lang.String	getBurnedInAnnotation() Retrieves Burned In Annotation.
java.lang.String	getDigitizingDeviceTransportDirection() Retrieves Digitizing Device Transport Direction.
ISingleCollection<ITag>	getFrameIncrementPointer() Retrieves the collections of Frame Increment Pointers.
short	getIllumination() Retrieves Illumination.
java.lang.String[]	getNominalScannedPixelSpacing() Retrieves Nominal Scanned Pixel Spacing.
java.lang.String	getPresentationLUTShape() Retrieves Presentation LUT Shape.
java.lang.String	getRecognizableVisualFeatures() Return tRecognizable Visual Features
short	getReflectedAmbientLight() Retrieves Reflected Ambient Light.
java.lang.String	getRescaleIntercept() Retrieves Rescale Intercept.
java.lang.String	getRescaleSlope() Retrieves Rescale Slope.
java.lang.String	getRescaleType() Retrieves Rescale Type.
java.lang.String	getRotationOfScannedFilm() Retrieves Rotation of Scanned Film.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation) Sets Burned In Annotation.
void	setDigitizingDeviceTransportDirection(EnumDigitizingDeviceTransportDirection enumDigitizingDeviceTransportDirection) Sets Digitizing Device Transport Direction.
void	setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection) Sets value that is Used to specify multiple values for Frame Increment Pointer.
void	setIllumination(short shIllumination) Sets Illumination.
void	setNominalScannedPixelSpacing(java.lang.String[] arrstrNominalScannedPixelSpacing) Sets Nominal Scanned Pixel Spacing.
void	setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape) Specifies an identity transformation for the Presentation LUT.
void	setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures) Sets indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set of images to identifythe patient.
void	setReflectedAmbientLight(short shReflectedAmbientLight) Sets Reflected Ambient Light.
void	setRescaleIntercept(EnumRescaleIntercept enumRescaleIntercept) Sets Rescale Intercept.
void	setRescaleSlope(EnumRescaleSlope enumRescaleSlope) Sets Rescale Slope.
void	setRescaleType(EnumRescaleType enumRescaleType) Sets Rescale Type.
void	setRotationOfScannedFilm(java.lang.String strRotationOfScannedFilm) Sets Rotation of Scanned Film.
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

SCMultiFrameImageModule

public SCMultiFrameImageModule(IDataSet objIDataSet)

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

setBurnedInAnnotation

public void setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation)

Sets Burned In Annotation. Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.

Parameters:

enumBurnedInAnnotation - - Enum value of Burned In Annotation.

getBurnedInAnnotation

public java.lang.String getBurnedInAnnotation()

Retrieves Burned In Annotation.

Returns:

the burned in annotation

setRecognizableVisualFeatures

public void setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures)

Sets indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set of images to identifythe patient. Enumerated Values: YES NO

Parameters:

enumRecognizableVisualFeatures - enum value of Recognizable Visual Features .

getRecognizableVisualFeatures

public java.lang.String getRecognizableVisualFeatures()

Return tRecognizable Visual Features

Returns:

String - value of Recognizable Visual Features

setPresentationLUTShape

public void setPresentationLUTShape(EnumPresentationLUTShape enumPresentationLUTShape)

Specifies an identity transformation for the Presentation LUT.

Parameters:

enumPresentationLUTShape - - Enum value of Presentation LUT Shape.

getPresentationLUTShape

public java.lang.String getPresentationLUTShape()

Retrieves Presentation LUT Shape.

Returns:

the presentation lut shape

setIllumination

public void setIllumination(short shIllumination)

Sets Illumination. Luminance of a hypothetical viewing device illuminating a piece of monochrome 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()

Retrieves Illumination.

Returns:

the illumination

setReflectedAmbientLight

public void setReflectedAmbientLight(short shReflectedAmbientLight)

Sets Reflected Ambient Light. For scanned monochrome transmissive film viewed on a hypothetical viewing device, the luminance contribution due to reflected ambient light.

Parameters:

shReflectedAmbientLight - - short value of Reflected Ambient Light.

getReflectedAmbientLight

public short getReflectedAmbientLight()

Retrieves Reflected Ambient Light.

Returns:

the reflected ambient light

setRescaleIntercept

public void setRescaleIntercept(EnumRescaleIntercept enumRescaleIntercept)

Sets Rescale Intercept.

Parameters:

enumRescaleIntercept - - Enum value of Rescale Intercept.

getRescaleIntercept

public java.lang.String getRescaleIntercept()

Retrieves Rescale Intercept.

Returns:

the rescale intercept

setRescaleSlope

public void setRescaleSlope(EnumRescaleSlope enumRescaleSlope)

Sets Rescale Slope.

Parameters:

enumRescaleSlope - - Enum value of Rescale Slope.

getRescaleSlope

public java.lang.String getRescaleSlope()

Retrieves Rescale Slope.

Returns:

the rescale slope

setRescaleType

public void setRescaleType(EnumRescaleType enumRescaleType)

Sets Rescale Type.

Parameters:

enumRescaleType - - Enum value of Rescale Type.

getRescaleType

public java.lang.String getRescaleType()

Retrieves Rescale Type.

Returns:

the rescale type

setFrameIncrementPointer

public void setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection)

Sets value that is Used to specify multiple values for Frame Increment Pointer.

Parameters:

objSingleCollection - - Collection of Tags (GroupNumber and ElementNumbers)

getFrameIncrementPointer

public ISingleCollection<ITag> getFrameIncrementPointer()

Retrieves the collections of Frame Increment Pointers.

Returns:

ISingleCollection - collection of Tag objects

setNominalScannedPixelSpacing

public void setNominalScannedPixelSpacing(java.lang.String[] arrstrNominalScannedPixelSpacing)

Sets Nominal Scanned Pixel Spacing.

Parameters:

arrstrNominalScannedPixelSpacing - - String value of Nominal Scanned Pixel Spacing.

getNominalScannedPixelSpacing

public java.lang.String[] getNominalScannedPixelSpacing()

Retrieves Nominal Scanned Pixel Spacing.

Returns:

the nominal scanned pixel spacing

getBasicPixelSpacingCalibrationMacro

public BasicPixelSpacingCalibrationMacro getBasicPixelSpacingCalibrationMacro()

Returns instance of Basic Pixel Spacing Calibration Macro.

Returns:

Instance of Basic Pixel Spacing Calibration Macro

setDigitizingDeviceTransportDirection

public void setDigitizingDeviceTransportDirection(EnumDigitizingDeviceTransportDirection enumDigitizingDeviceTransportDirection)

Sets Digitizing Device Transport Direction.

Parameters:

enumDigitizingDeviceTransportDirection - the enum digitizing device transport direction

getDigitizingDeviceTransportDirection

public java.lang.String getDigitizingDeviceTransportDirection()

Retrieves Digitizing Device Transport Direction.

Returns:

the digitizing device transport direction

setRotationOfScannedFilm

public void setRotationOfScannedFilm(java.lang.String strRotationOfScannedFilm)

Sets Rotation of Scanned Film.

Parameters:

strRotationOfScannedFilm - - String value of Rotation of Scanned Film.

getRotationOfScannedFilm

public java.lang.String getRotationOfScannedFilm()

Retrieves Rotation of Scanned Film.

Returns:

the rotation of scanned film

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.