Preprocessor.step_wedge_mask

Preprocessor.step_wedge_mask(shape, tilt_angles=None, opening_axis=0, tilt_axis=2, weights=None, infinite_plane=False, omit_negative_frequencies=True)

Create a wedge mask with the same shape as template by rotating a plane according to tilt angles. The DC component of the filter is at the origin.

Parameters:

tilt_anglestuple of float

Sequence of tilt angles.

shapeTuple of ints

Shape of the output wedge array.

tilt_axisint, optional

Axis that the plane is tilted over. - 0 for Z-axis - 1 for Y-axis - 2 for X-axis

opening_axisint, optional

Axis running through the void defined by the wedge. - 0 for Z-axis - 1 for Y-axis - 2 for X-axis

sigmafloat, optional

Standard deviation for Gaussian kernel used for smoothing the wedge.

weightsfloat, tuple of float

Weight of each element in the wedge. Defaults to one.

omit_negative_frequenciesbool, optional

Whether the wedge mask should omit negative frequencies, i.e. be applicable to symmetric Fourier transforms (see numpy.fft.fftn)

Returns:

NDArray

A numpy array containing the wedge mask.

See also

Preprocessor.continuous_wedge_mask()