rs3.properties.GeneralizedAnisotropicFunction module

class rs3.properties.GeneralizedAnisotropicFunction.GeneralizedAnisotropicFunction(client: Client, generalizedAnisotropicFunctionID: str, projectID: str)

Bases: _ProxyObject

Examples

See 2.3 Generalized Anisotropic.

getName() → str

setName(name)

getDipDipDirectionFunctionPoints() → list[tuple[float, float, float, float, str]]

Get a list of dip-dip direction function points.

Returns:

A list of (dip, dip_direction, A, B, material_name) data points.

Return type:

list[tuple[float, float, float, float, str]]

setDipDipDirectionFunctionPoints(value: list[tuple[float, float, float, float, str]])

Set a list of dip-dip direction function points.

Parameters:

value – list[tuple[float, float, float, float, str]]: A list of (dip, dip_direction, A, B, material_name) data points.

Example

>>> generalizedAnisotropicFunction = self.model.getGeneralizedAnisotropicFunctions()[0]
>>> dipDipDirectionPoints = [(15.5, 2.1, 0.4, 0.5, "Material 3"), (13.2, 24.1, 1.4, 1.5, "Material 5")]
>>> generalizedAnisotropicFunction.setDipDipDirectionFunctionPoints(dipDipDirectionPoints)

getSurfaceFunctionPoints() → list[tuple[str, float, float, str]]

Get a list of surface function points.

Returns:

A list of (surface_name, A, B, material_name) data points.

Return type:

list[tuple[str, float, float, str]]

setSurfaceFunctionPoints(value: list[tuple[str, float, float, str]])

Set a list of surface function points.

Parameters:

value – list[tuple[str, float, float, str]]: A list of (surface_name, A, B, material_name) data points.

Example

>>> generalizedAnisotropicFunction = self.model.getGeneralizedAnisotropicFunctions()[0]
>>> surfacePoints = [("Anisotropic Surface 2", 0.4, 0.5, "Material 4"), ("Anisotropic Surface 1", 1.4, 1.5, "Material 2")]
>>> generalizedAnisotropicFunction.setSurfaceFunctionPoints(surfacePoints)

getBaseMaterial() → str

setBaseMaterial(value: str)

getAnisotropyDefinition() → GeneralizedAnisotropyDefinitionType

setAnisotropyDefinition(anisotropyDefinition: GeneralizedAnisotropyDefinitionType)