pyrot.eye_modelling.datamodels.models ===================================== .. py:module:: pyrot.eye_modelling.datamodels.models Attributes ---------- .. autoapisummary:: pyrot.eye_modelling.datamodels.models.logger pyrot.eye_modelling.datamodels.models._Self Classes ------- .. autoapisummary:: pyrot.eye_modelling.datamodels.models.BaseModel pyrot.eye_modelling.datamodels.models.EyeModelMeasurements pyrot.eye_modelling.datamodels.models.AnteriorChamber pyrot.eye_modelling.datamodels.models.CiliaryBody pyrot.eye_modelling.datamodels.models.Cornea pyrot.eye_modelling.datamodels.models.Eye pyrot.eye_modelling.datamodels.models.Iris pyrot.eye_modelling.datamodels.models.Lens pyrot.eye_modelling.datamodels.models.Macula pyrot.eye_modelling.datamodels.models.OpticalDisc pyrot.eye_modelling.datamodels.models.OpticalNerve pyrot.eye_modelling.datamodels.models.Retina pyrot.eye_modelling.datamodels.models.Sclera pyrot.eye_modelling.datamodels.models.VitreousBody pyrot.eye_modelling.datamodels.models.EyeModelParameters pyrot.eye_modelling.datamodels.models.EyeModel Module Contents --------------- .. py:data:: logger .. py:data:: _Self .. py:class:: 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. .. py:method:: _get_rayocular_fields() -> dict[str, pyrot.eye_modelling.datamodels.validators.RayOcularField] :classmethod: .. py:method:: from_rayocular(rayocular_object) -> _Self :classmethod: Converts a RayOcular object to an instance of the data model. Parameters ---------- rayocular_object : Any The RayOcular object to convert. Returns ------- BaseModel An instance of the data model. .. py:method:: 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. .. py:class:: EyeModelMeasurements Bases: :py:obj:`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. .. py:attribute:: cornea_lens_distance :type: float .. py:attribute:: eye_length :type: float .. py:attribute:: eye_width :type: float .. py:attribute:: lens_thickness :type: float .. py:attribute:: limbus_diameter :type: float .. py:class:: AnteriorChamber Bases: :py:obj:`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. .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: CiliaryBody Bases: :py:obj:`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. .. py:attribute:: base_curvature :type: float .. py:attribute:: height :type: float .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: Cornea Bases: :py:obj:`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. .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: thickness :type: float .. py:class:: Eye Bases: :py:obj:`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. .. py:attribute:: pivot :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: Iris Bases: :py:obj:`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. .. py:attribute:: inner_semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: outer_semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: thickness :type: float .. py:class:: Lens Bases: :py:obj:`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. .. py:attribute:: curvature :type: float .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: Macula Bases: :py:obj:`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. .. py:attribute:: height :type: float .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: OpticalDisc Bases: :py:obj:`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. .. py:attribute:: height :type: float .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: OpticalNerve Bases: :py:obj:`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. .. py:attribute:: height :type: float .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: Retina Bases: :py:obj:`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. .. py:attribute:: thickness :type: float .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: Sclera Bases: :py:obj:`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. .. py:attribute:: thickness :type: float .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: semi_axis :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: VitreousBody Bases: :py:obj:`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. .. py:attribute:: local_rotation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_scale :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:attribute:: local_translation :type: pyrot.eye_modelling.datamodels.validators.Vector3[float] .. py:class:: EyeModelParameters .. py:attribute:: eye :type: Eye .. py:attribute:: anterior_chamber :type: AnteriorChamber .. py:attribute:: ciliary_body :type: CiliaryBody .. py:attribute:: cornea :type: Cornea .. py:attribute:: iris :type: Iris .. py:attribute:: lens :type: Lens .. py:attribute:: macula :type: Macula .. py:attribute:: optical_disc :type: OpticalDisc .. py:attribute:: optical_nerve :type: OpticalNerve .. py:attribute:: retina :type: Retina .. py:attribute:: sclera :type: Sclera .. py:attribute:: vitreous_body :type: VitreousBody .. py:attribute:: lens_cornea_distance :type: float .. py:attribute:: level_of_detail :type: int .. py:method:: from_rayocular(parameters) -> EyeModelParameters :classmethod: .. py:method:: to_rayocular() -> dict[str, Any] .. py:class:: EyeModel .. py:attribute:: measurements :type: EyeModelMeasurements .. py:attribute:: parameters :type: EyeModelParameters .. py:method:: from_rayocular(geometry_generator) -> EyeModel :classmethod: