cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class CornealTopographyMapAnalysisModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CornealTopographyMapAnalysisModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class CornealTopographyMapAnalysisModule
extends Module

\* This module is used for Corneal Topography Map Analysis Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CornealTopographyMapAnalysisModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
float	getAnalyzedArea() Retrieves Analyzed Area
float	getAverageCornealPower() Retrieves area-corrected average of the corneal power ahead of the entrancepupil, measured in diopters.
float	getCornealEccentricityIndex() Retrieves Corneal Eccentricity Index
float	getCornealISValue() Retrieves Corneal I-S Value
CornealTopographyMappingNormalsSequence	getCornealTopographyMappingNormalsSequence() Retrieves a sequence which provides references to Corneal Topography MappingNormals Sequence
java.lang.String	getCornealTopographyMapQualityEvaluation() Retrieves the quality of the topography examination.
CornealTopographyMapTypeCodeSequence	getCornealTopographyMapTypeCodeSequence() Retrieves a sequence which provides references to Corneal Topography Map TypeCode Sequence
java.lang.String	getCornealTopographySurface() Retrieves Corneal Topography Surface
float[]	getCornealVertexLocation() Retrieves Corneal Vertex Location
float	getDecimalPotentialVisualAcuity() Retrieves the range of best spectacle-corrected distance that might be expected from a functionally normal eye with the topographical characteristics of theanalyzed cornea, measured in decimal.
float	getEquivalentPupilRadius() Retrieves Equivalent Pupil Radius
float	getKeratoconusPredictionIndex() Retrieves Keratoconus Prediction Index
KeratometricMeasurementsMacro	getKeratometricMeasurementsMacro() Get the Instance of Keratometric MeasurementsMacro related to Content Identification will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
MaximumCornealCurvatureSequence	getMaximumCornealCurvatureSequence() Retrieves a sequence which provides references to Maximum Corneal CurvatureSequence
MinimumKeratometricSequence	getMinimumKeratometricSequence() Retrieves a sequence which provides references to Minimum Keratometric Sequence
java.lang.String	getOphthalmicMappingDeviceType() Retrieves OphthalmicMappingDeviceType
float	getPupilCentroidXCoordinate() Retrieves Pupil CentroidX-Coordinate
float	getPupilCentroidYCoordinate() Retrieves Pupil Centroid Y-Coordinate
SimulatedKeratometricCylinderSequence	getSimulatedKeratometricCylinderSequence() Retrieves a sequence which provides references to Simulated Keratometric CylinderSequence
SourceImageCornealProcessedDataSequence	getSourceImageCornealProcessedDataSequence() Retrieves a sequence which provides references to Source Image Corneal ProcessedData Sequence
SourceImageSequence	getSourceImageSequence() Retrieves a sequence which provides references to Source Image Sequence
float	getSurfaceAsymmetryIndex() Retrieves Surface Asymmetry Index
float	getSurfaceRegularityIndex() Retrieves Surface Regularity Index
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
java.lang.String[]	getVerticesOfTheOutlineOfPupil() Retrieves Vertices of the Outline of Pupil
void	setAnalyzedArea(float fAnalyzedArea) Sets Analyzed Area
void	setAverageCornealPower(float fAverageCornealPower) Sets area-corrected average of the corneal power ahead of the entrance pupil, measured in diopters.
void	setCornealEccentricityIndex(float fCornealEccentricityIndex) Sets Corneal Eccentricity Index
void	setCornealISValue(float fCornealISValue) Sets Corneal I-S Value
void	setCornealTopographyMapQualityEvaluation(EnumCornealTopographyMapQualityEvaluation enumCornealTopographyMapQualityEvaluation) Sets the the quality of the topography examination.
void	setCornealTopographySurface(EnumCornealTopographySurface enumCornealTopographySurface) Sets Corneal Topography Surface
void	setCornealVertexLocation(float[] arrFCornealVertexLocation) Sets Corneal Vertex Location
void	setDecimalPotentialVisualAcuity(float fDecimalPotentialVisualAcuity) Sets the range of best spectacle-corrected distance that might be expected from a functionally normal eye with the topographical characteristics of theanalyzed cornea, measured in decimal.
void	setEquivalentPupilRadius(float fEquivalentPupilRadius) Sets Equivalent Pupil Radius
void	setKeratoconusPredictionIndex(float fKeratoconusPredictionIndex) Sets Keratoconus Prediction Index
void	setOphthalmicMappingDeviceType(EnumOphthalmicMappingDeviceType enumOphthalmicMappingDeviceType) Sets OphthalmicMappingDeviceType
void	setPupilCentroidXCoordinate(float fPupilCentroidXCoordinate) Sets Pupil CentroidX-Coordinate
void	setPupilCentroidYCoordinate(float fPupilCentroidYCoordinate) Sets Pupil Centroid Y-Coordinate
void	setSurfaceAsymmetryIndex(float fSurfaceAsymmetryIndex) Sets Surface Asymmetry Index
void	setSurfaceRegularityIndex(float fSurfaceRegularityIndex) Sets Surface Regularity Index
void	setVerticesOfTheOutlineOfPupil(java.lang.String strVerticesOfTheOutlineOfPupilString)
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

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

