cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class OphthalmicTomographyParametersModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OphthalmicTomographyParametersModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class OphthalmicTomographyParametersModule
extends Module

\* This module specifies the attributes that describe an Ophthalmic Tomography Parameters Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OphthalmicTomographyParametersModule(IDataSet objIDataSet) Instantiates a new ophthalmic photography acquisition 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	getAcrossScanSpatialResolution() Retrieves Across-scan Spatial Resolution
float	getAlongScanSpatialResolution() Retrieves Along-scan Spatial Resolution
float	getDepthSpatialResolutiont() Retrieves Depth Spatial Resolution
java.lang.String	getDetectorType() Return the type of detector used to acquire this image.
float	getIlluminationBandwidth() Retrieves Illumination Bandwidth
float	getIlluminationPower() Retrieves Illumination Power
float	getIlluminationWaveLength() Retrieves Illumination Wave Length
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.
float	getMaximumAcrossScanDistortion() Retrieves Maximum Across-scan Distortion
float	getMaximumAlongScanDistortion() Retrieves Maximum Along-scan Distortion
float	getMaximumDepthDistortion() Retrieves Maximum Depth Distortion
void	setAcrossScanSpatialResolution(float fAcrossScanSpatialResolution) Sets Across-scan Spatial Resolution
void	setAlongScanSpatialResolution(float fAlongScanSpatialResolution) Sets Along-scan Spatial Resolution
void	setDepthSpatialResolution(float fDepthSpatialResolution) Sets Depth Spatial Resolution
void	setDetectorType(EnumDetectorType enumDetectorType) Sets the type of detector used to acquire this image.
void	setIlluminationBandwidth(float fIlluminationBandwidth) Sets Illumination Bandwidth
void	setIlluminationPower(float fIlluminationPower) Sets Illumination Power
void	setIlluminationWaveLength(float fIlluminationWaveLength) Sets Illumination Wave Length
void	setMaximumAcrossScanDistortion(float fMaximumAcrossScanDistortion) Sets Maximum Across-scan Distortion
void	setMaximumAlongScanDistortion(float fMaximumAlongScanDistortion) Sets Maximum Along-scan Distortion
void	setMaximumDepthDistortion(float fMaximumDepthDistortion) Sets Maximum Depth Distortion
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, getVectorOfKeys, 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

OphthalmicTomographyParametersModule

public OphthalmicTomographyParametersModule(IDataSet objIDataSet)

Instantiates a new ophthalmic photography acquisition 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

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

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

setIlluminationWaveLength

public void setIlluminationWaveLength(float fIlluminationWaveLength)

Sets Illumination Wave Length

Parameters:

fIlluminationWaveLength - Float value of the Illumination Wave Length

getIlluminationWaveLength

public float getIlluminationWaveLength()

Retrieves Illumination Wave Length

Returns:

float - Float value of the Illumination Wave Length

setIlluminationPower

public void setIlluminationPower(float fIlluminationPower)

Sets Illumination Power

Parameters:

fIlluminationPower - Float value of the Illumination Power

getIlluminationPower

public float getIlluminationPower()

Retrieves Illumination Power

Returns:

float - Float value of the Illumination Power

setIlluminationBandwidth

public void setIlluminationBandwidth(float fIlluminationBandwidth)

Sets Illumination Bandwidth

Parameters:

fIlluminationBandwidth - Float value of the Illumination Bandwidth

getIlluminationBandwidth

public float getIlluminationBandwidth()

Retrieves Illumination Bandwidth

Returns:

float - Float value of the Illumination Bandwidth

setDepthSpatialResolution

public void setDepthSpatialResolution(float fDepthSpatialResolution)

Sets Depth Spatial Resolution

Parameters:

fDepthSpatialResolution - Float value of the Depth Spatial Resolution

getDepthSpatialResolutiont

public float getDepthSpatialResolutiont()

Retrieves Depth Spatial Resolution

Returns:

float - Float value of the Depth Spatial Resolution.

setMaximumDepthDistortion

public void setMaximumDepthDistortion(float fMaximumDepthDistortion)

Sets Maximum Depth Distortion

Parameters:

fMaximumDepthDistortion - Float value of the Maximum Depth Distortion

getMaximumDepthDistortion

public float getMaximumDepthDistortion()

Retrieves Maximum Depth Distortion

Returns:

float - Float value of the Maximum Depth Distortion

setAlongScanSpatialResolution

public void setAlongScanSpatialResolution(float fAlongScanSpatialResolution)

Sets Along-scan Spatial Resolution

Parameters:

fAlongScanSpatialResolution - Float value of the Along-scan Spatial Resolution

getAlongScanSpatialResolution

public float getAlongScanSpatialResolution()

Retrieves Along-scan Spatial Resolution

Returns:

float - Float value of the Along-scan Spatial Resolution

setMaximumAlongScanDistortion

public void setMaximumAlongScanDistortion(float fMaximumAlongScanDistortion)

Sets Maximum Along-scan Distortion

Parameters:

fMaximumAlongScanDistortion - Float value of the Maximum Along-scan Distortion

getMaximumAlongScanDistortion

public float getMaximumAlongScanDistortion()

Retrieves Maximum Along-scan Distortion

Returns:

float - Float value of the Maximum Along-scan Distortion

setAcrossScanSpatialResolution

public void setAcrossScanSpatialResolution(float fAcrossScanSpatialResolution)

Sets Across-scan Spatial Resolution

Parameters:

fAcrossScanSpatialResolution - Float value of the Across-scan Spatial Resolution

getAcrossScanSpatialResolution

public float getAcrossScanSpatialResolution()

Retrieves Across-scan Spatial Resolution

Returns:

float - Float value of the Across-scan Spatial Resolution

setMaximumAcrossScanDistortion

public void setMaximumAcrossScanDistortion(float fMaximumAcrossScanDistortion)

Sets Maximum Across-scan Distortion

Parameters:

fMaximumAcrossScanDistortion - Float value of the Maximum Across-scan Distortion

getMaximumAcrossScanDistortion

public float getMaximumAcrossScanDistortion()

Retrieves Maximum Across-scan Distortion

Returns:

float - Float value of the Maximum Across-scan Distortion