RARegionOfInterestCylinder

class ansys.rocky.app.ra_region_of_interest_cylinder.RARegionOfInterestCylinder

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 Cylinder 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_cylinder = study.GetElement('Cylinder <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”.
GetFinalAngle	Get the value of “Final Angle”.
SetFinalAngle	Set the value of “Final Angle”.
GetHeight	Get the value of “Height”.
SetHeight	Set the value of “Height”.
GetInitialAngle	Get the value of “Initial Angle”.
SetInitialAngle	Set the value of “Initial Angle”.
GetInternalFactor	Get the value of “Internal Factor”.
SetInternalFactor	Set the value of “Internal Factor”.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetRadius	Get the value of “Radius”.
SetRadius	Set the value of “Radius”.

Import detail

from ansys.rocky.app.ra_region_of_interest_cylinder import RARegionOfInterestCylinder

Method detail

classmethod RARegionOfInterestCylinder.GetWrappedClass() → type

classmethod RARegionOfInterestCylinder.GetClassName() → str

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

Get the Region of Interest center taking motion in account.

RARegionOfInterestCylinder.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”.

RARegionOfInterestCylinder.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.

RARegionOfInterestCylinder.GetFinalAngle(unit: str | None = None) → float

Get the value of “Final Angle”.

Parameters:

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

RARegionOfInterestCylinder.SetFinalAngle(value: str | float, unit: str | None = None) → None

Set the value of “Final Angle”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

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

RARegionOfInterestCylinder.GetHeight(unit: str | None = None) → float

Get the value of “Height”.

Parameters:

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

RARegionOfInterestCylinder.SetHeight(value: str | float, unit: str | None = None) → None

Set the value of “Height”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

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

RARegionOfInterestCylinder.GetInitialAngle(unit: str | None = None) → float

Get the value of “Initial Angle”.

Parameters:

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

RARegionOfInterestCylinder.SetInitialAngle(value: str | float, unit: str | None = None) → None

Set the value of “Initial Angle”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

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

RARegionOfInterestCylinder.GetInternalFactor(unit: str | None = None) → float

Get the value of “Internal Factor”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

RARegionOfInterestCylinder.SetInternalFactor(value: str | float, unit: str | None = None) → None

Set the value of “Internal Factor”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “-“.

RARegionOfInterestCylinder.GetName() → str

Get the value of “Name”.

RARegionOfInterestCylinder.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RARegionOfInterestCylinder.GetRadius(unit: str | None = None) → float

Get the value of “Radius”.

Parameters:

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

RARegionOfInterestCylinder.SetRadius(value: str | float, unit: str | None = None) → None

Set the value of “Radius”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

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