CornealTopographyMapAnalysisModule

public CornealTopographyMapAnalysisModule(IDataSet objIDataSet)

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

Throws:

InvalidModuleException

setOphthalmicMappingDeviceType

public void setOphthalmicMappingDeviceType(EnumOphthalmicMappingDeviceType enumOphthalmicMappingDeviceType)

Sets OphthalmicMappingDeviceType

Parameters:

enumOphthalmicMappingDeviceType - Enum value ofOphthalmicMappingDeviceType

getOphthalmicMappingDeviceType

public java.lang.String getOphthalmicMappingDeviceType()

Retrieves OphthalmicMappingDeviceType

Returns:

String - String value of OphthalmicMappingDeviceType

setCornealTopographySurface

public void setCornealTopographySurface(EnumCornealTopographySurface enumCornealTopographySurface)

Sets Corneal Topography Surface

Parameters:

enumCornealTopographySurface - Enum value of Corneal Topography Surface

getCornealTopographySurface

public java.lang.String getCornealTopographySurface()

Retrieves Corneal Topography Surface

Returns:

String - String value of Corneal Topography Surface

setCornealVertexLocation

public void setCornealVertexLocation(float[] arrFCornealVertexLocation)

Sets Corneal Vertex Location

Parameters:

arrFCornealVertexLocation - pair of Corneal Vertex Location

getCornealVertexLocation

public float[] getCornealVertexLocation()

Retrieves Corneal Vertex Location

Returns:

float[] - Float array of Corneal Vertex Location

setPupilCentroidXCoordinate

public void setPupilCentroidXCoordinate(float fPupilCentroidXCoordinate)

Sets Pupil CentroidX-Coordinate

Parameters:

fPupilCentroidXCoordinate - value of Pupil CentroidX-Coordinate

getPupilCentroidXCoordinate

public float getPupilCentroidXCoordinate()

Retrieves Pupil CentroidX-Coordinate

Returns:

float - Float value of Pupil CentroidX-Coordinate

setPupilCentroidYCoordinate

public void setPupilCentroidYCoordinate(float fPupilCentroidYCoordinate)

Sets Pupil Centroid Y-Coordinate

Parameters:

fPupilCentroidYCoordinate - value of Pupil Centroid Y-Coordinate

getPupilCentroidYCoordinate

public float getPupilCentroidYCoordinate()

Retrieves Pupil Centroid Y-Coordinate

Returns:

float - Float value of Pupil Centroid Y-Coordinate

setEquivalentPupilRadius

public void setEquivalentPupilRadius(float fEquivalentPupilRadius)

Sets Equivalent Pupil Radius

Parameters:

fEquivalentPupilRadius - value of Equivalent Pupil Radius

getEquivalentPupilRadius

public float getEquivalentPupilRadius()

Retrieves Equivalent Pupil Radius

Returns:

float - Float value of Equivalent Pupil Radius

setVerticesOfTheOutlineOfPupil

public void setVerticesOfTheOutlineOfPupil(java.lang.String strVerticesOfTheOutlineOfPupilString)

getVerticesOfTheOutlineOfPupil

public java.lang.String[] getVerticesOfTheOutlineOfPupil()

Retrieves Vertices of the Outline of Pupil

Returns:

String Array - Value component of Vertices of the Outline of Pupil

getKeratometricMeasurementsMacro

public KeratometricMeasurementsMacro getKeratometricMeasurementsMacro()

Get the Instance of Keratometric MeasurementsMacro related to Content Identification will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Keratometric MeasurementsMacro which the user programmer can populate

getMinimumKeratometricSequence

public MinimumKeratometricSequence getMinimumKeratometricSequence()

Retrieves a sequence which provides references to Minimum Keratometric Sequence

Returns:

- instance of Keratometric Sequence

getSimulatedKeratometricCylinderSequence

public SimulatedKeratometricCylinderSequence getSimulatedKeratometricCylinderSequence()

Retrieves a sequence which provides references to Simulated Keratometric CylinderSequence

Returns:

- instance of

setAverageCornealPower

public void setAverageCornealPower(float fAverageCornealPower)

Sets area-corrected average of the corneal power ahead of the entrance pupil, measured in diopters.

Parameters:

fAverageCornealPower - value of the Average Corneal Power

getAverageCornealPower

public float getAverageCornealPower()

Retrieves area-corrected average of the corneal power ahead of the entrancepupil, measured in diopters.

Returns:

float - Float value of Average Corneal Power

setCornealISValue

public void setCornealISValue(float fCornealISValue)

Sets Corneal I-S Value

