cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class OphthalmicPhotographicParametersModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OphthalmicPhotographicParametersModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class OphthalmicPhotographicParametersModule
extends Module

\* This module specifies the Attributes that describe an Ophthalmic Photographic Parameters Module \* This module describes equipment used to create original images.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OphthalmicPhotographicParametersModule(IDataSet objIDataSet) Instantiates a new ophthalmic photographic parameters module.

Method Summary

Methods

Modifier and Type	Method and Description
AcquisitionDeviceTypeCodeSequence	getAcquisitionDeviceTypeCodeSequence() This method Returns provides the pre-initialized object of Acquisition Device Type Code Sequence return - object of Acquisition Device Type Code Sequence.
float	getCameraAngleofView() Retrieves CameraAngleofView
ChannelDescriptionCodeSequence	getChannelDescriptionCodeSequence() This method Returns provides the pre-initialized object of Channel Description Code Sequence return - object of Channel Description Code Sequence.
java.lang.String	getDetectorType() Return the type of detector used to acquire this image.
IlluminationTypeCodeSequence	getIlluminationTypeCodeSequence() This method Returns provides the pre-initialized object of Illumination Type Code Sequence return - object of Illumination Type Code Sequence.
short[]	getImagePathFilterPassBand() Retrieves the value of Pass band of image path filter in nm.
short	getImagePathFilterPassThroughWavelength() Retrieves the value of Nominal pass-through wavelength of image path filter in nm.
ImagePathFilterTypeStackCodeSequence	getImagePathFilterTypeStackCodeSequence() This method Returns provides the pre-initialized object of Image Path Filter Type Stack Code Sequence return - object of Image Path Filter Type Stack Code Sequence.
LensesCodeSequence	getLensesCodeSequence() This method Returns provides the pre-initialized object of Lenses Code Sequence return - object of Image Lenses Code Sequence.
short[]	getLightPathFilterPassBand() Retrieves the value of Pass band of light path filter in nm.
LightPathFilterTypeStackCodeSequence	getLightPathFilterTypeStackCodeSequence() This method Returns provides the pre-initialized object of Light Path Filter Type Stack Code Sequence return - object of Light Path Filter Type Stack Code Sequence.
short	getPatientEyeMovementCommanded() Retrieves the value of Nominal pass-through wavelength of light path filter in nm.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setCameraAngleofView(float fCameraAngleofView) Sets CameraAngleofView
void	setDetectorType(EnumDetectorType enumDetectorType) Sets the type of detector used to acquire this image.
void	setImagePathFilterPassBand(short[] shImagePathFilterPassBand) Sets the value of Pass band of image path filter in nm.
void	setImagePathFilterPassThroughWavelength(short shImagePathFilterPassThroughWavelength) Sets the value of Nominal pass-through wavelength of image path filter in nm.
void	setLightPathFilterPassBand(short[] shLightPathFilterPassBand) Sets the value of Pass band of light path filter in nm.
void	setLightPathFilterPassThroughWavelength(short shLightPathFilterPassThroughWavelength) Sets the value of Nominal pass-through wavelength of light path filter in nm.
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

OphthalmicPhotographicParametersModule

public OphthalmicPhotographicParametersModule(IDataSet objIDataSet)

Instantiates a new ophthalmic photographic parameters 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

getAcquisitionDeviceTypeCodeSequence

public AcquisitionDeviceTypeCodeSequence getAcquisitionDeviceTypeCodeSequence()

This method Returns provides the pre-initialized object of Acquisition Device Type Code Sequence return - object of Acquisition Device Type Code Sequence. If the module contans 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

Returns:

SourceImageSequence - the Patient Eye Movement Command Code Sequence

getIlluminationTypeCodeSequence

public IlluminationTypeCodeSequence getIlluminationTypeCodeSequence()

This method Returns provides the pre-initialized object of Illumination Type Code Sequence return - object of Illumination Type Code Sequence. If the module contans 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

Returns:

SourceImageSequence - the Illumination Type Code Sequence

getLightPathFilterTypeStackCodeSequence

public LightPathFilterTypeStackCodeSequence getLightPathFilterTypeStackCodeSequence()

This method Returns provides the pre-initialized object of Light Path Filter Type Stack Code Sequence return - object of Light Path Filter Type Stack Code Sequence. If the module contans 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

Returns:

SourceImageSequence - the Light Path Filter Type Stack Code Sequence

setLightPathFilterPassThroughWavelength

public void setLightPathFilterPassThroughWavelength(short shLightPathFilterPassThroughWavelength)

Sets the value of Nominal pass-through wavelength of light path filter in nm.

Parameters:

shLightPathFilterPassThroughWavelength - the sh light path filter pass through wavelength

getPatientEyeMovementCommanded

public short getPatientEyeMovementCommanded()

Retrieves the value of Nominal pass-through wavelength of light path filter in nm.

Returns:

the patient eye movement commanded

setLightPathFilterPassBand

public void setLightPathFilterPassBand(short[] shLightPathFilterPassBand)

Sets the value of Pass band of light path filter in nm.

Parameters:

shLightPathFilterPassBand - - value of Pass band of light path filter in nm.

getLightPathFilterPassBand

public short[] getLightPathFilterPassBand()

Retrieves the value of Pass band of light path filter in nm.

Returns:

the light path filter pass band

getImagePathFilterTypeStackCodeSequence

public ImagePathFilterTypeStackCodeSequence getImagePathFilterTypeStackCodeSequence()

This method Returns provides the pre-initialized object of Image Path Filter Type Stack Code Sequence return - object of Image Path Filter Type Stack Code Sequence. If the module contans 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

Returns:

SourceImageSequence - the Image Path Filter Type Stack Code Sequence

setImagePathFilterPassThroughWavelength

public void setImagePathFilterPassThroughWavelength(short shImagePathFilterPassThroughWavelength)

Sets the value of Nominal pass-through wavelength of image path filter in nm.

Parameters:

shImagePathFilterPassThroughWavelength - the sh image path filter pass through wavelength

getImagePathFilterPassThroughWavelength

public short getImagePathFilterPassThroughWavelength()

Retrieves the value of Nominal pass-through wavelength of image path filter in nm.

Returns:

the image path filter pass through wavelength

setImagePathFilterPassBand

public void setImagePathFilterPassBand(short[] shImagePathFilterPassBand)

Sets the value of Pass band of image path filter in nm.

Parameters:

shImagePathFilterPassBand - the sh image path filter pass band

getImagePathFilterPassBand

public short[] getImagePathFilterPassBand()

Retrieves the value of Pass band of image path filter in nm.

Returns:

the image path filter pass band

getLensesCodeSequence

public LensesCodeSequence getLensesCodeSequence()

This method Returns provides the pre-initialized object of Lenses Code Sequence return - object of Image Lenses Code Sequence. If the module contans 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

Returns:

SourceImageSequence - the Lenses Code Sequence

setDetectorType

public void setDetectorType(EnumDetectorType enumDetectorType)

Sets the type of detector used to acquire this image. Defined Terms: DIRECT = X-Ray photoconductor, SCINTILLATOR = Phosphor used, STORAGE = Storage phosphor, FILM = Scanned film/screen.

Parameters:

enumDetectorType - the enum detector type

getDetectorType

public java.lang.String getDetectorType()

Return the type of detector used to acquire this image.

Returns:

- String value of Detector Type

getChannelDescriptionCodeSequence

public ChannelDescriptionCodeSequence getChannelDescriptionCodeSequence()

This method Returns provides the pre-initialized object of Channel Description Code Sequence return - object of Channel Description Code Sequence. If the module contans 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

Returns:

SourceImageSequence - the Channel Description Code Sequence

setCameraAngleofView

public void setCameraAngleofView(float fCameraAngleofView)

Sets CameraAngleofView

Parameters:

fCameraAngleofView - Float value of the CameraAngleofView

getCameraAngleofView

public float getCameraAngleofView()

Retrieves CameraAngleofView

Returns:

float - Float value of the CameraAngleofView

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