desc.coils.FourierPlanarCoil.to_FourierXYZ

FourierPlanarCoil.to_FourierXYZ(N=10, grid=None, s=None, name='')Source

Convert coil to FourierXYZCoil representation.

Parameters:

  • N (int) – Fourier resolution of the new X,Y,Z representation.

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

  • s (ndarray or "arclength") – arbitrary curve parameter to use for the fitting. Should be monotonic, 1D array of same length as coords. if None, defaults linearly spaced in [0,2pi) Alternative, can pass “arclength” to use normalized distance between points.

  • name (str) – name for this coil

Returns:

coil (FourierXYZCoil) – New representation of the coil parameterized by Fourier series for X,Y,Z.