navis.transforms.mirror¶
- navis.transforms.mirror(points, mirror_axis_size, mirror_axis='x', warp=None)[source]¶
Mirror 3D coordinates about given axis.
- This is a lower level version of navis.mirror_brain that:
Flips object along midpoint of axis using a affine transformation.
(Optional) Applies a warp transform that corrects asymmetries.
- Parameters:
points ((N, 3) numpy array) – 3D coordinates to mirror.
mirror_axis_size (int | float) – A single number specifying the size of the mirror axis. This is used to find the midpoint to mirror about.
mirror_axis ('x' | 'y' | 'z', optional) – Axis to mirror. Defaults to x.
warp (Transform, optional) – If provided, will apply this warp transform after the affine flipping. Typically this will be a mirror registration to compensate for left/right asymmetries.
- Returns:
Mirrored coordinates.
- Return type:
points_mirrored
See also
navis.mirror_brain()
Higher level function that uses meta data from registered template brains to transform data for you.