field - Fields and Grids

Functions

field_einsum(subscripts, \*operands, \*\*kwargs)

Evaluates the Einstein summation convention on the operand fields.

field_dot(a, b[, out])

Perform a dot product of a and b multiplexed over the field dimension.

field_trace(a[, out])

Take the trace of a tensor field.

field_inv(f)

Compute the (multiplicative) inverse of a tensor field of order 2.

field_inverse_tikhonov(f[, rcond])

Invert a tensor field of order 2 using Tikhonov regularization.

field_inverse_truncated(f[, rcond])

Invert a tensor field of order 2 using mode truncation.

field_inverse_truncated_modal(f, num_modes)

Invert a tensor field of order 2 using mode truncation.

field_svd(f[, full_matrices, compute_uv])

Calculate the singular value decomposition for a tensor field of order 2.

make_field_operation(op)

field_conjugate_transpose(a)

Performs the conjugate transpose of a rank 2 tensor field or two dimensional array.

field_transpose(a)

Performs the transpose of a rank 2 tensor field or two dimensional array.

field_determinant(a)

Calculates the determinant of a tensor field.

field_adjoint(a)

Calculates the adjoint of a tensor field.

field_cross(a, b)

Calculates the cross product of two vector fields.

field_kron(a, b)

Calculate the Kronecker product of two fields.

make_uniform_grid(dims, extent[, center, …])

Create a uniformly-spaced Grid of a certain shape and size.

make_pupil_grid(dims[, diameter])

Makes a new Grid, meant for descretisation of a pupil-plane wavefront.

make_focal_grid_from_pupil_grid(pupil_grid)

Make a grid for a focal plane from a pupil grid.

make_focal_grid(q, num_airy[, …])

Make a grid for a focal plane.

make_hexagonal_grid(circum_diameter, n_rings)

Make a regular hexagonal grid.

make_chebyshev_grid(dims[, minimum, maximum])

make_supersampled_grid(grid, oversampling)

Make a new grid that oversamples by a factor oversampling.

make_subsampled_grid(grid, undersampling)

Make a new grid that undersamples by a factor undersampling.

subsample_field(field, subsampling[, …])

Average the field over subsampling pixels in each dimension.

evaluate_supersampled(field_generator, grid, …)

Evaluate a Field generator on grid, with an oversampling.

make_uniform_vector_field(field, jones_vector)

Make an uniform vector field from a scalar field and a jones vector.

make_uniform_vector_field_generator(…)

Make an uniform vector field generator from a scalar field generator and a jones vector.

Classes

Grid(coords[, weights])

A set of points on some coordinate system.

Field

The value of some physical quantity for each point in some coordinate system.

CartesianGrid(coords[, weights])

A grid representing a N-dimensional Cartesian coordinate system.

PolarGrid(coords[, weights])

A grid representing a two-dimensional Polar coordinate system.

UnstructuredCoords(coords)

An unstructured list of points.

SeparatedCoords(separated_coords)

A list of points that are separable along each dimension.

RegularCoords(delta, dims[, zero])

A list of points that have a regular spacing in all dimensions.