paralleldomain.model.annotation.point_cache

class PointCache(instance_id, components)

A collection of PointCacheComponents which make up the total point cache of a particular object

Parameters:

• instance_id (int) – PointCache.instance_id

• components (List[PointCacheComponent]) – PointCache.components

instance_id

Instance ID of annotated object. Can be used to cross-reference with other instance annotation type

components

List of point cache components which make up a collection of points which is the total point cache of an object

class PointCacheComponent(component_name, points_decoder)

A component of a point cache, which contains a subset of points with associated xyz positions and surface normals

Parameters:

• component_name (str) – PointCacheComponent.component_name

• points_decoder (PointCachePointsDecoderProtocol) – An implementation of PointCachePointsDecoderProtocol which defines how the xyz positions and surface normals of the points are extracted

component_name

The name of the component

property normals: ndarray | None

Returns the surface normals of the points within the PointCacheComponent

property points: ndarray | None

Returns the xyz positions of the points within the PointCacheComponent

class PointCachePointsDecoderProtocol(*args, **kwargs)

Base class for decoding Point Cache Points

get_points_normals()

Base implementation of method that extracts surface normals of points within the point cache

Return type:

Optional[ndarray]

Returns:

Array of vector components of the surface normals of each point within the point cache

get_points_xyz()

Base implementation of method that extracts xyz positions of points within the point cache

Return type:

Optional[ndarray]

Returns:

Array of xyz positions of each point within the point cache

class PointCaches(caches)

A list of PointCache objects for various objects

Parameters:

caches (List[PointCache]) – PointCaches.caches

caches

A list of PointCache objects which are each the point cache of a distinct objects