bapsf_motion.transform

Module containing all functionality for converting probe drive coordinates to motion space coordinates, and vice versa.

Sub-Packages & Modules

base

Module that defines the BaseTransform abstract class.

helpers

Module for helper functions associated with coordinate transform functionality between the probe motion space and the probe drive coordinate system.

identity

Module that defines the IdentityTransform abstract class.

lapd

Module that defines the LaPD related transform classes.

lapd_droop

Module that defines the LaPD related probe droop correction classes.

Classes

BaseTransform(drive, **kwargs)

Abstract base class for coordinate transform classes.

DroopCorrectABC(drive, **kwargs)

Abstract base class for probe droop correction classes.

LaPDXYDroopCorrect(drive, *, pivot_to_feedthru)

Class that defines functionality for droop / non-droop correction in the LaPD XY plane of a stainless steel 304 probe shaft of 0.375" OD x 0.035" wall.

Inheritance diagram of bapsf_motion.transform.base.BaseTransform, bapsf_motion.transform.lapd_droop.DroopCorrectABC, bapsf_motion.transform.lapd_droop.LaPDXYDroopCorrect

Transformers

Classes that define functionality for performing coordinate transformations between motion space coordinate and probe drive coordinate, and vice versa.

IdentityTransform(drive, **kwargs)

Class that defines an Identity coordinate transform, i.e. the motion space and probe drive coordinates are the same.

LaPD6KTransform(drive, *[, pivot_to_center, ...])

Class that defines a coordinate transform for a LaPD "6K Compumotor" probe drive.

LaPDXYTransform(drive, *, pivot_to_center, ...)

Class that defines a coordinate transform for a LaPD XY probe drive.

Functions

register_transform(transform_cls)

A decorator for registering a coordinate transform classes into the associated registry.

transform_factory(drive, *, tr_type, **settings)

Factory function for calling and instantiating motion exclusion classes from the registry.