# Difference between revisions of "Penalty.m"

(basics of penalty.m (outdated)) |
(Created basic page for the penalty.m function) |
||

Line 1: | Line 1: | ||

{{DISPLAYTITLE:penalty.m}} | {{DISPLAYTITLE:penalty.m}} | ||

− | + | Penalty terms for the Optimal Control module. Returns the penalty function and its gradient for the waveform, which should be supplied as row vector or a horizontal stack thereof. | |

− | + | ==Syntax== | |

− | |||

− | + | [pen_term,pen_grad,pen_hess]=penalty(wf,type,fb,cb) | |

− | = | + | ==Description== |

− | + | This function looks at the edges of the spectrum and subtracts anything that it finds there from the entire spectrum. The assumption is that anything that's reached as far as the edge must be a streak artefact that should be removed. This is often the case in 2D and 3D NMR spectra. | |

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | |||

− | + | ==Arguments== | |

+ | wf - control sequence waveform. | ||

+ | |||

+ | type - string which identifies penalty type: | ||

+ | 'NS', 'DNS', 'SNS', 'SNC'. | ||

+ | |||

+ | fb - floor bound, the lower bound on waveform used in the | ||

+ | 'SNS' and 'SNC' penalty function. | ||

+ | |||

+ | cb - ceiling bound, the upper bound on waveform used in the | ||

+ | 'SNS' and 'SNC' penalty function. | ||

+ | |||

+ | |||

+ | |||

+ | ==Returns== | ||

+ | |||

+ | pen_term - value of the penalty term. | ||

+ | |||

+ | pen_grad - gradient of the penalty term with respect to wf. | ||

+ | |||

+ | pen_hess - Hessian of the penalty term with respect to wf. | ||

+ | |||

+ | ==Penalty types== | ||

+ | |||

+ | type='NS' - norm square, designed to favour low-power | ||

+ | waveforms over high-power ones. | ||

+ | |||

+ | type='DNS' - derivative norm square, designed to favour | ||

+ | smooth waveforms over jagged ones. | ||

+ | |||

+ | type='SNS' - spillout norm square, 'NS' applied to the | ||

+ | part of the waveform with values outside the | ||

+ | floor and ceiling bounds. | ||

+ | |||

+ | type='SNC' - spillout norm cube, similar to 'SNS' except | ||

+ | the penalty is a cube, not square. | ||

+ | |||

+ | |||

+ | ==Notes== | ||

+ | The waveforms on different channels are assumed to be stored in the rows of the input array. The Hessian elements correspond to the elements of the waveform array ordered as: | ||

+ | <center> | ||

+ | <math>\begin{bmatrix}X_1 & X_2 & \cdots & X_n\\ Y_1 & Y_2 & \cdots & Y_n\\ Z_1 & Z_2 & \cdots & Z_n\end{bmatrix}</math> | ||

+ | </center> | ||

where X,Y,Z are different control channels and the index enumerates the time discretization points. Gradient dimensions and element order are the same as the input waveform dimensions and element order. | where X,Y,Z are different control channels and the index enumerates the time discretization points. Gradient dimensions and element order are the same as the input waveform dimensions and element order. | ||

− | = | + | ==See also== |

− | + | [[grape.m]], [[krotov.m]] | |

− | + | ||

− | + | ||

− | + | ''Revision 3399, authors: [[Ilya Kuprov]], [[David Goodwin]]'' | |

− | |||

− | |||

− | |||

− | |||

− | |||

− |

## Revision as of 21:04, 1 September 2016

Penalty terms for the Optimal Control module. Returns the penalty function and its gradient for the waveform, which should be supplied as row vector or a horizontal stack thereof.

## Syntax

[pen_term,pen_grad,pen_hess]=penalty(wf,type,fb,cb)

## Description

This function looks at the edges of the spectrum and subtracts anything that it finds there from the entire spectrum. The assumption is that anything that's reached as far as the edge must be a streak artefact that should be removed. This is often the case in 2D and 3D NMR spectra.

## Arguments

wf - control sequence waveform. type - string which identifies penalty type: 'NS', 'DNS', 'SNS', 'SNC'. fb - floor bound, the lower bound on waveform used in the 'SNS' and 'SNC' penalty function. cb - ceiling bound, the upper bound on waveform used in the 'SNS' and 'SNC' penalty function.

## Returns

pen_term - value of the penalty term. pen_grad - gradient of the penalty term with respect to wf. pen_hess - Hessian of the penalty term with respect to wf.

## Penalty types

type='NS' - norm square, designed to favour low-power waveforms over high-power ones. type='DNS' - derivative norm square, designed to favour smooth waveforms over jagged ones. type='SNS' - spillout norm square, 'NS' applied to the part of the waveform with values outside the floor and ceiling bounds. type='SNC' - spillout norm cube, similar to 'SNS' except the penalty is a cube, not square.

## Notes

The waveforms on different channels are assumed to be stored in the rows of the input array. The Hessian elements correspond to the elements of the waveform array ordered as:

[math]\begin{bmatrix}X_1 & X_2 & \cdots & X_n\\ Y_1 & Y_2 & \cdots & Y_n\\ Z_1 & Z_2 & \cdots & Z_n\end{bmatrix}[/math]

where X,Y,Z are different control channels and the index enumerates the time discretization points. Gradient dimensions and element order are the same as the input waveform dimensions and element order.

## See also

*Revision 3399, authors: Ilya Kuprov, David Goodwin*