RARegionOfInterestCube

class ansys.rocky.app.ra_region_of_interest_cube.RARegionOfInterestCube

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem, ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin, ansys.rocky.app._ra_orientation_mixin._RAOrientationMixin

Rocky PrePost Scripting wrapper for a single Cube geometry.

This wrapper class corresponds to an individual entry under the “Regions Of Interest” item on the project’s data tree. Regions Of Interest can be retrieved from the RAStudy or the RARegionsOfInterestCollection via:

roi_cube_1 = study.GetElement('Cube <1>')

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetCenterAfterMovement	Get the Region of Interest center taking motion in account.
GetCenter	Get the value of “Center”.
SetCenter	Set the values of “Center”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetSize	Get the value of “Size”.
SetSize	Set the values of “Size”.

Import detail

from ansys.rocky.app.ra_region_of_interest_cube import RARegionOfInterestCube

Method detail

classmethod RARegionOfInterestCube.GetWrappedClass() → type

classmethod RARegionOfInterestCube.GetClassName() → str

RARegionOfInterestCube.GetCenterAfterMovement(timestep: int) → rocky30.base_types.Tuple3F

Get the Region of Interest center taking motion in account.

RARegionOfInterestCube.GetCenter(unit: str | None = None) → list[float]

Get the value of “Center”.

Parameters:

unit – The unit for the returned values. If no unit is provided, the returned values will be in “m”.

RARegionOfInterestCube.SetCenter(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Center”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

• unit – The unit for values. If no unit is provided, values is assumed to be in “m”.

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.

RARegionOfInterestCube.GetName() → str

Get the value of “Name”.

RARegionOfInterestCube.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RARegionOfInterestCube.GetSize(unit: str | None = None) → list[float]

Get the value of “Size”.

Parameters:

unit – The unit for the returned values. If no unit is provided, the returned values will be in “m”.

RARegionOfInterestCube.SetSize(values: collections.abc.Sequence[str | float], unit: str | None = None) → None

Set the values of “Size”.

Parameters:

• values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.

• unit – The unit for values. If no unit is provided, values is assumed to be in “m”.

Raises:

RockyApiError – If values doesn’t have exactly 3 elements.