RARegionsOfInterestCollection#

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

Bases: 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 RARegionsOfInterestCollection from a RAStudy, use:

roi_collection = study.GetRegionsOfInterestCollection()

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

Overview#

GetWrappedClass

GetClassName

AddCube

Add a new Cube. Returns the newly created item.

AddCylinder

Add a new Cylinder. Returns the newly created item.

Import detail#

from ansys.rocky.app.ra_regions_of_interest_collection import RARegionsOfInterestCollection

Method detail#

classmethod RARegionsOfInterestCollection.GetWrappedClass() → type[rocky30.models.regions_of_interest.roi_collection.RoiCollection]#
classmethod RARegionsOfInterestCollection.GetClassName() → str#
RARegionsOfInterestCollection.AddCube(name: str | None = None) → ansys.rocky.app.ra_region_of_interest_cube.RARegionOfInterestCube#

Add a new Cube. Returns the newly created item.

RARegionsOfInterestCollection.AddCylinder(name: str | None = None) → ansys.rocky.app.ra_region_of_interest_cylinder.RARegionOfInterestCylinder#

Add a new Cylinder. Returns the newly created item.