FourierShear
- class hcipy.fourier.FourierShear(input_grid, shear, shear_dim=0)
Bases:
objectAn image shearing operator implemented in the Fourier domain.
When given an image I(x, y), this operator will return a new image I(x + a * y, y) when a shearing along the x axis is requested.
- Parameters:
- input_gridGrid
The grid that is expected for the input field.
- shearscalar
The amount of shear to apply to the image.
- shear_diminteger
The dimension to which to apply the shear. A shear along x would be a value of 0, a shear along y would be 1.
- Attributes:
- input_gridGrid
The grid assumed for the input of this operator. Read-only.
- shearscalar
The amount of shear along the axis.
- shear_diminteger
The dimension along which the shear is applied. Read-only.
- Raises:
- ValueError
When the input grid is not 2D and regularly spaced.
Attributes Summary
Methods Summary
backward(field)Return the backward (adjoint) shear of the input field.
forward(field)Return the forward shear of the input field.
Attributes Documentation
- fourier_dim
- input_grid
- shear
- shear_dim
Methods Documentation
- backward(field)
Return the backward (adjoint) shear of the input field.
- Parameters:
- fieldField
The field to shear.
- Returns:
- Field
The adjoint sheared field.
- forward(field)
Return the forward shear of the input field.
- Parameters:
- fieldField
The field to shear.
- Returns:
- Field
The sheared field.