:class:`RARegionsOfInterestCollection`
======================================


.. py:class:: ansys.rocky.app.ra_regions_of_interest_collection.RARegionsOfInterestCollection(id: str, model_id: str | None = None)

   Bases: :py:obj:`ansys.rocky.app.ra_list.RAList`


   
   Rocky PrePost Scripting wrapper for the collection of Regions of Interest in a project.

   This wrapper corresponds to the "Regions Of Interest" item in the project's data tree. To
   retrieve the :class:`RARegionsOfInterestCollection` from a :class:`RAStudy`, use:

       roi_collection = study.GetRegionsOfInterestCollection()

   Instances of the :class:`RARegionsOfInterestCollection` class act as regular Python lists, and
   can be iterated on, accessed via index, etc:















   ..
       !! processed by numpydoc !!




.. py:currentmodule:: RARegionsOfInterestCollection

Overview
--------

.. tab-set::


   .. tab-item:: Constructors

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~GetWrappedClass`
            - 
          * - :py:attr:`~GetClassName`
            - 


   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~AddCube`
            - Add a new Cube. Returns the newly created item.
          * - :py:attr:`~AddCylinder`
            - Add a new Cylinder. Returns the newly created item.








Import detail
-------------

.. code-block:: python

    from ansys.rocky.app.ra_regions_of_interest_collection import RARegionsOfInterestCollection



Method detail
-------------

.. py:method:: GetWrappedClass() -> type[rocky30.models.regions_of_interest.roi_collection.RoiCollection]
   :classmethod:


.. py:method:: GetClassName() -> str
   :classmethod:


.. py:method:: AddCube(name: str | None = None) -> ansys.rocky.app.ra_region_of_interest_cube.RARegionOfInterestCube

   
   Add a new Cube. Returns the newly created item.
















   ..
       !! processed by numpydoc !!

.. py:method:: AddCylinder(name: str | None = None) -> ansys.rocky.app.ra_region_of_interest_cylinder.RARegionOfInterestCylinder

   
   Add a new Cylinder. Returns the newly created item.
















   ..
       !! processed by numpydoc !!