pyrot.ro_interface
==================

.. py:module:: pyrot.ro_interface


Attributes
----------

.. autoapisummary::

   pyrot.ro_interface.logger


Functions
---------

.. autoapisummary::

   pyrot.ro_interface.load_current_patient
   pyrot.ro_interface.load_current_structureset
   pyrot.ro_interface.load_eyemodel
   pyrot.ro_interface.load_pois
   pyrot.ro_interface.load_rois
   pyrot.ro_interface.update_eye_model


Module Contents
---------------

.. py:data:: logger

.. py:function:: load_current_patient()

   Loads and returns the current patient associated with the active examination.

   Returns
   -------
   Patient
       The patient object corresponding to the current case


.. py:function:: load_current_structureset()

   Loads and returns the current StructureSet associated with the active examination.

   Returns
   -------
   StructureSet
       The StructureSet object corresponding to the current examination.


.. py:function:: load_eyemodel(structure_set, eyemodelnr)

   Load geometry generators and eye model parameters from a structure set.

   Parameters
   ----------
   structure_set : object
       The structure set containing geometry generators and eye model parameters.
   eyemodelnr : int
       The index of the eye model to load from the structure set.

   Returns
   -------
   geometry_generators : object
       The geometry generators for the specified eye model.
   eye_model_parameters : object
       The eye model parameters for the specified eye model.


.. py:function:: load_pois(structure_set, poi_type: Optional[str] = None, poi_name_contains: Optional[str] = None)

   Load POIs (Points of Interest) from a structure set, optionally filtering by type or name substring.

   Parameters
   ----------
   structure_set : object
       The structure set containing POI geometries.
   poi_type : str, optional
       The type of POI to filter by. If provided, only POIs of this type are returned.
   poi_name_contains : str, optional
       A substring to search for in POI names. If provided, only POIs whose names contain this substring are returned.

   Returns
   -------
   list
       A list of POI geometries matching the specified criteria.


.. py:function:: load_rois(structure_set, roi_type: Optional[str] = None, roi_name_contains: Optional[str] = None)

   Load ROIs (Regions of Interest) from a structure set, optionally filtering by type or name substring.

   Parameters
   ----------
   structure_set : object
       The structure set containing ROI geometries. Must have a `RoiGeometries` attribute.
   roi_type : str, optional
       The type of ROI to filter by. If provided, only ROIs of this type are returned.
   roi_name_contains : str, optional
       A substring to filter ROI names. If provided, only ROIs whose names contain this substring are returned.

   Returns
   -------
   list
       A list of ROI geometries matching the specified filters.


.. py:function:: update_eye_model(eye_model_generators, new_values)

   Update the eye model parameters with new values.

   Parameters
   ----------
   eye_model_generators : object
       Object providing access to eye model parameter editing functionality.
   new_values : dict
       Dictionary containing the new parameter values to update the eye model with.