desc.geometry.FourierXYZCurve

class desc.geometry.FourierXYZCurve(X_n=[0, 10, 2], Y_n=[0, 0, 0], Z_n=[-2, 0, 0], modes=None, name='')Source

Curve parameterized by Fourier series for X,Y,Z in terms of arbitrary angle s.

Parameters:
  • X_n (array-like) – Fourier coefficients for X, Y, Z

  • Y_n (array-like) – Fourier coefficients for X, Y, Z

  • Z_n (array-like) – Fourier coefficients for X, Y, Z

  • modes (array-like) – mode numbers associated with X_n etc.

  • name (str) – name for this curve

Methods

change_resolution([N])

Change the maximum angular resolution.

compute(names[, grid, params, transforms, ...])

Compute the quantity given by name on grid.

copy([deepcopy])

Return a (deep)copy of this object.

equiv(other)

Compare equivalence between DESC objects.

flip([normal])

Flip the curve about the plane with specified normal.

from_values(coords[, N, s, basis, name])

Fit coordinates to FourierXYZCurve representation.

get_coeffs(n)

Get Fourier coefficients for given mode number(s).

load(load_from[, file_format])

Initialize from file.

pack_params(p)

Convert a dictionary of parameters into a single array.

rotate([axis, angle])

Rotate the curve by a fixed angle about axis in X, Y, Z coordinates.

save(file_name[, file_format, file_mode])

Save the object.

set_coeffs(n[, X, Y, Z])

Set specific Fourier coefficients.

to_FourierXYZ([N, grid, s, name])

Convert Curve to FourierXYZCurve representation.

to_SplineXYZ([knots, grid, method, name])

Convert Curve to SplineXYZCurve.

translate([displacement])

Translate the curve by a rigid displacement in X, Y, Z.

unpack_params(x)

Convert a single array of concatenated parameters into a dictionary.

Attributes

N

Maximum mode number.

X_basis

Spectral basis for X Fourier series.

X_n

Spectral coefficients for X.

Y_basis

Spectral basis for Y Fourier series.

Y_n

Spectral coefficients for Y.

Z_basis

Spectral basis for Z Fourier series.

Z_n

Spectral coefficients for Z.

dim_x

total number of optimizable parameters.

dimensions

dictionary of integers of sizes of each optimizable parameter.

name

Name of the curve.

optimizable_params

string names of parameters that have been declared optimizable.

params_dict

dictionary of arrays of optimizable parameters.

rotmat

Rotation matrix of curve in X, Y, Z.

shift

Displacement of curve in X, Y, Z.

x_idx

arrays of indices for each parameter in concatenated array.