pyvista_cad.CadDataSetAccessor.set_units

CadDataSetAccessor.set_units(target, *, convert=False)

Update cad.units, optionally rescaling point coordinates.

Parameters:

targetstr

Target unit string.

convertbool, default: False

When True, rescale point coordinates by the unit ratio.

Parameters:

• target (str)

• convert (bool)

Return type:

None

Examples

>>> import pyvista as pv
>>> import pyvista_cad
>>> mesh = pv.Sphere()
>>> mesh.cad.set_units('mm')
>>> mesh.cad.units
'mm'