Skip to content

Operators¤

cryojax.ndimage.operators.AbstractImageOperator

cryojax.ndimage.operators.AbstractImageOperator ¤

Abstract base class for image operators in cryojax.

__call__(*args: Any, **kwargs: Any) -> Array ¤

Real-space¤

cryojax.ndimage.operators.AbstractRealOperator

cryojax.ndimage.operators.AbstractRealOperator(cryojax.ndimage.operators.AbstractImageOperator) ¤

The base class for all real operators.

By convention, operators should be defined to have units of inverse area (up to a scale factor).

To create a subclass,

1) Include the necessary parameters in
   the class definition.
2) Overrwrite the ``__call__`` method.
__call__(coordinate_grid: Float[Array, 'y_dim x_dim 2'] | Float[Array, 'z_dim y_dim x_dim 3']) -> Float[Array, 'y_dim x_dim'] | Float[Array, 'z_dim y_dim x_dim'] ¤

Fourier-space¤

cryojax.ndimage.operators.AbstractFourierOperator

cryojax.ndimage.operators.AbstractFourierOperator(cryojax.ndimage.operators.AbstractImageOperator) ¤

The base class for all fourier-based operators.

By convention, operators should be defined to be dimensionless (up to a scale factor).

To create a subclass,

1) Include the necessary parameters in
   the class definition.
2) Overrwrite the ``__call__`` method.
__call__(frequency_grid: Float[Array, 'y_dim x_dim 2'] | Float[Array, 'z_dim y_dim x_dim 3']) -> Inexact[Array, 'y_dim x_dim'] | Inexact[Array, 'z_dim y_dim x_dim'] ¤