pyrot.eye_modelling.datamodels.models

Attributes

logger
_Self

Classes

BaseModel	Abstract base class for RayOcular data models.
EyeModelMeasurements	Abstract base class for RayOcular data models.
AnteriorChamber	Abstract base class for RayOcular data models.
CiliaryBody	Abstract base class for RayOcular data models.
Cornea	Abstract base class for RayOcular data models.
Eye	Abstract base class for RayOcular data models.
Iris	Abstract base class for RayOcular data models.
Lens	Abstract base class for RayOcular data models.
Macula	Abstract base class for RayOcular data models.
OpticalDisc	Abstract base class for RayOcular data models.
OpticalNerve	Abstract base class for RayOcular data models.
Retina	Abstract base class for RayOcular data models.
Sclera	Abstract base class for RayOcular data models.
VitreousBody	Abstract base class for RayOcular data models.
EyeModelParameters
EyeModel

Module Contents

pyrot.eye_modelling.datamodels.models.logger

pyrot.eye_modelling.datamodels.models._Self

class pyrot.eye_modelling.datamodels.models.BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

classmethod _get_rayocular_fields() → dict[str, pyrot.eye_modelling.datamodels.validators.RayOcularField]

classmethod from_rayocular(rayocular_object) → _Self

Converts a RayOcular object to an instance of the data model.

Parameters

rayocular_objectAny

The RayOcular object to convert.

Returns

BaseModel

An instance of the data model.

to_rayocular() → dict[str, Any]

Converts the data model instance to a RayOcular dictionary.

Returns

dict[str, Any]

A dictionary that can be used to update the model in RayOcular.

class pyrot.eye_modelling.datamodels.models.EyeModelMeasurements

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

cornea_lens_distance: float

eye_length: float

eye_width: float

lens_thickness: float

limbus_diameter: float

class pyrot.eye_modelling.datamodels.models.AnteriorChamber

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.CiliaryBody

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

base_curvature: float

height: float

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.Cornea

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

thickness: float

class pyrot.eye_modelling.datamodels.models.Eye

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

pivot: pyrot.eye_modelling.datamodels.validators.Vector3[float]

rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.Iris

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

inner_semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

outer_semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

thickness: float

class pyrot.eye_modelling.datamodels.models.Lens

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

curvature: float

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.Macula

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

height: float

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.OpticalDisc

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

height: float

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.OpticalNerve

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

height: float

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.Retina

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

thickness: float

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.Sclera

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

thickness: float

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

semi_axis: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.VitreousBody

Bases: BaseModel

Abstract base class for RayOcular data models.

Methods

from_rayocular(cls, rayocular_object)

Converts a RayOcular object to an instance of the data model.

to_rayocular(self)

Converts the data model instance to a RayOcular object.

local_rotation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_scale: pyrot.eye_modelling.datamodels.validators.Vector3[float]

local_translation: pyrot.eye_modelling.datamodels.validators.Vector3[float]

class pyrot.eye_modelling.datamodels.models.EyeModelParameters

eye: Eye

anterior_chamber: AnteriorChamber

ciliary_body: CiliaryBody

cornea: Cornea

iris: Iris

lens: Lens

macula: Macula

optical_disc: OpticalDisc

optical_nerve: OpticalNerve

retina: Retina

sclera: Sclera

vitreous_body: VitreousBody

lens_cornea_distance: float

level_of_detail: int

classmethod from_rayocular(parameters) → EyeModelParameters

to_rayocular() → dict[str, Any]

class pyrot.eye_modelling.datamodels.models.EyeModel

measurements: EyeModelMeasurements

parameters: EyeModelParameters

classmethod from_rayocular(geometry_generator) → EyeModel