diff --git a/Modules/Core/Transform/include/itkScalableAffineTransform.h b/Modules/Core/Transform/include/itkScalableAffineTransform.h index 216818b3388..c70d3ded890 100644 --- a/Modules/Core/Transform/include/itkScalableAffineTransform.h +++ b/Modules/Core/Transform/include/itkScalableAffineTransform.h @@ -83,13 +83,12 @@ class ITK_TEMPLATE_EXPORT ScalableAffineTransform : public AffineTransformSetScale(scale); } - /** Set the scale of the transform */ + /** Set the scale of the transform. */ virtual void SetScale(const double scale[VDimension]); @@ -121,11 +120,11 @@ class ITK_TEMPLATE_EXPORT ScalableAffineTransform : public AffineTransform ScalableAffineTransform::ScalableAffineTransform() : Superclass(Self::ParametersDimension) @@ -37,7 +37,6 @@ ScalableAffineTransform::ScalableAffineTransfo } } -/** Constructor with default arguments */ template ScalableAffineTransform::ScalableAffineTransform(unsigned int, unsigned int parametersDimension) @@ -61,7 +60,6 @@ ScalableAffineTransform::ScalableAffineTransfo } } -/** Constructor with default arguments */ template ScalableAffineTransform::ScalableAffineTransform(const MatrixType & matrix, const OutputVectorType & offset) @@ -74,7 +72,6 @@ ScalableAffineTransform::ScalableAffineTransfo } } -/** Print self */ template void ScalableAffineTransform::PrintSelf(std::ostream & os, Indent indent) const @@ -97,7 +94,6 @@ ScalableAffineTransform::PrintSelf(std::ostrea os << std::endl; } -// Set the parameters in order to fit an Identity transform template void ScalableAffineTransform::SetIdentity() @@ -110,7 +106,6 @@ ScalableAffineTransform::SetIdentity() this->Superclass::SetIdentity(); } -/** Set the scale of the transformation */ template void ScalableAffineTransform::SetScale(const InputVectorType & scale) @@ -139,7 +134,6 @@ ScalableAffineTransform::SetScale(const double this->Modified(); } -// Get an inverse of this transform template bool ScalableAffineTransform::GetInverse(Self * inverse) const @@ -147,7 +141,6 @@ ScalableAffineTransform::GetInverse(Self * inv return this->Superclass::GetInverse(inverse); } -// Return an inverse of this transform template auto ScalableAffineTransform::GetInverseTransform() const -> InverseTransformBasePointer @@ -157,7 +150,6 @@ ScalableAffineTransform::GetInverseTransform() return this->GetInverse(inv) ? inv.GetPointer() : nullptr; } -/** Set the scale of the transformation */ template void ScalableAffineTransform::ComputeMatrix() diff --git a/Modules/IO/GIPL/include/itkGiplImageIO.h b/Modules/IO/GIPL/include/itkGiplImageIO.h index bd22a255273..14e5539f71a 100644 --- a/Modules/IO/GIPL/include/itkGiplImageIO.h +++ b/Modules/IO/GIPL/include/itkGiplImageIO.h @@ -60,7 +60,7 @@ class ITKIOGIPL_EXPORT GiplImageIO : public ImageIOBase bool CanReadFile(const char *) override; - /** Set the spacing and dimension information for the set filename. */ + /** Read information about the Gipl file and put the cursor of the stream just before the first data pixel. */ void ReadImageInformation() override; diff --git a/Modules/IO/GIPL/src/itkGiplImageIO.cxx b/Modules/IO/GIPL/src/itkGiplImageIO.cxx index f6ec6220fef..ec8939f897d 100644 --- a/Modules/IO/GIPL/src/itkGiplImageIO.cxx +++ b/Modules/IO/GIPL/src/itkGiplImageIO.cxx @@ -72,7 +72,6 @@ class GiplImageIOInternals #define GIPL_MAGIC_NUMBER 0xefffe9b0 #define GIPL_MAGIC_NUMBER2 0x2ae389b8 -/** Constructor */ GiplImageIO::GiplImageIO() { m_Internal = new GiplImageIOInternals; @@ -81,7 +80,6 @@ GiplImageIO::GiplImageIO() m_IsCompressed = false; } -/** Destructor */ GiplImageIO::~GiplImageIO() { if (m_IsCompressed) @@ -254,10 +252,6 @@ GiplImageIO::Read(void * buffer) SwapBytesIfNecessary(buffer, numberOfPixels); } -/** - * Read Information about the Gipl file - * and put the cursor of the stream just before the first data pixel - */ void GiplImageIO::ReadImageInformation() { @@ -1100,7 +1094,6 @@ GiplImageIO ::Write(const void * buffer) } } -/** Print Self Method */ void GiplImageIO::PrintSelf(std::ostream & os, Indent indent) const { diff --git a/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.h b/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.h index 6e51fb7061b..a8ccb73a5f1 100644 --- a/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.h +++ b/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.h @@ -120,10 +120,10 @@ class ITK_TEMPLATE_EXPORT ScalarRegionBasedLevelSetFunction using ListPixelIterator = typename ListPixelType::iterator; using ListImageType = Image; - /** \brief Performs the narrow-band update of the Heaviside function for each - voxel. The characteristic function of each region is recomputed (note the - shared data which contains information from the other level sets). Using the - new H values, the previous c_i are updated. */ + /** Performs the narrow-band update of the Heaviside function for each + * voxel. The characteristic function of each region is recomputed (note the + * shared data which contains information from the other level sets). Using the + * new $H$ values, the previous $c_i$ are updated. */ void UpdatePixel(const unsigned int idx, NeighborhoodIterator & iterator, @@ -136,12 +136,14 @@ class ITK_TEMPLATE_EXPORT ScalarRegionBasedLevelSetFunction {} ~ScalarRegionBasedLevelSetFunction() override = default; + /** Compute the overlap multiplicative factors for the penalty term (sum) and + * the background intensity fitting terms in multiphase level-sets. */ ScalarValueType ComputeOverlapParameters(const FeatureIndexType & featIndex, ScalarValueType & product) override; - // update the background and foreground constants for pixel updates - // Called only when sparse filters are used to prevent iteration through the - // entire image + /** Update the background and foreground constants for pixel updates. + * Called only when sparse filters are used to prevent iteration through the + * entire image. */ virtual void UpdateSharedDataInsideParameters(const unsigned int & iId, const FeaturePixelType & iVal, diff --git a/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.hxx b/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.hxx index 6c36076e9f0..f9c16790b3e 100644 --- a/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.hxx +++ b/Modules/Nonunit/Review/include/itkScalarRegionBasedLevelSetFunction.hxx @@ -21,8 +21,7 @@ namespace itk { -// Computes the overlap multiplicative factors for the penalty term (sum) and -// the background intensity fitting terms in multiphase level-sets + template typename ScalarRegionBasedLevelSetFunction::ScalarValueType ScalarRegionBasedLevelSetFunction::ComputeOverlapParameters( @@ -60,11 +59,6 @@ ScalarRegionBasedLevelSetFunction::Comp return sum; } -/* Performs the narrow-band update of the Heaviside function for each voxel. The -characteristic function of each region is recomputed (note the shared -data which contains information from the other level sets). Using the -new H values, the previous c_i are updated. Used by only the sparse image -filter */ template void ScalarRegionBasedLevelSetFunction::UpdatePixel( diff --git a/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.h b/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.h index eb367dad740..9c50e6b39e8 100644 --- a/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.h +++ b/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.h @@ -70,7 +70,11 @@ class ITK_TEMPLATE_EXPORT RegistrationParameterScalesFromJacobian : public Regis using typename Superclass::JacobianType; using typename Superclass::VirtualImageConstPointer; - /** Estimate parameter scales. */ + /** Estimate parameter scales from average Jacobian norms. + * For each parameter, compute the squared norm of its transform Jacobian, + * then average the squared norm over the sample points. This average is + * used as the scale of this parameter. + */ void EstimateScales(ScalesType & parameterScales) override; @@ -94,7 +98,10 @@ class ITK_TEMPLATE_EXPORT RegistrationParameterScalesFromJacobian : public Regis FloatType EstimateStepScale(const ParametersType & step) override; - /** Estimate the scales of local steps. */ + /** Estimate the scales of local steps. For each voxel, computes the impact + * of a step on its location as in ::EstimateStepScale. Then this impact is + * attributed to the corresponding local parameters. + */ void EstimateLocalStepScales(const ParametersType & step, ScalesType & localStepScales) override; diff --git a/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.hxx b/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.hxx index b1a06a8235e..3f182be90c3 100644 --- a/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.hxx +++ b/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesFromJacobian.hxx @@ -22,11 +22,6 @@ namespace itk { -/** Compute parameter scales from average jacobian norms. - * For each parameter, compute the squared norm of its transform Jacobian, - * then average the squared norm over the sample points. This average is - * used as the scale of this parameter. - */ template void RegistrationParameterScalesFromJacobian::EstimateScales(ScalesType & parameterScales) @@ -66,9 +61,6 @@ RegistrationParameterScalesFromJacobian::EstimateScales(ScalesType & pa } } -/** - * Compute the scale for a STEP, the impact of a STEP on the transform. - */ template auto RegistrationParameterScalesFromJacobian::EstimateStepScale(const ParametersType & step) -> FloatType @@ -92,11 +84,6 @@ RegistrationParameterScalesFromJacobian::EstimateStepScale(const Parame return scaleSum / numSamples; } -/** - * Estimate the scales of local steps. For each voxel, we compute the impact - * of a STEP on its location as in EstimateStepScale. Then we attribute this - * impact to the corresponding local parameters. - */ template void RegistrationParameterScalesFromJacobian::EstimateLocalStepScales(const ParametersType & step, @@ -132,10 +119,6 @@ RegistrationParameterScalesFromJacobian::EstimateLocalStepScales(const } } -/** - * Compute the step scales for samples, i.e. the impacts on each sampled - * voxel from a change on the transform. - */ template void RegistrationParameterScalesFromJacobian::ComputeSampleStepScales(const ParametersType & step, @@ -191,7 +174,6 @@ RegistrationParameterScalesFromJacobian::ComputeSampleStepScales(const } } -/** Print the information about this class */ template void RegistrationParameterScalesFromJacobian::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.h b/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.h index eb3f8933150..d04c701e6c6 100644 --- a/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.h +++ b/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.h @@ -185,7 +185,7 @@ class ITK_TEMPLATE_EXPORT ESMDemonsRegistrationFunction return global; } - /** Release memory for global data structure. */ + /** Update the metric and release memory for the per-thread-global data structure. */ void ReleaseGlobalDataPointer(void * gd) const override; @@ -193,8 +193,8 @@ class ITK_TEMPLATE_EXPORT ESMDemonsRegistrationFunction void InitializeIteration() override; - /** This method is called by a finite difference solver image filter at - * each pixel that does not lie on a data set boundary */ + /** Compute update at a non-boundary neighbourhood. Called by a finite difference solver image filter at + * each pixel that does not lie on a data set boundary. */ PixelType ComputeUpdate(const NeighborhoodType & it, void * gd, const FloatOffsetType & offset = FloatOffsetType(0.0)) override; diff --git a/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.hxx b/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.hxx index c992fb370cc..76f409ac51c 100644 --- a/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.hxx +++ b/Modules/Registration/PDEDeformable/include/itkESMDemonsRegistrationFunction.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Default constructor - */ + template ESMDemonsRegistrationFunction::ESMDemonsRegistrationFunction() { @@ -74,9 +72,6 @@ ESMDemonsRegistrationFunction::ES m_SumOfSquaredChange = 0.0; } -/* - * Standard "PrintSelf" method. - */ template void ESMDemonsRegistrationFunction::PrintSelf(std::ostream & os, @@ -133,9 +128,6 @@ ESMDemonsRegistrationFunction::Ge return m_IntensityDifferenceThreshold; } -/** - * Set the function state values before each iteration - */ template void ESMDemonsRegistrationFunction::InitializeIteration() @@ -189,9 +181,6 @@ ESMDemonsRegistrationFunction::In m_SumOfSquaredChange = 0.0; } -/** - * Compute update at a non boundary neighbourhood - */ template typename ESMDemonsRegistrationFunction::PixelType ESMDemonsRegistrationFunction::ComputeUpdate( @@ -431,9 +420,6 @@ ESMDemonsRegistrationFunction::Co return update; } -/** - * Update the metric and release the per-thread-global data. - */ template void ESMDemonsRegistrationFunction::ReleaseGlobalDataPointer(void * gd) const