Parameters:

fCornealISValue - value of the Corneal I-S Value

getCornealISValue

public float getCornealISValue()

Retrieves Corneal I-S Value

Returns:

float - Float value of Corneal I-S Value

setAnalyzedArea

public void setAnalyzedArea(float fAnalyzedArea)

Sets Analyzed Area

Parameters:

fAnalyzedArea - Float value of the Analyzed Area

getAnalyzedArea

public float getAnalyzedArea()

Retrieves Analyzed Area

Returns:

float - Float value of Analyzed Area

getMaximumCornealCurvatureSequence

public MaximumCornealCurvatureSequence getMaximumCornealCurvatureSequence()

Retrieves a sequence which provides references to Maximum Corneal CurvatureSequence

Returns:

- instance of Corneal CurvatureSequence

setSurfaceRegularityIndex

public void setSurfaceRegularityIndex(float fSurfaceRegularityIndex)

Sets Surface Regularity Index

Parameters:

fSurfaceRegularityIndex - Float value of the Surface Regularity Index

getSurfaceRegularityIndex

public float getSurfaceRegularityIndex()

Retrieves Surface Regularity Index

Returns:

float - Float value of Surface Regularity Index

setSurfaceAsymmetryIndex

public void setSurfaceAsymmetryIndex(float fSurfaceAsymmetryIndex)

Sets Surface Asymmetry Index

Parameters:

fSurfaceAsymmetryIndex - Float value of the Surface Asymmetry Index

getSurfaceAsymmetryIndex

public float getSurfaceAsymmetryIndex()

Retrieves Surface Asymmetry Index

Returns:

float - Float value of Surface Asymmetry Index

setCornealEccentricityIndex

public void setCornealEccentricityIndex(float fCornealEccentricityIndex)

Sets Corneal Eccentricity Index

Parameters:

fCornealEccentricityIndex - Float value of the Corneal Eccentricity Index

getCornealEccentricityIndex

public float getCornealEccentricityIndex()

Retrieves Corneal Eccentricity Index

Returns:

float - Float value of Corneal Eccentricity Index

setKeratoconusPredictionIndex

public void setKeratoconusPredictionIndex(float fKeratoconusPredictionIndex)

Sets Keratoconus Prediction Index

Parameters:

fKeratoconusPredictionIndex - Float value of the Keratoconus Prediction Index

getKeratoconusPredictionIndex

public float getKeratoconusPredictionIndex()

Retrieves Keratoconus Prediction Index

Returns:

float - Float value of the Keratoconus Prediction Index

setDecimalPotentialVisualAcuity

public void setDecimalPotentialVisualAcuity(float fDecimalPotentialVisualAcuity)

Sets the range of best spectacle-corrected distance that might be expected from a functionally normal eye with the topographical characteristics of theanalyzed cornea, measured in decimal.

Parameters:

fDecimalPotentialVisualAcuity - Float value of the DecimalPotentialVisualAcuity

getDecimalPotentialVisualAcuity

public float getDecimalPotentialVisualAcuity()

Retrieves the range of best spectacle-corrected distance that might be expected from a functionally normal eye with the topographical characteristics of theanalyzed cornea, measured in decimal.

Returns:

float - Float value of the DecimalPotentialVisualAcuity

setCornealTopographyMapQualityEvaluation

public void setCornealTopographyMapQualityEvaluation(EnumCornealTopographyMapQualityEvaluation enumCornealTopographyMapQualityEvaluation)

Sets the the quality of the topography examination.

Parameters:

enumCornealTopographyMapQualityEvaluation - Enum value of Corneal Topography MapQuality Evaluation

getCornealTopographyMapQualityEvaluation

public java.lang.String getCornealTopographyMapQualityEvaluation()

Retrieves the quality of the topography examination.

Returns:

String - String value of Corneal Topography MapQuality Evaluation

getCornealTopographyMapTypeCodeSequence

public CornealTopographyMapTypeCodeSequence getCornealTopographyMapTypeCodeSequence()

Retrieves a sequence which provides references to Corneal Topography Map TypeCode Sequence

Returns:

- instance of CornealTopographyMapTypeCodeSequence

getCornealTopographyMappingNormalsSequence

public CornealTopographyMappingNormalsSequence getCornealTopographyMappingNormalsSequence()

Retrieves a sequence which provides references to Corneal Topography MappingNormals Sequence

Returns:

- instance of Topography MappingNormals Sequence

getSourceImageSequence

public SourceImageSequence getSourceImageSequence()

Retrieves a sequence which provides references to Source Image Sequence

Returns:

- instance of Image Sequence

getSourceImageCornealProcessedDataSequence

public SourceImageCornealProcessedDataSequence getSourceImageCornealProcessedDataSequence()

Retrieves a sequence which provides references to Source Image Corneal ProcessedData Sequence

Returns:

- instance of Image Corneal ProcessedData Sequence

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