2.1.6.1.3. sf_tools.signal.gradient module

GRADIENT CLASSES

This module contains classses for defining algorithm gradients. Based on work by Yinghao Ge and Fred Ngole.

Author:Samuel Farrens <samuel.farrens@gmail.com>
Version:1.3
Date:19/07/2017
class sf_tools.signal.gradient.GradBasic[source]

Bases: object

Basic gradient class

This class defines the basic methods that will be inherited by specific gradient classes

MtMX(x)[source]

M^T M X

This method calculates the action of the transpose of the matrix M on the action of the matrix M on the data X

Parameters:x (np.ndarray) – Input data array
Returns:
Return type:np.ndarray result

Notes

Calculates M^T (MX)

get_grad(x)[source]

Get the gradient step

This method calculates the gradient step from the input data

Parameters:x (np.ndarray) – Input data array
Returns:
Return type:np.ndarray gradient value

Notes

Calculates M^T (MX - Y)