deepinv.physics

This module provides a set of forward operators for various imaging modalities. Please refer to the Operators & Noise section for more details.

Base Classes

User Guide: refer to Introduction for more information.

deepinv.physics.Physics	Parent class for forward operators
deepinv.physics.LinearPhysics	Parent class for linear operators.
deepinv.physics.DecomposablePhysics	Parent class for linear operators with SVD decomposition.

deepinv.physics.generator.PhysicsGenerator	Base class for parameter generation of physics parameters.
deepinv.physics.generator.GeneratorMixture	Base class for mixing multiple PhysicsGenerator.

Operators

User Guide: refer to Operators for more information.

deepinv.physics.Denoising	Forward operator for denoising problems.
deepinv.physics.Inpainting	Inpainting forward operator, keeps a subset of entries.
deepinv.physics.Decolorize	Converts RGB images to grayscale.
deepinv.physics.Demosaicing	Demosaicing operator.
deepinv.physics.Blur	Blur operator.
deepinv.physics.BlurFFT	FFT-based blur operator.
deepinv.physics.SpaceVaryingBlur	Implements a space varying blur via product-convolution.
deepinv.physics.Downsampling	Downsampling operator for super-resolution problems.
deepinv.physics.MRI	Single-coil accelerated 2D or 3D magnetic resonance imaging.
deepinv.physics.MRIMixin	Mixin base class for MRI functionality.
deepinv.physics.DynamicMRI	Single-coil accelerated dynamic magnetic resonance imaging.
deepinv.physics.MultiCoilMRI	Multi-coil 2D or 3D MRI operator.
deepinv.physics.SequentialMRI	Single-coil accelerated magnetic resonance imaging using sequential sampling.
deepinv.physics.Tomography	(Computed) Tomography operator.
deepinv.physics.Pansharpen	Pansharpening forward operator.
deepinv.physics.CompressedSensing	Compressed Sensing forward operator.
deepinv.physics.StructuredRandom	Structured random linear operator model corresponding to the operator
deepinv.physics.SinglePixelCamera	Single pixel imaging camera.
deepinv.physics.RadioInterferometry	Radio Interferometry measurement operator.
deepinv.physics.SinglePhotonLidar	Single photon lidar operator for depth ranging.
deepinv.physics.Haze	Standard haze model
deepinv.physics.PhaseRetrieval	Phase Retrieval base class corresponding to the operator
deepinv.physics.RandomPhaseRetrieval	Random Phase Retrieval forward operator.
deepinv.physics.StructuredRandomPhaseRetrieval	Structured random phase retrieval model corresponding to the operator

deepinv.physics.generator.BernoulliSplittingMaskGenerator	Base generator for splitting/inpainting masks.
deepinv.physics.generator.GaussianSplittingMaskGenerator	Randomly generate Gaussian splitting/inpainting masks.
deepinv.physics.generator.Phase2PhaseSplittingMaskGenerator	Phase2Phase splitting mask generator for dynamic data.
deepinv.physics.generator.Artifact2ArtifactSplittingMaskGenerator	Artifact2Artifact splitting mask generator for dynamic data.
deepinv.physics.generator.MotionBlurGenerator	Random motion blur generator.
deepinv.physics.generator.DiffractionBlurGenerator	Diffraction limited blur generator.
deepinv.physics.generator.DiffractionBlurGenerator3D	3D diffraction limited kernels using Zernike decomposition of the phase mask.
deepinv.physics.generator.ProductConvolutionBlurGenerator	Generates parameters of space-varying blurs.
deepinv.physics.generator.BaseMaskGenerator	Base generator for MRI acceleration masks.
deepinv.physics.generator.GaussianMaskGenerator	Generator for MRI Cartesian acceleration masks using Gaussian undersampling.
deepinv.physics.generator.RandomMaskGenerator	Generator for MRI Cartesian acceleration masks using random uniform undersampling.
deepinv.physics.generator.EquispacedMaskGenerator	Generator for MRI Cartesian acceleration masks using uniform (equispaced) non-random undersampling with random offset.

deepinv.physics.blur.gaussian_blur	Gaussian blur filter.
deepinv.physics.blur.bilinear_filter	Bilinear filter.
deepinv.physics.blur.bicubic_filter	Bicubic filter.
deepinv.physics.blur.sinc_filter	Anti-aliasing sinc filter multiplied by a Kaiser window.

Noise distributions

User Guide: refer to Noise distributions for more information.

deepinv.physics.GaussianNoise	Gaussian noise \(y=z+\epsilon\) where \(\epsilon\sim \mathcal{N}(0,I\sigma^2)\).
deepinv.physics.LogPoissonNoise	Log-Poisson noise \(y = \frac{1}{\mu} \log(\frac{\mathcal{P}(\exp(-\mu x) N_0)}{N_0})\).
deepinv.physics.PoissonNoise	Poisson noise \(y = \mathcal{P}(\frac{x}{\gamma})\) with gain \(\gamma>0\).
deepinv.physics.PoissonGaussianNoise	Poisson-Gaussian noise \(y = \gamma z + \epsilon\) where \(z\sim\mathcal{P}(\frac{x}{\gamma})\) and \(\epsilon\sim\mathcal{N}(0, I \sigma^2)\).
deepinv.physics.UniformNoise	Uniform noise \(y = x + \epsilon\) where \(\epsilon\sim\mathcal{U}(-a,a)\).
deepinv.physics.UniformGaussianNoise	Gaussian noise \(y=z+\epsilon\) where \(\epsilon\sim \mathcal{N}(0,I\sigma^2)\) and \(\sigma \sim\mathcal{U}(\sigma_{\text{min}}, \sigma_{\text{max}})\)
deepinv.physics.GammaNoise	Gamma noise \(y = \mathcal{G}(\ell, x/\ell)\)
deepinv.physics.generator.SigmaGenerator	Generator for the noise level \(\sigma\) in the Gaussian noise model.

deepinv.physics.TimeMixin	Base class for temporal capabilities for physics and models.
deepinv.physics.adjoint_function	Provides the adjoint function of a linear operator \(A\), i.e., \(A^{\top}\).

Functional

User Guide: refer to Functional for more information.

deepinv.physics.functional.conv2d	A helper function performing the 2d convolution of images x and filter.
deepinv.physics.functional.conv_transpose2d	A helper function performing the 2d transposed convolution 2d of x and filter.
deepinv.physics.functional.conv2d_fft	A helper function performing the 2d convolution of images x and filter using FFT.
deepinv.physics.functional.conv_transpose2d_fft	A helper function performing the 2d transposed convolution 2d of x and filter using FFT.
deepinv.physics.functional.conv3d_fft	A helper function performing the 3d convolution of x and filter using FFT.
deepinv.physics.functional.conv_transpose3d_fft	A helper function performing the 3d transposed convolution of y and filter using FFT.
deepinv.physics.functional.product_convolution2d	Product-convolution operator in 2d.
deepinv.physics.functional.multiplier	Implements diagonal matrices or multipliers \(x\) and mult.
deepinv.physics.functional.multiplier_adjoint	Implements the adjoint of diagonal matrices or multipliers \(x\) and mult.
deepinv.physics.functional.Radon	Sparse Radon transform operator.
deepinv.physics.functional.IRadon	Inverse sparse Radon transform operator.
deepinv.physics.functional.histogramdd	Computes the multidimensional histogram of a tensor.
deepinv.physics.functional.histogram	Computes the histogram of a tensor.