Skip to content

DOC: adjusted to fit more general case n != m #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thewtex merged 2 commits into from
Nov 12, 2018
Merged

DOC: adjusted to fit more general case n != m #83

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7268bd
DOC: adjusted to fit more general case n != m
romangrothausmann Mar 19, 2017
bffc8f8
DOC: corrected description of the output
romangrothausmann Mar 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions Modules/Filtering/ImageGradient/include/itkVectorGradientMagnitudeImageFilter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ namespace itk
*
* \par Overview
* This filter has two calculation modes. The first (default) mode calculates
* gradient magnitude as the difference between the largest two eigenvalues in a
* principle component analysis of the partial derivatives [1]. The
* gradient magnitude as the difference between the largest two singular values in a
* singular value decomposition (SVD) of the partial derivatives [1]. The
* gradient is then based on the direction of maximal change, and is a
* characterization of how "elongated" the point-spread of the analysis is
* found to be.
Expand Down Expand Up @@ -65,8 +65,7 @@ namespace itk
*
* The second template parameter, TRealType, can be optionally specified to define the
* scalar numerical type used in calculations. This is the component type of
* the output image, which will be of itk::Vector<TRealType, N>, where N is the
* number of channels in the multiple component input image. The default type
* the output image. The default type
* of TRealType is float. For extra precision, you may safely change this
* parameter to double.
*
Expand All @@ -75,7 +74,7 @@ namespace itk
* it is not necessary (or advisable) to set this parameter explicitly. Given
* an M-channel input image with dimensionality N, and a numerical type
* specified as TRealType, the output image will be of type
* itk::Image<itk::Vector<TRealType, M>, N>.
* itk::Image<TRealType, N>.
*
* \par Filter Parameters
* The methods Set/GetUsePrincipleComponents and
Expand Down