desc.coils.MixedCoilSet.to_SplineXYZ

MixedCoilSet.to_SplineXYZ(knots=None, grid=None, method='cubic', name='', check_intersection=True)Source

Convert all coils to SplineXYZCoil representation.

Parameters:
  • knots (ndarray) – Arbitrary curve parameter values to use for spline knots, should be an 1D ndarray of same length as the input. (Input length in this case is determined by grid argument, since the input coordinates come from Coil.compute(“x”,grid=grid)) If None, defaults to using an equal-arclength angle as the knots. If supplied, will be rescaled to the range [0,2pi].

  • grid (Grid, int or None) – Grid used to evaluate curve coordinates on to fit with SplineXYZCoil. If an integer, uses that many equally spaced points.

  • method (str) – method of interpolation - ‘nearest’: nearest neighbor interpolation - ‘linear’: linear interpolation - ‘cubic’: C1 cubic splines (aka local splines) - ‘cubic2’: C2 cubic splines (aka natural splines) - ‘catmull-rom’: C1 cubic centripetal “tension” splines

  • name (str) – Name for the new MixedCoilSet.

  • check_intersection (bool) – Whether or not to check the coils in the new coilset for intersections.

Returns:

coilset (MixedCoilSet) – New representation of the coilset parameterized by a spline for X,Y,Z.