FourierShift

class hcipy.fourier.FourierShift(input_grid, shift)

Bases: object

An image shifting operator implemented in the Fourier domain.

This operator is smart enough to ignore dimensions where the shift is zero.

Parameters:

input_gridGrid

The grid that is expected for the input field.

shiftarray_like

The shift to apply to any input field.

Attributes:

shiftarray_like

The shift to apply to any input field.

Attributes Summary

shift

Methods Summary

backward(field)	Return the backward (adjoint) filtering of the input field.
forward(field)	Return the forward filtering of the input field.

Attributes Documentation

shift

Methods Documentation

backward(field)

Return the backward (adjoint) filtering of the input field.

Parameters:

fieldField

The field to filter.

Returns:

Field

The adjoint filtered field.

forward(field)

Return the forward filtering of the input field.

Parameters:

fieldField

The field to filter.

Returns:

Field

The filtered field.