RegularSurface

class rips.RegularSurface(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: SurfaceInterface

depth

Depth

Type:

float

depth_property

Depth Property

Type:

str

increment_x

Increment X

Type:

float

increment_y

Increment Y

Type:

float

nx

Nx

Type:

int

ny

Ny

Type:

int

origin_x

Origin X

Type:

float

origin_y

Origin Y

Type:

float

rotation

Rotation

Type:

float

Methods Summary

available_properties()	Gets the list of available property names on a regular surface.
get_property(name)	Gets a property from a regular surface.
get_property_to_key([name, value_key])	Get property to key.
property_names()	Property Names.
set_property(name, values)	Sets a property on a regular surface.
set_property_as_depth([name])	Set property as depth.
set_property_from_key([name, value_key])	Set property from key.

Methods Documentation

available_properties() → List[str]

Gets the list of available property names on a regular surface.

Returns:

Names of all properties set on this surface.

Return type:

List[str]

get_property(name: str) → List[float]

Gets a property from a regular surface.

Parameters:

name (str) -- Name of the property.

Returns:

Values of the property (float32).

Size is nx*ny (see RegularSurface).

Return type:

List[float]

get_property_to_key(name: str = '', value_key: str = '') → None

Get property to key.

Parameters:

• name (str) -- Name

• value_key (str) -- Key Value

Returns:

property_names() → DataContainerString

Property Names.

Arguments:

Returns:

DataContainerString

set_property(name: str, values: List[float]) → None

Sets a property on a regular surface.

Parameters:

• name (str) -- Name of the property.

• values (List[float]) -- Values to set (float32). Should be of nx*ny size (see RegularSurface).

set_property_as_depth(name: str = '') → None

Set property as depth.

Parameters:

name (str) -- Name

Returns:

set_property_from_key(name: str = '', value_key: str = '') → None

Set property from key.

Parameters:

• name (str) -- Name

• value_key (str) -- Key Value

Returns: