FourierTransform

class hcipy.fourier.FourierTransform

Bases: object

The base class for all Fourier transform implementations.

Attributes:

input_gridGrid

The grid that is expected for the input field.

output_gridGrid

The grid that is produced by the Fourier transform.

Methods Summary

backward(field)	Returns the inverse Fourier transform of the Field field.
check_if_supported(input_grid, output_grid)	Check if the specified grids are supported by this Fourier transform.
compute_complexity(input_grid, output_grid)	Compute the algorithmic complexity for this Fourier transform.
forward(field)	Returns the forward Fourier transform of the Field field.
get_transformation_matrix_backward()	Returns the transformation matrix corresonding to the Fourier transform.
get_transformation_matrix_forward()	Returns the transformation matrix corresonding to the Fourier transform.
is_supported(input_grid, output_grid)	Are the specified grids supported by this Fourier transform?

Methods Documentation

backward(field)

Returns the inverse Fourier transform of the Field field.

Parameters:

fieldField

The field to inverse Fourier transform.

Returns:

Field

The inverse Fourier transform of the field.

classmethod check_if_supported(input_grid, output_grid)

Check if the specified grids are supported by this Fourier transform.

Parameters:

input_gridGrid

The grid that is expected for the input field.

output_gridGrid

The grid that is produced by the Fourier transform.

Raises:

ValueError

If the grids are not supported. The message will indicate why the grids are not supported.

classmethod compute_complexity(input_grid, output_grid)

Compute the algorithmic complexity for this Fourier transform.

Parameters:

input_gridGrid

The grid that is expected for the input field.

output_gridGrid

The grid that is produced by the Fourier transform.

Returns:

AlgorithmicComplexity

The algorithmic complexity for this Fourier transform.

Raises:

ValueError

If the grids are not supported. The message will indicate why the grids are not supported.

forward(field)

Returns the forward Fourier transform of the Field field.

Parameters:

fieldField

The field to Fourier transform.

Returns:

Field

The Fourier transform of the field.

get_transformation_matrix_backward()

Returns the transformation matrix corresonding to the Fourier transform.

Returns:

ndarray

A matrix representing the Fourier transform.

get_transformation_matrix_forward()

Returns the transformation matrix corresonding to the Fourier transform.

Returns:

ndarray

A matrix representing the Fourier transform.

classmethod is_supported(input_grid, output_grid)

Are the specified grids supported by this Fourier transform?

Parameters:

input_gridGrid

The grid that is expected for the input field.

output_gridGrid

The grid that is produced by the Fourier transform.

Returns:

boolean

Whether the grids are supported or not.