Class for symmetric spherical harmonics The index scheme of the coefficients/basis values is like in the Descoteaux paper "Regularized, Fast, and Robust Analytical Q-Ball Imaging". More...
#include <WSymmetricSphericalHarmonic.h>
Public Member Functions | |
WSymmetricSphericalHarmonic () | |
Default constructor. | |
WSymmetricSphericalHarmonic (const WValue< double > &SHCoefficients) | |
Constructor. | |
virtual | ~WSymmetricSphericalHarmonic () |
Destructor. | |
double | getValue (double theta, double phi) const |
Return the value on the sphere. | |
double | getValue (const WUnitSphereCoordinates &coordinates) const |
Return the value on the sphere. | |
const WValue< double > & | getCoefficients () const |
Returns the used coefficients (stored like in the mentioned 2007 Descoteaux paper). | |
WValue< double > | getCoefficientsSchultz () const |
Returns the coefficients for Schultz' SH base. | |
WValue< std::complex< double > > | getCoefficientsComplex () const |
Returns the coefficients for the complex base. | |
void | applyFunkRadonTransformation (WMatrix< double > const &frtMat) |
Applies the Funk-Radon-Transformation. | |
size_t | getOrder () const |
Return the order of the spherical harmonic. | |
double | calcGFA (std::vector< WUnitSphereCoordinates > const &orientations) const |
Calculate the generalized fractional anisotropy for this ODF. | |
double | calcGFA (WMatrix< double > const &B) const |
Calculate the generalized fractional anisotropy for this ODF. | |
void | normalize () |
Normalize this SH in place. | |
Static Public Member Functions | |
static WMatrix< double > | getSHFittingMatrix (const std::vector< WVector3d > &orientations, int order, double lambda, bool withFRT) |
This calculates the transformation/fitting matrix T like in the 2007 Descoteaux paper. | |
static WMatrix< double > | getSHFittingMatrix (const std::vector< WUnitSphereCoordinates > &orientations, int order, double lambda, bool withFRT) |
This calculates the transformation/fitting matrix T like in the 2007 Descoteaux paper. | |
static WMatrix< double > | calcBaseMatrix (const std::vector< WUnitSphereCoordinates > &orientations, int order) |
Calculates the base matrix B like in the dissertation of Descoteaux. | |
static WMatrix< std::complex < double > > | calcComplexBaseMatrix (std::vector< WUnitSphereCoordinates > const &orientations, int order) |
Calculates the base matrix B for the complex spherical harmonics. | |
static WMatrix< double > | calcSmoothingMatrix (size_t order) |
This calcs the smoothing matrix L from the 2007 Descoteaux Paper "Regularized, Fast, and Robust Analytical Q-Ball Imaging". | |
static WMatrix< double > | calcFRTMatrix (size_t order) |
Calculates the Funk-Radon-Transformation-Matrix P from the 2007 Descoteaux Paper "Regularized, Fast, and Robust Analytical Q-Ball Imaging". | |
static WMatrix< double > | calcSHToTensorSymMatrix (std::size_t order, const std::vector< WUnitSphereCoordinates > &orientations) |
Calculates a matrix that converts spherical harmonics to symmetric tensors of equal or lower order. | |
Private Attributes | |
size_t | m_order |
order of the spherical harmonic | |
WValue< double > | m_SHCoefficients |
coefficients of the spherical harmonic |
Class for symmetric spherical harmonics The index scheme of the coefficients/basis values is like in the Descoteaux paper "Regularized, Fast, and Robust Analytical Q-Ball Imaging".
Definition at line 41 of file WSymmetricSphericalHarmonic.h.
WSymmetricSphericalHarmonic::WSymmetricSphericalHarmonic | ( | ) |
Default constructor.
Definition at line 40 of file WSymmetricSphericalHarmonic.cpp.
WSymmetricSphericalHarmonic::WSymmetricSphericalHarmonic | ( | const WValue< double > & | SHCoefficients | ) | [explicit] |
Constructor.
SHCoefficients | the initial coefficients (stored like in the mentioned Descoteaux paper). |
Definition at line 46 of file WSymmetricSphericalHarmonic.cpp.
References m_order, m_SHCoefficients, and WValue< T >::size().
WSymmetricSphericalHarmonic::~WSymmetricSphericalHarmonic | ( | ) | [virtual] |
Destructor.
Definition at line 55 of file WSymmetricSphericalHarmonic.cpp.
void WSymmetricSphericalHarmonic::applyFunkRadonTransformation | ( | WMatrix< double > const & | frtMat | ) |
Applies the Funk-Radon-Transformation.
This is faster than matrix multiplication. ( O(n) instead of O(n²) )
frtMat | the frt matrix as calculated by calcFRTMatrix() |
Definition at line 242 of file WSymmetricSphericalHarmonic.cpp.
References WMatrix< T >::getNbCols(), WMatrix< T >::getNbRows(), m_SHCoefficients, and WValue< T >::size().
WMatrix< double > WSymmetricSphericalHarmonic::calcBaseMatrix | ( | const std::vector< WUnitSphereCoordinates > & | orientations, | |
int | order | |||
) | [static] |
Calculates the base matrix B like in the dissertation of Descoteaux.
orientations | The vector with the used orientation on the unit sphere (usually the gradients of the HARDI) | |
order | The order of the spherical harmonics intended to create |
Definition at line 296 of file WSymmetricSphericalHarmonic.cpp.
Referenced by calcSHToTensorSymMatrix(), and getSHFittingMatrix().
WMatrix< std::complex< double > > WSymmetricSphericalHarmonic::calcComplexBaseMatrix | ( | std::vector< WUnitSphereCoordinates > const & | orientations, | |
int | order | |||
) | [static] |
Calculates the base matrix B for the complex spherical harmonics.
orientations | The vector with the used orientation on the unit sphere (usually the gradients of the HARDI) | |
order | The order of the spherical harmonics intended to create |
Definition at line 331 of file WSymmetricSphericalHarmonic.cpp.
WMatrix< double > WSymmetricSphericalHarmonic::calcFRTMatrix | ( | size_t | order | ) | [static] |
Calculates the Funk-Radon-Transformation-Matrix P from the 2007 Descoteaux Paper "Regularized, Fast, and Robust Analytical Q-Ball Imaging".
order | The order of the spherical harmonic |
Definition at line 376 of file WSymmetricSphericalHarmonic.cpp.
Referenced by getSHFittingMatrix(), and WSymmetricSphericalHarmonicTest::testCalcFRTMatrix().
double WSymmetricSphericalHarmonic::calcGFA | ( | std::vector< WUnitSphereCoordinates > const & | orientations | ) | const |
Calculate the generalized fractional anisotropy for this ODF.
See: David S. Tuch, "Q-Ball Imaging", Magn. Reson. Med. 52, 2004, 1358-1372
orientations | A vector of unit sphere coordinates. |
Definition at line 148 of file WSymmetricSphericalHarmonic.cpp.
References getValue().
double WSymmetricSphericalHarmonic::calcGFA | ( | WMatrix< double > const & | B | ) | const |
Calculate the generalized fractional anisotropy for this ODF.
This version of the function uses precomputed base functions (because calculating the base function values is rather expensive). Use this version if you want to compute the GFA for multiple ODFs with the same base functions. The base function Matrix can be computed using
See: David S. Tuch, "Q-Ball Imaging", Magn. Reson. Med. 52, 2004, 1358-1372
B | The matrix of SH base functions. |
Definition at line 191 of file WSymmetricSphericalHarmonic.cpp.
References WMatrix< T >::getNbCols(), WMatrix< T >::getNbRows(), m_SHCoefficients, and WValue< T >::size().
WMatrix< double > WSymmetricSphericalHarmonic::calcSHToTensorSymMatrix | ( | std::size_t | order, | |
const std::vector< WUnitSphereCoordinates > & | orientations | |||
) | [static] |
Calculates a matrix that converts spherical harmonics to symmetric tensors of equal or lower order.
order | The order of the symmetric tensor. | |
orientations | A vector of at least (orderTensor+1) * (orderTensor+2) / 2 orientations. |
Definition at line 394 of file WSymmetricSphericalHarmonic.cpp.
References calcBaseMatrix().
WMatrix< double > WSymmetricSphericalHarmonic::calcSmoothingMatrix | ( | size_t | order | ) | [static] |
This calcs the smoothing matrix L from the 2007 Descoteaux Paper "Regularized, Fast, and Robust Analytical Q-Ball Imaging".
order | The order of the spherical harmonic |
Definition at line 360 of file WSymmetricSphericalHarmonic.cpp.
Referenced by getSHFittingMatrix(), and WSymmetricSphericalHarmonicTest::testCalcSmoothingMatrix().
const WValue< double > & WSymmetricSphericalHarmonic::getCoefficients | ( | ) | const |
Returns the used coefficients (stored like in the mentioned 2007 Descoteaux paper).
Definition at line 90 of file WSymmetricSphericalHarmonic.cpp.
References m_SHCoefficients.
WValue< std::complex< double > > WSymmetricSphericalHarmonic::getCoefficientsComplex | ( | ) | const |
Returns the coefficients for the complex base.
Definition at line 118 of file WSymmetricSphericalHarmonic.cpp.
References m_order, m_SHCoefficients, and WValue< T >::size().
WValue< double > WSymmetricSphericalHarmonic::getCoefficientsSchultz | ( | ) | const |
Returns the coefficients for Schultz' SH base.
Definition at line 95 of file WSymmetricSphericalHarmonic.cpp.
References m_order, m_SHCoefficients, and WValue< T >::size().
size_t WSymmetricSphericalHarmonic::getOrder | ( | ) | const |
Return the order of the spherical harmonic.
Definition at line 253 of file WSymmetricSphericalHarmonic.cpp.
References m_order.
WMatrix< double > WSymmetricSphericalHarmonic::getSHFittingMatrix | ( | const std::vector< WUnitSphereCoordinates > & | orientations, | |
int | order, | |||
double | lambda, | |||
bool | withFRT | |||
) | [static] |
This calculates the transformation/fitting matrix T like in the 2007 Descoteaux paper.
The orientations are given as WUnitSphereCoordinates .
orientations | The vector with the used orientation on the unit sphere (usually the gradients of the HARDI) | |
order | The order of the spherical harmonics intended to create | |
lambda | Regularization parameter for smoothing matrix | |
withFRT | include the Funk-Radon-Transformation? |
Definition at line 272 of file WSymmetricSphericalHarmonic.cpp.
References calcBaseMatrix(), calcFRTMatrix(), calcSmoothingMatrix(), and WMatrix< T >::transposed().
WMatrix< double > WSymmetricSphericalHarmonic::getSHFittingMatrix | ( | const std::vector< WVector3d > & | orientations, | |
int | order, | |||
double | lambda, | |||
bool | withFRT | |||
) | [static] |
This calculates the transformation/fitting matrix T like in the 2007 Descoteaux paper.
The orientations are given as WVector3d.
orientations | The vector with the used orientation on the unit sphere (usually the gradients of the HARDI) | |
order | The order of the spherical harmonics intended to create | |
lambda | Regularization parameter for smoothing matrix | |
withFRT | include the Funk-Radon-Transformation? |
Definition at line 258 of file WSymmetricSphericalHarmonic.cpp.
double WSymmetricSphericalHarmonic::getValue | ( | double | theta, | |
double | phi | |||
) | const |
Return the value on the sphere.
theta | angle for the position on the unit sphere | |
phi | angle for the position on the unit sphere |
Definition at line 59 of file WSymmetricSphericalHarmonic.cpp.
References m_order, and m_SHCoefficients.
Referenced by calcGFA(), and getValue().
double WSymmetricSphericalHarmonic::getValue | ( | const WUnitSphereCoordinates & | coordinates | ) | const |
Return the value on the sphere.
coordinates | for the position on the unit sphere |
Definition at line 85 of file WSymmetricSphericalHarmonic.cpp.
References WUnitSphereCoordinates::getPhi(), WUnitSphereCoordinates::getTheta(), and getValue().
void WSymmetricSphericalHarmonic::normalize | ( | ) |
Normalize this SH in place.
Definition at line 446 of file WSymmetricSphericalHarmonic.cpp.
References m_SHCoefficients, and WValue< T >::size().
size_t WSymmetricSphericalHarmonic::m_order [private] |
order of the spherical harmonic
Definition at line 219 of file WSymmetricSphericalHarmonic.h.
Referenced by getCoefficientsComplex(), getCoefficientsSchultz(), getOrder(), getValue(), and WSymmetricSphericalHarmonic().
WValue<double> WSymmetricSphericalHarmonic::m_SHCoefficients [private] |
coefficients of the spherical harmonic
Definition at line 222 of file WSymmetricSphericalHarmonic.h.
Referenced by applyFunkRadonTransformation(), calcGFA(), getCoefficients(), getCoefficientsComplex(), getCoefficientsSchultz(), getValue(), normalize(), and WSymmetricSphericalHarmonic().