desc.coils.FourierPlanarCoil.to_FourierPlanar

FourierPlanarCoil.to_FourierPlanar(N=10, grid=None, basis='xyz', name='', **kwargs)Source

Convert Coil to FourierPlanarCoil representation.

Note that some types of coils may not be representable in this basis. In this case, a least-squares fit will be done to find the planar coil that best represents the coil.

Parameters:

• N (int) – Fourier resolution of the new FourierPlanarCoil representation.

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

• basis ({'xyz', 'rpz'}) – Coordinate system for center and normal vectors. Default = ‘xyz’.

• name (str) – Name for this coil.

Returns:

coil (FourierPlanarCoil) – New representation of the coil parameterized by Fourier series for minor radius r in a plane specified by a center position and normal vector.