diff --git a/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.h b/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.h index e9811d4fde4..1fb93fb855a 100644 --- a/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.h +++ b/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.h @@ -69,7 +69,9 @@ class ITK_TEMPLATE_EXPORT ImageToVTKImageFilter : public ProcessObject using ExporterFilterPointer = typename ExporterFilterType::Pointer; /** Get the output in the form of a vtkImage. - This call is delegated to the internal vtkImageImport filter */ + * + * This call is delegated to the internal vtkImageImport filter. + */ vtkImageData * GetOutput() const; @@ -81,22 +83,24 @@ class ITK_TEMPLATE_EXPORT ImageToVTKImageFilter : public ProcessObject GetInput(); /** Return the internal VTK image importer filter. - This is intended to facilitate users the access - to methods in the importer */ + * + * Intended to facilitate users the access to methods in the importer. + */ vtkImageImport * GetImporter() const; /** Return the internal ITK image exporter filter. - This is intended to facilitate users the access - to methods in the exporter */ + * + * Intended to facilitate users the access to methods in the exporter. + */ ExporterFilterType * GetExporter() const; - /** This call delegates the update to the importer */ + /** This call delegates the update to the importer. */ void Update() override; - /** This call delegates the update to the importer */ + /** This call delegates the update to the importer. */ void UpdateLargestPossibleRegion() override; diff --git a/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.hxx b/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.hxx index b5cea3f329b..638ed976e88 100644 --- a/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.hxx +++ b/Modules/Bridge/VtkGlue/include/itkImageToVTKImageFilter.hxx @@ -22,9 +22,6 @@ namespace itk { -/** - * Constructor - */ template ImageToVTKImageFilter::ImageToVTKImageFilter() { @@ -48,9 +45,6 @@ ImageToVTKImageFilter::ImageToVTKImageFilter() m_Importer->SetCallbackUserData(m_Exporter->GetCallbackUserData()); } -/** - * Destructor - */ template ImageToVTKImageFilter::~ImageToVTKImageFilter() { @@ -61,9 +55,6 @@ ImageToVTKImageFilter::~ImageToVTKImageFilter() } } -/** - * Set an itk::Image as input - */ template void ImageToVTKImageFilter::SetInput(const InputImageType * inputImage) @@ -78,9 +69,6 @@ ImageToVTKImageFilter::GetInput() -> InputImageType * return m_Exporter->GetInput(); } -/** - * Get a vtkImage as output - */ template vtkImageData * ImageToVTKImageFilter::GetOutput() const @@ -88,9 +76,6 @@ ImageToVTKImageFilter::GetOutput() const return m_Importer->GetOutput(); } -/** - * Get the importer filter - */ template vtkImageImport * ImageToVTKImageFilter::GetImporter() const @@ -98,9 +83,6 @@ ImageToVTKImageFilter::GetImporter() const return m_Importer; } -/** - * Get the exporter filter - */ template auto ImageToVTKImageFilter::GetExporter() const -> ExporterFilterType * @@ -108,9 +90,6 @@ ImageToVTKImageFilter::GetExporter() const -> ExporterFilterType * return m_Exporter.GetPointer(); } -/** - * Delegate the Update to the importer - */ template void ImageToVTKImageFilter::Update() @@ -118,9 +97,6 @@ ImageToVTKImageFilter::Update() m_Importer->Update(); } -/** - * Delegate the UpdateLargestPossibleRegion to the importer - */ template void ImageToVTKImageFilter::UpdateLargestPossibleRegion() diff --git a/Modules/Bridge/VtkGlue/include/itkVTKImageToImageFilter.h b/Modules/Bridge/VtkGlue/include/itkVTKImageToImageFilter.h index 64f8159167d..c61e6fc6710 100644 --- a/Modules/Bridge/VtkGlue/include/itkVTKImageToImageFilter.h +++ b/Modules/Bridge/VtkGlue/include/itkVTKImageToImageFilter.h @@ -69,21 +69,22 @@ class ITK_TEMPLATE_EXPORT VTKImageToImageFilter : public VTKImageImport VTKImageToImageFilter::VTKImageToImageFilter() { @@ -51,9 +48,6 @@ VTKImageToImageFilter::VTKImageToImageFilter() this->SetCallbackUserData(m_Exporter->GetCallbackUserData()); } -/** - * Destructor - */ template VTKImageToImageFilter::~VTKImageToImageFilter() { @@ -64,9 +58,6 @@ VTKImageToImageFilter::~VTKImageToImageFilter() } } -/** - * Set a vtkImageData as input - */ template void VTKImageToImageFilter::SetInput(vtkImageData * inputImage) @@ -78,9 +69,6 @@ VTKImageToImageFilter::SetInput(vtkImageData * inputImage) #endif } -/** - * Get the exporter filter - */ template vtkImageExport * VTKImageToImageFilter::GetExporter() const @@ -88,9 +76,6 @@ VTKImageToImageFilter::GetExporter() const return m_Exporter; } -/** - * Get the importer filter - */ template auto VTKImageToImageFilter::GetImporter() const -> const Superclass * diff --git a/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.h b/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.h index 35dbf322835..6caeb3ac1ef 100644 --- a/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.h +++ b/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.h @@ -41,15 +41,15 @@ class ITK_TEMPLATE_EXPORT ChildTreeIterator : public TreeIteratorBase /** Constructor */ ChildTreeIterator(const TreeIteratorBase & iterator); - /** Get the type of the iterator */ + /** Get the type of the iterator. */ NodeType GetType() const override; - /** Go to a specific child node */ + /** Go to a specific child node. */ bool GoToChild(ChildIdentifier number = 0) override; - /** Go to a parent node */ + /** Go to the parent node. */ bool GoToParent() override; @@ -72,11 +72,11 @@ class ITK_TEMPLATE_EXPORT ChildTreeIterator : public TreeIteratorBase } protected: - /** Get the next value */ + /** Get the next node. */ const ValueType & Next() override; - /** Return true if the next value exists */ + /** Return true if the next node exists. */ bool HasNext() const override; diff --git a/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.hxx b/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.hxx index e1b3aee473b..aa1d9bfa861 100644 --- a/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.hxx +++ b/Modules/Compatibility/Deprecated/include/itkChildTreeIterator.hxx @@ -22,7 +22,6 @@ namespace itk { -/** Constructor */ template ChildTreeIterator::ChildTreeIterator(TTreeType * tree, const TreeNodeType * start) : TreeIteratorBase(tree, start) @@ -42,7 +41,6 @@ ChildTreeIterator::ChildTreeIterator(const TreeIteratorBasem_Position = m_ParentNode->GetChild(m_ListPosition); } -/** Go to a specific child */ template bool ChildTreeIterator::GoToChild(ChildIdentifier number) @@ -59,7 +57,6 @@ ChildTreeIterator::GoToChild(ChildIdentifier number) return true; } -/** Go to the parent node */ template bool ChildTreeIterator::GoToParent() @@ -78,7 +75,6 @@ ChildTreeIterator::GoToParent() return true; } -/** Return the type of the iterator */ template auto ChildTreeIterator::GetType() const -> NodeType @@ -86,7 +82,6 @@ ChildTreeIterator::GetType() const -> NodeType return TreeIteratorBaseEnums::TreeIteratorBaseNode::CHILD; } -/** Return true if the next node exists */ template bool ChildTreeIterator::HasNext() const @@ -101,7 +96,6 @@ ChildTreeIterator::HasNext() const } } -/** Return the next node */ template auto ChildTreeIterator::Next() -> const ValueType & @@ -115,7 +109,6 @@ ChildTreeIterator::Next() -> const ValueType & return this->m_Position->Get(); } -/** Clone function */ template TreeIteratorBase * ChildTreeIterator::Clone() diff --git a/Modules/Compatibility/Deprecated/include/itkLevelOrderTreeIterator.h b/Modules/Compatibility/Deprecated/include/itkLevelOrderTreeIterator.h index 2a66ae9930d..28e4bb2fc49 100644 --- a/Modules/Compatibility/Deprecated/include/itkLevelOrderTreeIterator.h +++ b/Modules/Compatibility/Deprecated/include/itkLevelOrderTreeIterator.h @@ -45,28 +45,28 @@ class ITK_TEMPLATE_EXPORT LevelOrderTreeIterator : public TreeIteratorBase * Clone() override; @@ -85,21 +85,24 @@ class ITK_TEMPLATE_EXPORT LevelOrderTreeIterator : public TreeIteratorBase LevelOrderTreeIterator::LevelOrderTreeIterator(TTreeType * tree, int endLevel, const TreeNodeType * start) : TreeIteratorBase(tree, start) @@ -44,7 +44,6 @@ LevelOrderTreeIterator::LevelOrderTreeIterator(TTreeType * tree, int this->m_Begin = this->m_Position; } -/** Constructor with end level specification */ template LevelOrderTreeIterator::LevelOrderTreeIterator(TTreeType * tree, int startLevel, @@ -70,7 +69,6 @@ LevelOrderTreeIterator::LevelOrderTreeIterator(TTreeType * t this->m_Begin = this->m_Position; } -/** Return the type of iterator */ template auto LevelOrderTreeIterator::GetType() const -> NodeType @@ -78,7 +76,6 @@ LevelOrderTreeIterator::GetType() const -> NodeType return TreeIteratorBaseEnums::TreeIteratorBaseNode::LEVELORDER; } -/** Return true if the next value exists */ template bool LevelOrderTreeIterator::HasNext() const @@ -90,7 +87,6 @@ LevelOrderTreeIterator::HasNext() const return false; } -/** Return the next node */ template auto LevelOrderTreeIterator::Next() -> const ValueType & @@ -103,7 +99,6 @@ LevelOrderTreeIterator::Next() -> const ValueType & return this->m_Position->Get(); } -/** Get the start Level */ template int LevelOrderTreeIterator::GetStartLevel() const @@ -111,7 +106,6 @@ LevelOrderTreeIterator::GetStartLevel() const return m_StartLevel; } -/** Get the end level */ template int LevelOrderTreeIterator::GetEndLevel() const @@ -119,7 +113,6 @@ LevelOrderTreeIterator::GetEndLevel() const return m_EndLevel; } -/** Find the next available node */ template auto LevelOrderTreeIterator::FindNextNode() const -> const TreeNodeType * @@ -144,7 +137,6 @@ LevelOrderTreeIterator::FindNextNode() const -> const TreeNodeType * return node; } -/** Return the current level */ template int LevelOrderTreeIterator::GetLevel() const @@ -164,7 +156,6 @@ LevelOrderTreeIterator::GetLevel() const return level; } -/** Return the level given a node */ template int LevelOrderTreeIterator::GetLevel(const TreeNodeType * node) const @@ -183,7 +174,6 @@ LevelOrderTreeIterator::GetLevel(const TreeNodeType * node) const return level; } -/** Helper function to find the next node */ template auto LevelOrderTreeIterator::FindNextNodeHelp() const -> const TreeNodeType * @@ -220,7 +210,6 @@ LevelOrderTreeIterator::FindNextNodeHelp() const -> const TreeNodeTyp return currentNode; } -/** Clone function */ template TreeIteratorBase * LevelOrderTreeIterator::Clone() diff --git a/Modules/Compatibility/Deprecated/include/itkTreeContainer.h b/Modules/Compatibility/Deprecated/include/itkTreeContainer.h index fc0fef6635f..17455b22a6e 100644 --- a/Modules/Compatibility/Deprecated/include/itkTreeContainer.h +++ b/Modules/Compatibility/Deprecated/include/itkTreeContainer.h @@ -56,64 +56,64 @@ class ITK_TEMPLATE_EXPORT TreeContainer : public TreeContainerBase /** Run-time type information (and related methods). */ itkTypeMacro(TreeContainer, TreeContainerBase); - /** Constructor */ + /** Constructor with default children count. */ TreeContainer(int defaultChildrenCount); - /** Constructor */ + /** Constructor by adding a tree. */ TreeContainer(TreeContainer & tree); - /** Set the root as an element */ + /** Set the specified element as the root. */ bool SetRoot(const TValue element) override; - /** The the root as an iterator position */ + /** Set the specified iterator position as the root. */ bool SetRoot(IteratorType & pos); - /** Set the root as a tree node */ + /** Set the specified tree node as the root. */ bool SetRoot(TreeNode * node) override; - /** Return true if the element is in the tree */ + /** Return true if the element is in the tree. */ bool Contains(const TValue element) override; - /** Return the number of elements in the tree */ + /** Return the number of elements in the tree. */ int Count() const override; - /** Return true if the element is a leaf */ + /** Return true if the node containing the given element is a leaf of the tree. */ bool IsLeaf(const TValue element) override; - /** Return true if the element is a root */ + /** Return true if the node containing the given element is the root. */ bool IsRoot(const TValue element) override; - /** Clear the tree */ + /** Clear the tree. */ bool Clear() override; - /** operator equal */ + /** operator equal. */ bool operator==(TreeContainer & tree); - /** Swap the iterators */ + /** Swap the iterators. */ bool Swap(IteratorType & v, IteratorType & w); - /** Get the root */ + /** Get the root. */ const TreeNodeType * GetRoot() const override { return m_Root.GetPointer(); } - /** Add a child to a given parent using values */ + /** Add a child to a given parent. */ bool Add(const TValue child, const TValue parent); - /** Get node given a value */ + /** Get the node corresponding to the given a value. */ const TreeNodeType * GetNode(TValue val) const; diff --git a/Modules/Compatibility/Deprecated/include/itkTreeContainer.hxx b/Modules/Compatibility/Deprecated/include/itkTreeContainer.hxx index 758c0e302d2..9fcdabef877 100644 --- a/Modules/Compatibility/Deprecated/include/itkTreeContainer.hxx +++ b/Modules/Compatibility/Deprecated/include/itkTreeContainer.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template TreeContainer::TreeContainer() { @@ -30,7 +30,6 @@ TreeContainer::TreeContainer() m_DefaultChildrenCount = 2; } -/** Constructor with default children count */ template TreeContainer::TreeContainer(int dcc) { @@ -39,7 +38,6 @@ TreeContainer::TreeContainer(int dcc) m_DefaultChildrenCount = dcc; } -/** Constructor by adding a tree */ template TreeContainer::TreeContainer(TreeContainer &) { @@ -48,7 +46,6 @@ TreeContainer::TreeContainer(TreeContainer &) m_DefaultChildrenCount = 3; } -/** Set the root of the tree */ template bool TreeContainer::SetRoot(const TValue element) @@ -59,7 +56,6 @@ TreeContainer::SetRoot(const TValue element) return true; } -/** Set the root of the tree */ template bool TreeContainer::SetRoot(TreeNode * node) @@ -68,7 +64,6 @@ TreeContainer::SetRoot(TreeNode * node) return true; } -/** Count the number of nodes in the tree */ template int TreeContainer::Count() const @@ -88,7 +83,6 @@ TreeContainer::Count() const return size; } -/** Swap the iterators */ template bool TreeContainer::Swap(IteratorType & v, IteratorType & w) @@ -129,7 +123,6 @@ TreeContainer::Swap(IteratorType & v, IteratorType & w) return true; } -/** Return true if the tree contains this element */ template bool TreeContainer::Contains(const TValue element) @@ -147,7 +140,6 @@ TreeContainer::Contains(const TValue element) return false; } -/** Equal operator */ template bool TreeContainer::operator==(TreeContainer & tree) @@ -170,7 +162,6 @@ TreeContainer::operator==(TreeContainer & tree) return true; } -/** Return true if the given element is a leaf of the tree */ template bool TreeContainer::IsLeaf(TValue element) @@ -194,7 +185,6 @@ TreeContainer::IsLeaf(TValue element) return false; } -/** Return true of the node containing the element is the root */ template bool TreeContainer::IsRoot(TValue element) @@ -219,7 +209,6 @@ TreeContainer::IsRoot(TValue element) return false; } -/** Clear the tree */ template bool TreeContainer::Clear() @@ -230,7 +219,6 @@ TreeContainer::Clear() return success; } -/** Get node given a value */ template const TreeNode * TreeContainer::GetNode(TValue val) const @@ -248,7 +236,6 @@ TreeContainer::GetNode(TValue val) const return nullptr; } -/** Set the root of the tree from the iterator position */ template bool TreeContainer::SetRoot(IteratorType & pos) @@ -291,7 +278,6 @@ TreeContainer::SetRoot(IteratorType & pos) return true; } -/** Add a child to a given parent */ template bool TreeContainer::Add(const TValue child, const TValue parent) @@ -316,7 +302,6 @@ TreeContainer::Add(const TValue child, const TValue parent) return false; } -/** Print self */ template void TreeContainer::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.h b/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.h index 8e65994e16f..65384dcebdb 100644 --- a/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.h +++ b/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.h @@ -89,27 +89,30 @@ class ITK_TEMPLATE_EXPORT TreeIteratorBase static constexpr NodeType LEAF = NodeType::LEAF; #endif - /** Add an element to the tree */ + /** Add an element to the tree at the current node. + * + * Creates a new child node. + */ virtual bool Add(ValueType element); - /** Add an element at a given position */ + /** Add an element to the tree at a given position. */ virtual bool Add(int position, ValueType element); - /** Add a subtree */ + /** Add a subtree. */ virtual bool Add(TTreeType & subTree); - /** Get a value */ + /** Get the value of the current node. */ virtual const ValueType & Get() const; - /** Get the subtree */ + /** Get the subtree. */ virtual TTreeType * GetSubTree() const; - /** Return true if the current node is a leaf */ + /** Return true if the current node is a leaf. */ virtual bool IsLeaf() const; @@ -121,85 +124,88 @@ class ITK_TEMPLATE_EXPORT TreeIteratorBase virtual NodeType GetType() const = 0; - /** Go to the specified child */ + /** Go to the specified child. */ virtual bool GoToChild(ChildIdentifier number = 0); - /** Go to the parent */ + /** Go to the parent of the current node. */ virtual bool GoToParent(); - /** Set the current value of the node */ + /** Set the specified value to the current node. */ void Set(ValueType element); - /** Return true if the current node has a child */ + /** Return true if the current node has a child. */ virtual bool HasChild(int number = 0) const; - /** Return the current ChildPosition of an element */ + /** Return the current child position of an element. */ virtual int ChildPosition(ValueType element) const; - /** Remove a child */ + /** Remove a child. + * + * Removes its child nodes as well. + * / virtual bool RemoveChild(int number); - /** Count the number of children */ + /** Count the number of children. */ virtual int CountChildren() const; - /** Return true if the current node has a parent */ + /** Return true if the current node has a parent. */ virtual bool HasParent() const; - /** Disconnect the tree */ + /** Disconnect the tree. */ virtual bool Disconnect(); - /** Return a list of children */ + /** Return a list of children. */ virtual TreeIteratorBase * Children(); - /** Return a list of parents */ + /** Return the list of parents. */ virtual TreeIteratorBase * Parents(); - /** Return a list of child */ + /** Get the child corresponding to the given a number at the current node. */ virtual TreeIteratorBase * GetChild(int number) const; - /** Count the number of nodes */ + /** Count the number of nodes. */ virtual int Count(); - /** Remove the current node from the tree */ + /** Remove the current node from the tree. */ bool Remove(); - /** Get the current node */ + /** Get the current node. */ virtual TreeNodeType * GetNode(); virtual const TreeNodeType * GetNode() const; - /** Get the root */ + /** Get the root. */ TreeNodeType * GetRoot(); const TreeNodeType * GetRoot() const; - /** Get the tree */ + /** Get the tree. */ TTreeType * GetTree() const; - /** Return the first parent found */ + /** Return the first parent found. */ const TreeNodeType * GetParent() const; - /** Move an iterator to the beginning of the tree */ + /** Move an iterator to the beginning of the tree. */ void GoToBegin() { diff --git a/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.hxx b/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.hxx index 30e52f090cb..5f4a77a4007 100644 --- a/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.hxx +++ b/Modules/Compatibility/Deprecated/include/itkTreeIteratorBase.hxx @@ -37,7 +37,7 @@ class ITK_TEMPLATE_EXPORT TreeRemoveEvent; namespace itk { -/** Constructor */ + template TreeIteratorBase::TreeIteratorBase(TTreeType * tree, const TreeNodeType * start) { @@ -55,7 +55,6 @@ TreeIteratorBase::TreeIteratorBase(TTreeType * tree, const TreeNodeTy m_Begin = m_Position; } -/** Constructor */ template TreeIteratorBase::TreeIteratorBase(const TTreeType * tree, const TreeNodeType * start) { @@ -72,7 +71,6 @@ TreeIteratorBase::TreeIteratorBase(const TTreeType * tree, const Tree m_Begin = m_Position; } -/** Return the current value of the node */ template auto TreeIteratorBase::Get() const -> const ValueType & @@ -80,7 +78,6 @@ TreeIteratorBase::Get() const -> const ValueType & return m_Position->Get(); } -/** Set the current value of the node */ template void TreeIteratorBase::Set(ValueType element) @@ -91,7 +88,6 @@ TreeIteratorBase::Set(ValueType element) m_Tree->InvokeEvent(TreeNodeChangeEvent(*this)); } -/** Add a value to the node. This creates a new child node */ template bool TreeIteratorBase::Add(ValueType element) @@ -126,7 +122,6 @@ TreeIteratorBase::Add(ValueType element) return true; } -/** Add a new element at a given position */ template bool TreeIteratorBase::Add(int itkNotUsed(childPosition), ValueType element) @@ -150,7 +145,6 @@ TreeIteratorBase::Add(int itkNotUsed(childPosition), ValueType elemen return false; } -/** Return true if the current pointed node is a leaf */ template bool TreeIteratorBase::IsLeaf() const @@ -158,7 +152,6 @@ TreeIteratorBase::IsLeaf() const return !(m_Position->HasChildren()); } -/** Return true if the current pointed node is a root */ template bool TreeIteratorBase::IsRoot() const @@ -175,7 +168,6 @@ TreeIteratorBase::IsRoot() const return false; } -/** Add a subtree */ template bool TreeIteratorBase::Add(TTreeType & subTree) @@ -205,7 +197,6 @@ TreeIteratorBase::Add(TTreeType & subTree) return true; } -/** Return the subtree */ template TTreeType * TreeIteratorBase::GetSubTree() const @@ -216,7 +207,6 @@ TreeIteratorBase::GetSubTree() const return tree; } -/** Return true of the current node has a child */ template bool TreeIteratorBase::HasChild(int number) const @@ -232,7 +222,6 @@ TreeIteratorBase::HasChild(int number) const return false; } -/** Return the current position of the child */ template int TreeIteratorBase::ChildPosition(ValueType element) const @@ -244,7 +233,6 @@ TreeIteratorBase::ChildPosition(ValueType element) const return m_Position->ChildPosition(element); } -/** Remove a child */ template bool TreeIteratorBase::RemoveChild(int number) @@ -272,7 +260,6 @@ TreeIteratorBase::RemoveChild(int number) return false; } -/** Count the number of children */ template int TreeIteratorBase::CountChildren() const @@ -284,7 +271,6 @@ TreeIteratorBase::CountChildren() const return m_Position->CountChildren(); } -/** Return true of the pointed node has a parent */ template bool TreeIteratorBase::HasParent() const @@ -292,7 +278,6 @@ TreeIteratorBase::HasParent() const return (m_Position != nullptr && m_Position->GetParent() != nullptr); } -/** Disconnect the tree */ template bool TreeIteratorBase::Disconnect() @@ -329,7 +314,6 @@ TreeIteratorBase::Disconnect() return true; } -/** Return the children list */ template TreeIteratorBase * TreeIteratorBase::Children() @@ -340,7 +324,6 @@ TreeIteratorBase::Children() return nullptr; } -/** Return the first parent found */ template auto TreeIteratorBase::GetParent() const -> const TreeNodeType * @@ -353,7 +336,6 @@ TreeIteratorBase::GetParent() const -> const TreeNodeType * return m_Position->GetParent(); } -/** Return the list of parents */ template TreeIteratorBase * TreeIteratorBase::Parents() @@ -364,7 +346,6 @@ TreeIteratorBase::Parents() return nullptr; } -/** Go to a child */ template bool TreeIteratorBase::GoToChild(ChildIdentifier number) @@ -384,7 +365,6 @@ TreeIteratorBase::GoToChild(ChildIdentifier number) return true; } -/** Go to a parent */ template bool TreeIteratorBase::GoToParent() @@ -403,7 +383,6 @@ TreeIteratorBase::GoToParent() return true; } -/** Get a child given a number */ template TreeIteratorBase * TreeIteratorBase::GetChild(int number) const @@ -424,7 +403,6 @@ TreeIteratorBase::GetChild(int number) const return nullptr; } -/** Count the number of nodes from the beginning */ template int TreeIteratorBase::Count() @@ -443,7 +421,6 @@ TreeIteratorBase::Count() return size; } -/** Get the node pointed by the iterator */ template auto TreeIteratorBase::GetNode() -> TreeNodeType * @@ -451,7 +428,6 @@ TreeIteratorBase::GetNode() -> TreeNodeType * return const_cast(m_Position); } -/** Get the node pointed by the iterator */ template auto TreeIteratorBase::GetNode() const -> const TreeNodeType * @@ -459,7 +435,6 @@ TreeIteratorBase::GetNode() const -> const TreeNodeType * return m_Position; } -/** Get the root */ template auto TreeIteratorBase::GetRoot() -> TreeNodeType * @@ -467,7 +442,6 @@ TreeIteratorBase::GetRoot() -> TreeNodeType * return const_cast(m_Root); } -/** Get the root (const) */ template auto TreeIteratorBase::GetRoot() const -> const TreeNodeType * @@ -475,7 +449,6 @@ TreeIteratorBase::GetRoot() const -> const TreeNodeType * return m_Root; } -/** Remove a specific node (and its child nodes!) */ template bool TreeIteratorBase::Remove() @@ -519,7 +492,6 @@ TreeIteratorBase::Remove() return true; } -/** Return the tree */ template TTreeType * TreeIteratorBase::GetTree() const diff --git a/Modules/Compatibility/Deprecated/include/itkVectorCentralDifferenceImageFunction.hxx b/Modules/Compatibility/Deprecated/include/itkVectorCentralDifferenceImageFunction.hxx index 1908e94d0b5..3eb62ff6925 100644 --- a/Modules/Compatibility/Deprecated/include/itkVectorCentralDifferenceImageFunction.hxx +++ b/Modules/Compatibility/Deprecated/include/itkVectorCentralDifferenceImageFunction.hxx @@ -21,18 +21,13 @@ namespace itk { -/** - * Constructor - */ + template VectorCentralDifferenceImageFunction::VectorCentralDifferenceImageFunction() { this->m_UseImageDirection = true; } -/** - * - */ template void VectorCentralDifferenceImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -41,9 +36,6 @@ VectorCentralDifferenceImageFunction::PrintSelf(std::ost os << indent << "UseImageDirection = " << this->m_UseImageDirection << std::endl; } -/** - * - */ template auto VectorCentralDifferenceImageFunction::EvaluateAtIndex(const IndexType & index) const diff --git a/Modules/Core/Common/include/itkArray.h b/Modules/Core/Common/include/itkArray.h index 24870d3a452..ce2d0bcf563 100644 --- a/Modules/Core/Common/include/itkArray.h +++ b/Modules/Core/Common/include/itkArray.h @@ -55,11 +55,11 @@ class ITK_TEMPLATE_EXPORT Array : public vnl_vector public: /** Default constructor. It is created with an empty array - * it has to be allocated later by assignment */ + * it has to be allocated later by assignment */ Array(); /** Copy constructor. Uses VNL copy constructor with correct - * setting for memory management. */ + * setting for memory management. */ Array(const Array &); /** Construct from a VnlVectorType */ diff --git a/Modules/Core/Common/include/itkArray.hxx b/Modules/Core/Common/include/itkArray.hxx index 2f7cd4f4e2c..6ba3e26c668 100644 --- a/Modules/Core/Common/include/itkArray.hxx +++ b/Modules/Core/Common/include/itkArray.hxx @@ -22,13 +22,13 @@ namespace itk { -/** Default constructor */ + template Array::Array() : vnl_vector() {} -/** Copy constructor */ + template Array::Array(const Self & rhs) : vnl_vector(rhs) @@ -43,7 +43,7 @@ Array::Array(const VnlVectorType & rhs) // no matter the setting of let array manage memory of rhs {} -/** Constructor with size */ + template Array::Array(SizeValueType dimension) : vnl_vector(dimension) @@ -51,13 +51,11 @@ Array::Array(SizeValueType dimension) // no matter the setting of let array manage memory of rhs {} -/** Constructor with size and initial value for each element. */ template Array::Array(const SizeValueType dimension, const TValue & value) : vnl_vector(dimension, value) {} -/** Constructor with user specified data */ template Array::Array(ValueType * datain, SizeValueType sz, bool LetArrayManageMemory) : m_LetArrayManageMemory(LetArrayManageMemory) @@ -67,7 +65,6 @@ Array::Array(ValueType * datain, SizeValueType sz, bool LetArrayManageMe } #if defined(ITK_LEGACY_REMOVE) -/** Constructor with user specified const data */ template Array::Array(const ValueType * datain, SizeValueType sz) : vnl_vector(datain, sz) @@ -76,7 +73,6 @@ Array::Array(const ValueType * datain, SizeValueType sz) {} #else // defined ( ITK_LEGACY_REMOVE ) -/** Constructor with user specified const data */ template Array::Array(const ValueType * datain, SizeValueType sz, bool /* LetArrayManageMemory */) : /* NOTE: The 3rd argument "LetArrayManageMemory, was never valid to use, but is @@ -87,8 +83,6 @@ Array::Array(const ValueType * datain, SizeValueType sz, bool /* LetArra {} #endif - -/** Destructor */ template Array::~Array() { diff --git a/Modules/Core/Common/include/itkArray2D.hxx b/Modules/Core/Common/include/itkArray2D.hxx index e99c2083d31..e9a1a3c260f 100644 --- a/Modules/Core/Common/include/itkArray2D.hxx +++ b/Modules/Core/Common/include/itkArray2D.hxx @@ -22,25 +22,21 @@ namespace itk { -/** Constructor with number of rows and columns as arguments */ template Array2D::Array2D(unsigned int numberOfRows, unsigned int numberOfCols) : vnl_matrix(numberOfRows, numberOfCols) {} -/** Constructor from a vnl_matrix */ template Array2D::Array2D(const VnlMatrixType & matrix) : vnl_matrix(matrix) {} -/** Copy Constructor */ template Array2D::Array2D(const Self & array) : vnl_matrix(array) {} -/** Assignment Operator from Array */ template Array2D & Array2D::operator=(const Self & array) @@ -49,7 +45,6 @@ Array2D::operator=(const Self & array) return *this; } -/** Assignment Operator from vnl_matrix */ template Array2D & Array2D::operator=(const VnlMatrixType & matrix) @@ -58,7 +53,6 @@ Array2D::operator=(const VnlMatrixType & matrix) return *this; } -/** Set the size of the array */ template void Array2D::SetSize(unsigned int m, unsigned int n) diff --git a/Modules/Core/Common/include/itkAutoPointerDataObjectDecorator.hxx b/Modules/Core/Common/include/itkAutoPointerDataObjectDecorator.hxx index f126fa5b3a8..f0bc747ed76 100644 --- a/Modules/Core/Common/include/itkAutoPointerDataObjectDecorator.hxx +++ b/Modules/Core/Common/include/itkAutoPointerDataObjectDecorator.hxx @@ -32,7 +32,6 @@ namespace itk { -/** Set value */ template void AutoPointerDataObjectDecorator::Set(T * val) @@ -46,7 +45,6 @@ AutoPointerDataObjectDecorator::Set(T * val) } } -/** PrintSelf method */ template void AutoPointerDataObjectDecorator::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Common/include/itkCorrespondenceDataStructureIterator.hxx b/Modules/Core/Common/include/itkCorrespondenceDataStructureIterator.hxx index dde57957121..51bd4f3f714 100644 --- a/Modules/Core/Common/include/itkCorrespondenceDataStructureIterator.hxx +++ b/Modules/Core/Common/include/itkCorrespondenceDataStructureIterator.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor. Initializes iterators, pointers, and m_IsAtEnd. */ + template CorrespondenceDataStructureIterator::CorrespondenceDataStructureIterator(TStructureType * StructurePtr) { @@ -44,8 +44,6 @@ CorrespondenceDataStructureIterator::IsAtEnd() const return m_IsAtEnd; } -/** Goes to the next corresponding node clique in the structure, - * moving on to the next base node clique if necessary. */ template void CorrespondenceDataStructureIterator::GoToNext() @@ -58,7 +56,6 @@ CorrespondenceDataStructureIterator::GoToNext() } } -/** Goes to the next base node clique. */ template void CorrespondenceDataStructureIterator::GoToNextBaseGroup() @@ -88,7 +85,6 @@ CorrespondenceDataStructureIterator::GoToNextBaseGroup() } } -/** Resets the iterator to the default settings/placement.*/ template void CorrespondenceDataStructureIterator::Reset() diff --git a/Modules/Core/Common/include/itkDiffusionTensor3D.h b/Modules/Core/Common/include/itkDiffusionTensor3D.h index 05b1f21524b..bdbd3488184 100644 --- a/Modules/Core/Common/include/itkDiffusionTensor3D.h +++ b/Modules/Core/Common/include/itkDiffusionTensor3D.h @@ -131,7 +131,20 @@ class ITK_TEMPLATE_EXPORT DiffusionTensor3D : public SymmetricSecondRankTensor DiffusionTensor3D::DiffusionTensor3D(const Superclass & r) : SymmetricSecondRankTensor(r) {} -/** - * Constructor with initialization - */ template DiffusionTensor3D::DiffusionTensor3D(const ComponentType & r) : SymmetricSecondRankTensor(r) {} -/** - * Constructor with initialization - */ template DiffusionTensor3D::DiffusionTensor3D(const ComponentArrayType r) : SymmetricSecondRankTensor(r) {} -/** - * Assignment Operator - */ template DiffusionTensor3D & DiffusionTensor3D::operator=(const ComponentType & r) @@ -57,9 +46,6 @@ DiffusionTensor3D::operator=(const ComponentType & r) return *this; } -/** - * Assignment Operator - */ template DiffusionTensor3D & DiffusionTensor3D::operator=(const ComponentArrayType r) @@ -68,9 +54,6 @@ DiffusionTensor3D::operator=(const ComponentArrayType r) return *this; } -/** - * Assignment Operator - */ template DiffusionTensor3D & DiffusionTensor3D::operator=(const Superclass & r) @@ -79,21 +62,6 @@ DiffusionTensor3D::operator=(const Superclass & r) return *this; } -/** - * Get the Trace, specialized version for 3D. - * - * Note that the indices are related to the fact - * that we store only the upper-right triangle of - * the matrix. Like - * - * | 0 1 2 | - * | X 3 4 | - * | X X 5 | - * - * The trace is therefore the sum of the components - * M[0], M[3] and M[5]. - * - */ template auto DiffusionTensor3D::GetTrace() const -> AccumulateValueType @@ -105,9 +73,6 @@ DiffusionTensor3D::GetTrace() const -> AccumulateValueType return trace; } -/** - * Compute the value of fractional anisotropy - */ template auto DiffusionTensor3D::GetFractionalAnisotropy() const -> RealValueType @@ -139,9 +104,6 @@ DiffusionTensor3D::GetFractionalAnisotropy() const -> RealValueType return 0.0; } -/** - * Compute the value of relative anisotropy - */ template auto DiffusionTensor3D::GetRelativeAnisotropy() const -> RealValueType @@ -170,9 +132,6 @@ DiffusionTensor3D::GetRelativeAnisotropy() const -> RealValueType return relativeAnisotropy; } -/** - * Compute the inner scalar product - */ template auto DiffusionTensor3D::GetInnerScalarProduct() const -> RealValueType diff --git a/Modules/Core/Common/include/itkFixedArray.h b/Modules/Core/Common/include/itkFixedArray.h index 347a9135546..92d4feef13d 100644 --- a/Modules/Core/Common/include/itkFixedArray.h +++ b/Modules/Core/Common/include/itkFixedArray.h @@ -194,7 +194,12 @@ class ITK_TEMPLATE_EXPORT FixedArray * \note The other five "special member functions" are defaulted implicitly, following the C++ "Rule of Zero". */ FixedArray() = default; - /** Conversion constructors */ + /** Conversion constructors. + * + * Constructor assumes input points to array of correct size. + * Values are copied individually instead of with a binary copy. This + * allows the ValueType's assignment operator to be executed. + */ FixedArray(const ValueType r[VLength]); FixedArray(const ValueType &); @@ -222,7 +227,12 @@ class ITK_TEMPLATE_EXPORT FixedArray std::copy_n(r, VLength, m_InternalArray); } - /** Operator= defined for a variety of types. */ + /** Operator= defined for a variety of types. + * + * The assignment operator assumes input points to array of correct size. + * Values are copied individually instead of with a binary copy. This + * allows the ValueType's assignment operator to be executed. + */ template FixedArray & operator=(const FixedArray & r) @@ -302,25 +312,32 @@ class ITK_TEMPLATE_EXPORT FixedArray return m_InternalArray; } - /** Get various iterators to the array. */ + /** Get an Iterator for the beginning of the FixedArray. */ Iterator Begin(); + /** Get a ConstIterator for the beginning of the FixedArray. */ ConstIterator Begin() const; + /** Get an Iterator for the end of the FixedArray. */ Iterator End(); + /** Get a ConstIterator for the end of the FixedArray. */ ConstIterator End() const; + /** Get a begin ReverseIterator. */ itkLegacyMacro(ReverseIterator rBegin()); + /** Get a begin ConstReverseIterator. */ itkLegacyMacro(ConstReverseIterator rBegin() const); + /** Get an end ReverseIterator. */ itkLegacyMacro(ReverseIterator rEnd()); + /** Get an end ConstReverseIterator. */ itkLegacyMacro(ConstReverseIterator rEnd() const); constexpr const_iterator @@ -395,7 +412,7 @@ class ITK_TEMPLATE_EXPORT FixedArray return this->crend(); } - /** Size of the container */ + /** Size of the container. */ SizeType Size() const; diff --git a/Modules/Core/Common/include/itkFixedArray.hxx b/Modules/Core/Common/include/itkFixedArray.hxx index 0be05768488..225507b2b0b 100644 --- a/Modules/Core/Common/include/itkFixedArray.hxx +++ b/Modules/Core/Common/include/itkFixedArray.hxx @@ -22,31 +22,19 @@ namespace itk { -/** - * Constructor to initialize entire array to one value. - */ + template FixedArray::FixedArray(const ValueType & r) { std::fill_n(m_InternalArray, VLength, r); } -/** - * Constructor assumes input points to array of correct size. - * Values are copied individually instead of with a binary copy. This - * allows the ValueType's assignment operator to be executed. - */ template FixedArray::FixedArray(const ValueType r[VLength]) { std::copy_n(r, VLength, m_InternalArray); } -/** - * Assignment operator assumes input points to array of correct size. - * Values are copied individually instead of with a binary copy. This - * allows the ValueType's assignment operator to be executed. - */ template FixedArray & FixedArray::operator=(const ValueType r[VLength]) @@ -58,9 +46,6 @@ FixedArray::operator=(const ValueType r[VLength]) return *this; } -/** - * Operator != compares different types of arrays. - */ template bool FixedArray::operator==(const FixedArray & r) const @@ -68,9 +53,6 @@ FixedArray::operator==(const FixedArray & r) const return std::equal(m_InternalArray, m_InternalArray + VLength, r.m_InternalArray); } -/** - * Get an Iterator for the beginning of the FixedArray. - */ template auto FixedArray::Begin() -> Iterator @@ -78,9 +60,6 @@ FixedArray::Begin() -> Iterator return Iterator(m_InternalArray); } -/** - * Get a ConstIterator for the beginning of the FixedArray. - */ template auto FixedArray::Begin() const -> ConstIterator @@ -88,9 +67,6 @@ FixedArray::Begin() const -> ConstIterator return ConstIterator(m_InternalArray); } -/** - * Get an Iterator for the end of the FixedArray. - */ template auto FixedArray::End() -> Iterator @@ -98,9 +74,6 @@ FixedArray::End() -> Iterator return Iterator(m_InternalArray + VLength); } -/** - * Get a ConstIterator for the end of the FixedArray. - */ template auto FixedArray::End() const -> ConstIterator @@ -110,9 +83,6 @@ FixedArray::End() const -> ConstIterator #if !defined(ITK_LEGACY_REMOVE) -/** - * Get a begin ReverseIterator. - */ template auto FixedArray::rBegin() -> ReverseIterator @@ -120,9 +90,6 @@ FixedArray::rBegin() -> ReverseIterator return ReverseIterator(m_InternalArray + VLength); } -/** - * Get a begin ConstReverseIterator. - */ template auto FixedArray::rBegin() const -> ConstReverseIterator @@ -130,9 +97,6 @@ FixedArray::rBegin() const -> ConstReverseIterator return ConstReverseIterator(m_InternalArray + VLength); } -/** - * Get an end ReverseIterator. - */ template auto FixedArray::rEnd() -> ReverseIterator @@ -140,9 +104,6 @@ FixedArray::rEnd() -> ReverseIterator return ReverseIterator(m_InternalArray); } -/** - * Get an end ConstReverseIterator. - */ template auto FixedArray::rEnd() const -> ConstReverseIterator @@ -152,9 +113,6 @@ FixedArray::rEnd() const -> ConstReverseIterator #endif // defined ( ITK_LEGACY_REMOVE ) -/** - * Get the size of the FixedArray. - */ template auto FixedArray::Size() const -> SizeType @@ -162,9 +120,6 @@ FixedArray::Size() const -> SizeType return VLength; } -/** - * Fill all elements of the array with the given value. - */ template void FixedArray::Fill(const ValueType & value) diff --git a/Modules/Core/Common/include/itkImageDuplicator.hxx b/Modules/Core/Common/include/itkImageDuplicator.hxx index 598f8e341d8..2777dae43a3 100644 --- a/Modules/Core/Common/include/itkImageDuplicator.hxx +++ b/Modules/Core/Common/include/itkImageDuplicator.hxx @@ -22,7 +22,7 @@ namespace itk { -/** Constructor */ + template ImageDuplicator::ImageDuplicator() { @@ -31,7 +31,6 @@ ImageDuplicator::ImageDuplicator() m_InternalImageTime = 0; } -/** */ template void ImageDuplicator::Update() diff --git a/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.h b/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.h index fb56bf8e267..0a16854d17d 100644 --- a/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.h +++ b/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.h @@ -204,14 +204,14 @@ class ITK_TEMPLATE_EXPORT ImageRandomConstIteratorWithIndex : public ImageConstI return *this; } - /** Set/Get number of random samples to get from the image region */ + /** Set/Get number of random samples to extract from the image region. */ void SetNumberOfSamples(SizeValueType number); SizeValueType GetNumberOfSamples() const; - /** Reinitialize the seed of the random number generator */ + /** Reinitialize the seed of the random number generator. */ void ReinitializeSeed(); @@ -219,6 +219,7 @@ class ITK_TEMPLATE_EXPORT ImageRandomConstIteratorWithIndex : public ImageConstI ReinitializeSeed(int); private: + /** Execute a random jump. */ void RandomJump(); diff --git a/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.hxx b/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.hxx index c6900240429..1e772026776 100644 --- a/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.hxx +++ b/Modules/Core/Common/include/itkImageRandomConstIteratorWithIndex.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Default constructor. Needed since we provide a cast constructor. */ + template ImageRandomConstIteratorWithIndex::ImageRandomConstIteratorWithIndex() : ImageConstIteratorWithIndex() @@ -32,8 +32,6 @@ ImageRandomConstIteratorWithIndex::ImageRandomConstIteratorWithIndex() m_Generator = Statistics::MersenneTwisterRandomVariateGenerator::New(); } -/** Constructor establishes an iterator to walk a particular image and a - * particular region of that image. */ template ImageRandomConstIteratorWithIndex::ImageRandomConstIteratorWithIndex(const ImageType * ptr, const RegionType & region) @@ -45,7 +43,6 @@ ImageRandomConstIteratorWithIndex::ImageRandomConstIteratorWithIndex(con m_Generator = Statistics::MersenneTwisterRandomVariateGenerator::New(); } -/** Set the number of samples to extract from the region */ template void ImageRandomConstIteratorWithIndex::SetNumberOfSamples(SizeValueType number) @@ -53,7 +50,6 @@ ImageRandomConstIteratorWithIndex::SetNumberOfSamples(SizeValueType numb m_NumberOfSamplesRequested = number; } -/** Set the number of samples to extract from the region */ template auto ImageRandomConstIteratorWithIndex::GetNumberOfSamples() const -> SizeValueType @@ -61,7 +57,6 @@ ImageRandomConstIteratorWithIndex::GetNumberOfSamples() const -> SizeVal return m_NumberOfSamplesRequested; } -/** Reinitialize the seed of the random number generator */ template void ImageRandomConstIteratorWithIndex::ReinitializeSeed() @@ -77,7 +72,6 @@ ImageRandomConstIteratorWithIndex::ReinitializeSeed(int seed) // vnl_sample_reseed(seed); } -/** Execute an acrobatic random jump */ template void ImageRandomConstIteratorWithIndex::RandomJump() diff --git a/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.h b/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.h index f6b874cde4d..4526181ee78 100644 --- a/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.h +++ b/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.h @@ -206,14 +206,14 @@ class ITK_TEMPLATE_EXPORT ImageRandomConstIteratorWithOnlyIndex : public ImageCo return *this; } - /** Set/Get number of random samples to get from the image region */ + /** Set/Get number of random samples to extract from the image region. */ void SetNumberOfSamples(SizeValueType number); SizeValueType GetNumberOfSamples() const; - /** Reinitialize the seed of the random number generator */ + /** Reinitialize the seed of the random number generator. */ void ReinitializeSeed(); @@ -221,6 +221,7 @@ class ITK_TEMPLATE_EXPORT ImageRandomConstIteratorWithOnlyIndex : public ImageCo ReinitializeSeed(int); private: + /** Execute a random jump. */ void RandomJump(); diff --git a/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.hxx b/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.hxx index 6a8f6db6e73..9d417a63b92 100644 --- a/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.hxx +++ b/Modules/Core/Common/include/itkImageRandomConstIteratorWithOnlyIndex.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Default constructor. Needed since we provide a cast constructor. */ + template ImageRandomConstIteratorWithOnlyIndex::ImageRandomConstIteratorWithOnlyIndex() : ImageConstIteratorWithOnlyIndex() @@ -32,8 +32,6 @@ ImageRandomConstIteratorWithOnlyIndex::ImageRandomConstIteratorWithOnlyI m_Generator = Statistics::MersenneTwisterRandomVariateGenerator::New(); } -/** Constructor establishes an iterator to walk a particular image and a - * particular region of that image. */ template ImageRandomConstIteratorWithOnlyIndex::ImageRandomConstIteratorWithOnlyIndex(const ImageType * ptr, const RegionType & region) @@ -45,7 +43,6 @@ ImageRandomConstIteratorWithOnlyIndex::ImageRandomConstIteratorWithOnlyI m_Generator = Statistics::MersenneTwisterRandomVariateGenerator::New(); } -/** Set the number of samples to extract from the region */ template void ImageRandomConstIteratorWithOnlyIndex::SetNumberOfSamples(SizeValueType number) @@ -53,7 +50,6 @@ ImageRandomConstIteratorWithOnlyIndex::SetNumberOfSamples(SizeValueType m_NumberOfSamplesRequested = number; } -/** Set the number of samples to extract from the region */ template auto ImageRandomConstIteratorWithOnlyIndex::GetNumberOfSamples() const -> SizeValueType @@ -61,7 +57,6 @@ ImageRandomConstIteratorWithOnlyIndex::GetNumberOfSamples() const -> Siz return m_NumberOfSamplesRequested; } -/** Reinitialize the seed of the random number generator */ template void ImageRandomConstIteratorWithOnlyIndex::ReinitializeSeed() @@ -76,7 +71,6 @@ ImageRandomConstIteratorWithOnlyIndex::ReinitializeSeed(int seed) m_Generator->SetSeed(seed); } -/** Execute an acrobatic random jump */ template void ImageRandomConstIteratorWithOnlyIndex::RandomJump() diff --git a/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.h b/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.h index f88ec6cd326..8b53a6d55dc 100644 --- a/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.h +++ b/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.h @@ -322,14 +322,14 @@ class ITK_TEMPLATE_EXPORT ImageRandomNonRepeatingConstIteratorWithIndex : public return *this; } - /** Set/Get number of random samples to get from the image region */ + /** Set/Get number of random samples to extract from the image region. */ void SetNumberOfSamples(SizeValueType number); SizeValueType GetNumberOfSamples() const; - /** Reinitialize the seed of the random number generator */ + /** Reinitialize the seed of the random number generator. */ void ReinitializeSeed(); @@ -339,6 +339,7 @@ class ITK_TEMPLATE_EXPORT ImageRandomNonRepeatingConstIteratorWithIndex : public ReinitializeSeed(int); private: + /** Update the position. */ void UpdatePosition(); diff --git a/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.hxx b/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.hxx index 2ce7d660bf1..351fa91d035 100644 --- a/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.hxx +++ b/Modules/Core/Common/include/itkImageRandomNonRepeatingConstIteratorWithIndex.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Default constructor. Needed since we provide a cast constructor. */ + template ImageRandomNonRepeatingConstIteratorWithIndex::ImageRandomNonRepeatingConstIteratorWithIndex() : ImageConstIteratorWithIndex() @@ -32,8 +32,6 @@ ImageRandomNonRepeatingConstIteratorWithIndex::ImageRandomNonRepeatingCo m_Permutation = nullptr; } -/** Constructor establishes an iterator to walk a particular image and a - * particular region of that image. */ template ImageRandomNonRepeatingConstIteratorWithIndex::ImageRandomNonRepeatingConstIteratorWithIndex( const ImageType * ptr, @@ -46,10 +44,6 @@ ImageRandomNonRepeatingConstIteratorWithIndex::ImageRandomNonRepeatingCo m_Permutation = new RandomPermutation(m_NumberOfPixelsInRegion); } - -//---------------------------------------------------------------------- -// Assignment Operator -//---------------------------------------------------------------------- template ImageRandomNonRepeatingConstIteratorWithIndex & ImageRandomNonRepeatingConstIteratorWithIndex::operator=(const Self & it) @@ -72,7 +66,6 @@ ImageRandomNonRepeatingConstIteratorWithIndex::operator=(const Self & it return *this; } -/** Set the number of samples to extract from the region */ template void ImageRandomNonRepeatingConstIteratorWithIndex::SetNumberOfSamples(SizeValueType number) @@ -84,7 +77,6 @@ ImageRandomNonRepeatingConstIteratorWithIndex::SetNumberOfSamples(SizeVa } } -/** Set the number of samples to extract from the region */ template auto ImageRandomNonRepeatingConstIteratorWithIndex::GetNumberOfSamples() const -> SizeValueType @@ -92,7 +84,6 @@ ImageRandomNonRepeatingConstIteratorWithIndex::GetNumberOfSamples() cons return m_NumberOfSamplesRequested; } -/** Reinitialize the seed of the random number generator */ template void ImageRandomNonRepeatingConstIteratorWithIndex::ReinitializeSeed() @@ -109,7 +100,6 @@ ImageRandomNonRepeatingConstIteratorWithIndex::ReinitializeSeed(int seed this->m_Permutation->Shuffle(); } -/** update the position */ template void ImageRandomNonRepeatingConstIteratorWithIndex::SetPriorityImage(const PriorityImageType * priorityImage) @@ -136,7 +126,6 @@ ImageRandomNonRepeatingConstIteratorWithIndex::SetPriorityImage(const Pr this->m_Permutation->Shuffle(); } -/** update the position */ template void ImageRandomNonRepeatingConstIteratorWithIndex::UpdatePosition() diff --git a/Modules/Core/Common/include/itkLoggerThreadWrapper.hxx b/Modules/Core/Common/include/itkLoggerThreadWrapper.hxx index d07e64bd620..d01883514a7 100644 --- a/Modules/Core/Common/include/itkLoggerThreadWrapper.hxx +++ b/Modules/Core/Common/include/itkLoggerThreadWrapper.hxx @@ -161,7 +161,6 @@ LoggerThreadWrapper::Flush() this->m_Mutex.unlock(); } -/** Constructor */ template LoggerThreadWrapper::LoggerThreadWrapper() { @@ -170,7 +169,6 @@ LoggerThreadWrapper::LoggerThreadWrapper() m_Thread = std::thread(&Self::ThreadFunction, this); } -/** Destructor */ template LoggerThreadWrapper::~LoggerThreadWrapper() { @@ -222,7 +220,6 @@ LoggerThreadWrapper::ThreadFunction() } } -/** Print contents of a LoggerThreadWrapper */ template void LoggerThreadWrapper::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Common/include/itkVariableLengthVector.h b/Modules/Core/Common/include/itkVariableLengthVector.h index 58b46f35285..6b2913e3cea 100644 --- a/Modules/Core/Common/include/itkVariableLengthVector.h +++ b/Modules/Core/Common/include/itkVariableLengthVector.h @@ -722,7 +722,7 @@ class ITK_TEMPLATE_EXPORT VariableLengthVector */ ~VariableLengthVector(); - /** Reserves memory of a certain length. + /** Reserves memory of a certain size of data. * * If the array already contains data, the existing data is copied over and * new space is allocated, if necessary. If the length to reserve is less @@ -960,11 +960,11 @@ class ITK_TEMPLATE_EXPORT VariableLengthVector ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self); - /** Returns vector's Euclidean Norm */ + /** Returns vector's Euclidean norm. */ RealValueType GetNorm() const; - /** Returns vector's squared Euclidean Norm */ + /** Returns vector's squared Euclidean norm. */ RealValueType GetSquaredNorm() const; diff --git a/Modules/Core/Common/include/itkVariableLengthVector.hxx b/Modules/Core/Common/include/itkVariableLengthVector.hxx index ef455019223..5da5109deed 100644 --- a/Modules/Core/Common/include/itkVariableLengthVector.hxx +++ b/Modules/Core/Common/include/itkVariableLengthVector.hxx @@ -26,14 +26,13 @@ namespace itk { -/** Default constructor */ + template VariableLengthVector::VariableLengthVector() : m_Data(nullptr) {} -/** Constructor with size */ template VariableLengthVector::VariableLengthVector(unsigned int length) : m_Data(nullptr) @@ -43,7 +42,6 @@ VariableLengthVector::VariableLengthVector(unsigned int length) itkAssertInDebugAndIgnoreInReleaseMacro(m_Data != nullptr); } -/** Constructor with user specified data */ template VariableLengthVector::VariableLengthVector(ValueType * datain, unsigned int sz, bool LetArrayManageMemory) : m_LetArrayManageMemory(LetArrayManageMemory) @@ -51,7 +49,6 @@ VariableLengthVector::VariableLengthVector(ValueType * datain, unsigned , m_NumElements(sz) {} -/** Constructor with user specified data */ template VariableLengthVector::VariableLengthVector(const ValueType * datain, unsigned int sz, bool LetArrayManageMemory) : m_LetArrayManageMemory(LetArrayManageMemory) @@ -60,8 +57,6 @@ VariableLengthVector::VariableLengthVector(const ValueType * datain, uns m_NumElements = sz; } -/** Copy constructor. Overrides the default non-templated copy constructor - * that the compiler provides */ template VariableLengthVector::VariableLengthVector(const VariableLengthVector & v) { @@ -166,7 +161,6 @@ VariableLengthVector::operator=( return *this; } -/** Destructor */ template VariableLengthVector::~VariableLengthVector() { @@ -177,7 +171,6 @@ VariableLengthVector::~VariableLengthVector() } } -/** Reserve memory of certain size for m_Data */ template void VariableLengthVector::Reserve(ElementIdentifier size) @@ -209,7 +202,6 @@ VariableLengthVector::Reserve(ElementIdentifier size) itkAssertInDebugAndIgnoreInReleaseMacro(m_Data != nullptr); } -/** Allocate memory of certain size and return it */ template TValue * VariableLengthVector::AllocateElements(ElementIdentifier size) const @@ -226,12 +218,6 @@ VariableLengthVector::AllocateElements(ElementIdentifier size) const } } -/** Set the pointer from which the data is imported. - * If "LetArrayManageMemory" is false, then the application retains - * the responsibility of freeing the memory for this data. If - * "LetArrayManageMemory" is true, then this class will free the - * memory when this object is destroyed. Note that you need to explicitly - * set the number of elements. */ template void VariableLengthVector::SetData(TValue * datain, bool LetArrayManageMemory) @@ -246,15 +232,6 @@ VariableLengthVector::SetData(TValue * datain, bool LetArrayManageMemory m_Data = datain; } -/** Similar to the previous method. In the above method, the size must be - * separately set prior to using user-supplied data. This introduces an - * unnecessary allocation step to be performed. This method avoids it - * and should be used to import data wherever possible to avoid this. - * Set the pointer from which the data is imported. - * If "LetArrayManageMemory" is false, then the application retains - * the responsibility of freeing the memory for this data. If - * "LetArrayManageMemory" is true, then this class will free the - * memory when this object is destroyed. */ template void VariableLengthVector::SetData(TValue * datain, unsigned int sz, bool LetArrayManageMemory) @@ -314,7 +291,6 @@ VariableLengthVector::SetSize(unsigned int sz, TReallocatePolicy realloc m_NumElements = sz; } -/** Set all the elements of the array to the specified value */ template void VariableLengthVector::Fill(TValue const & v) @@ -325,7 +301,6 @@ VariableLengthVector::Fill(TValue const & v) std::fill(&this->m_Data[0], &this->m_Data[m_NumElements], v); } -/** Copy-Assignment operator */ template VariableLengthVector & VariableLengthVector::operator=(const Self & v) @@ -351,7 +326,6 @@ VariableLengthVector::operator=(const Self & v) return *this; } -/** Fast Assignment */ template inline VariableLengthVector & VariableLengthVector::FastAssign(const Self & v) @@ -369,7 +343,6 @@ VariableLengthVector::FastAssign(const Self & v) return *this; } -/** Assignment operator */ template VariableLengthVector & VariableLengthVector::operator=(TValue const & v) @@ -407,9 +380,6 @@ VariableLengthVector::operator==(const Self & v) const return true; } -/** - * Returns vector's Euclidean Norm - */ template auto VariableLengthVector::GetNorm() const -> RealValueType @@ -418,9 +388,6 @@ VariableLengthVector::GetNorm() const -> RealValueType return static_cast(sqrt(this->GetSquaredNorm())); } -/** - * Returns vector's Squared Euclidean Norm - */ template auto VariableLengthVector::GetSquaredNorm() const -> RealValueType diff --git a/Modules/Core/Common/include/itkVersor.h b/Modules/Core/Common/include/itkVersor.h index 7a31af968f7..175e761dc1c 100644 --- a/Modules/Core/Common/include/itkVersor.h +++ b/Modules/Core/Common/include/itkVersor.h @@ -203,7 +203,7 @@ class ITK_TEMPLATE_EXPORT Versor return m_W; } - /** Returns the rotation angle in radians. */ + /** Returns the rotation angle in radians. */ ValueType GetAngle() const; @@ -219,9 +219,10 @@ class ITK_TEMPLATE_EXPORT Versor VectorType GetRight() const; - /** Set the versor using a vector and angle - * the unit vector parallel to the given vector - * will be used. The angle is expected in radians. */ + /** Set the versor using a vector and angle. + * + * The unit vector parallel to the given vector will be used. The angle is expected in radians. + */ void Set(const VectorType & axis, ValueType angle); @@ -277,7 +278,10 @@ class ITK_TEMPLATE_EXPORT Versor VectorType Transform(const VectorType & v) const; - /** Transform a covariant vector. */ + /** Transform a covariant vector. + * + * Given that this is an orthogonal transformation CovariantVectors are transformed as vectors. + */ CovariantVectorType Transform(const CovariantVectorType & v) const; @@ -297,7 +301,7 @@ class ITK_TEMPLATE_EXPORT Versor Self SquareRoot() const; - /** Compute the Exponential of the unit quaternion + /** Compute the Exponential of the unit quaternion. * Exponentiation by a factor is equivalent to * multiplication of the rotation angle of the quaternion. */ Self diff --git a/Modules/Core/Common/include/itkVersor.hxx b/Modules/Core/Common/include/itkVersor.hxx index 4289145e4e5..5d2032b81b5 100644 --- a/Modules/Core/Common/include/itkVersor.hxx +++ b/Modules/Core/Common/include/itkVersor.hxx @@ -24,7 +24,6 @@ namespace itk { -/** Constructor to initialize entire vector to one value. */ template Versor::Versor() : m_X(NumericTraits::ZeroValue()) @@ -33,7 +32,6 @@ Versor::Versor() , m_W(NumericTraits::OneValue()) {} -/** Copy Constructor */ template Versor::Versor(const Self & v) { @@ -43,7 +41,6 @@ Versor::Versor(const Self & v) m_W = v.m_W; } -/** Assignment Operator */ template Versor & Versor::operator=(const Self & v) @@ -55,7 +52,6 @@ Versor::operator=(const Self & v) return *this; } -/** Set to an identity transform */ template void Versor::SetIdentity() @@ -66,7 +62,6 @@ Versor::SetIdentity() m_W = NumericTraits::OneValue(); } -/** Return a vnl_quaternion */ template vnl_quaternion Versor::GetVnlQuaternion() const @@ -74,7 +69,6 @@ Versor::GetVnlQuaternion() const return vnl_quaternion(m_X, m_Y, m_Z, m_W); } -/** Assignment and Composition Operator */ template const Versor & Versor::operator*=(const Self & v) @@ -92,7 +86,6 @@ Versor::operator*=(const Self & v) return *this; } -/** Composition Operator */ template Versor Versor::operator*(const Self & v) const { @@ -106,7 +99,6 @@ Versor Versor::operator*(const Self & v) const return result; } -/** Division and Assignment Operator */ template const Versor & Versor::operator/=(const Self & v) @@ -124,7 +116,6 @@ Versor::operator/=(const Self & v) return *this; } -/** Division Operator */ template Versor Versor::operator/(const Self & v) const @@ -139,7 +130,6 @@ Versor::operator/(const Self & v) const return result; } -/** Comparison operator */ template bool Versor::operator==(const Self & v) const @@ -159,7 +149,6 @@ Versor::operator==(const Self & v) const return false; } -/** Get Conjugate */ template Versor Versor::GetConjugate() const @@ -174,7 +163,6 @@ Versor::GetConjugate() const return result; } -/** Get Reciprocal */ template Versor Versor::GetReciprocal() const @@ -189,7 +177,6 @@ Versor::GetReciprocal() const return result; } -/** Get Tensor part */ template auto Versor::GetTensor() const -> ValueType @@ -199,7 +186,6 @@ Versor::GetTensor() const -> ValueType return tensor; } -/** Normalize */ template void Versor::Normalize() @@ -219,7 +205,6 @@ Versor::Normalize() m_W /= tensor; } -/** Get Axis */ template auto Versor::GetAxis() const -> VectorType @@ -248,7 +233,6 @@ Versor::GetAxis() const -> VectorType return axis; } -/** Get Right part */ template auto Versor::GetRight() const -> VectorType @@ -262,7 +246,6 @@ Versor::GetRight() const -> VectorType return axis; } -/** Get Scalar part */ template auto Versor::GetScalar() const -> ValueType @@ -270,7 +253,6 @@ Versor::GetScalar() const -> ValueType return m_W; } -/** Get Angle (in radians) */ template auto Versor::GetAngle() const -> ValueType @@ -286,7 +268,6 @@ Versor::GetAngle() const -> ValueType return angle; } -/** Get the Square root of the unit quaternion */ template Versor Versor::SquareRoot() const @@ -306,7 +287,6 @@ Versor::SquareRoot() const return result; } -/** Compute the Exponential of the quaternion */ template Versor Versor::Exponential(ValueType exponent) const @@ -318,7 +298,6 @@ Versor::Exponential(ValueType exponent) const return result; } -/** Set Axis and Angle (in radians) */ template void Versor::Set(const VectorType & axis, ValueType angle) @@ -344,7 +323,6 @@ Versor::Set(const VectorType & axis, ValueType angle) m_W = cosangle2; } -/** Set using an orthogonal matrix. */ template void Versor::Set(const MatrixType & mat) @@ -428,7 +406,6 @@ Versor::Set(const MatrixType & mat) this->Normalize(); } -/** Set right Part (in radians) */ template void Versor::Set(const VectorType & axis) @@ -452,9 +429,6 @@ Versor::Set(const VectorType & axis) m_W = cosangle2; } -/** Set the Versor from four components. - * After assignment, the quaternion is normalized - * in order to get a consistent Versor (unit quaternion). */ template void Versor::Set(T x, T y, T z, T w) @@ -483,9 +457,6 @@ Versor::Set(T x, T y, T z, T w) this->Normalize(); } -/** Set from a vnl_quaternion - * After assignment, the quaternion is normalized - * in order to get a consistent Versor (unit quaternion). */ template void Versor::Set(const VnlQuaternionType & quaternion) @@ -497,7 +468,6 @@ Versor::Set(const VnlQuaternionType & quaternion) this->Normalize(); } -/** Set rotation around X axis */ template void Versor::SetRotationAroundX(ValueType angle) @@ -511,7 +481,6 @@ Versor::SetRotationAroundX(ValueType angle) m_W = cosangle2; } -/** Set rotation around Y axis */ template void Versor::SetRotationAroundY(ValueType angle) @@ -525,7 +494,6 @@ Versor::SetRotationAroundY(ValueType angle) m_W = cosangle2; } -/** Set rotation around Z axis */ template void Versor::SetRotationAroundZ(ValueType angle) @@ -577,7 +545,6 @@ localTransformVectorMath(const InputVectorType & VectorObject, } } // namespace -/** Transform a Vector */ template auto Versor::Transform(const VectorType & v) const -> VectorType @@ -586,9 +553,6 @@ Versor::Transform(const VectorType & v) const -> VectorType v, this->m_X, this->m_Y, this->m_Z, this->m_W); } -/** Transform a CovariantVector - * given that this is an orthogonal transformation - * CovariantVectors are transformed as vectors. */ template auto Versor::Transform(const CovariantVectorType & v) const -> CovariantVectorType @@ -597,7 +561,6 @@ Versor::Transform(const CovariantVectorType & v) const -> CovariantVectorType v, this->m_X, this->m_Y, this->m_Z, this->m_W); } -/** Transform a Point */ template auto Versor::Transform(const PointType & v) const -> PointType @@ -606,7 +569,6 @@ Versor::Transform(const PointType & v) const -> PointType v, this->m_X, this->m_Y, this->m_Z, this->m_W); } -/** Transform a VnlVector */ template auto Versor::Transform(const VnlVectorType & v) const -> VnlVectorType @@ -615,7 +577,6 @@ Versor::Transform(const VnlVectorType & v) const -> VnlVectorType v, this->m_X, this->m_Y, this->m_Z, this->m_W); } -/** Get Matrix representation */ template Matrix Versor::GetMatrix() const diff --git a/Modules/Core/GPUCommon/include/itkGPUReduction.hxx b/Modules/Core/GPUCommon/include/itkGPUReduction.hxx index 34dad4f166e..3c9099cbcb0 100644 --- a/Modules/Core/GPUCommon/include/itkGPUReduction.hxx +++ b/Modules/Core/GPUCommon/include/itkGPUReduction.hxx @@ -24,9 +24,7 @@ namespace itk { -/** - * Default constructor - */ + template GPUReduction::GPUReduction() { @@ -46,9 +44,6 @@ GPUReduction::~GPUReduction() this->ReleaseGPUInputBuffer(); } -/** - * Standard "PrintSelf" method. - */ template void GPUReduction::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/ImageAdaptors/include/itkImageAdaptor.hxx b/Modules/Core/ImageAdaptors/include/itkImageAdaptor.hxx index 333a2a48ebd..1bb9d88441a 100644 --- a/Modules/Core/ImageAdaptors/include/itkImageAdaptor.hxx +++ b/Modules/Core/ImageAdaptors/include/itkImageAdaptor.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template ImageAdaptor::ImageAdaptor() { @@ -41,7 +39,7 @@ ImageAdaptor::Allocate(bool initialize) { m_Image->Allocate(initialize); } -//---------------------------------------------------------------------------- + template void ImageAdaptor::Initialize() @@ -64,7 +62,6 @@ ImageAdaptor::SetPixelContainer(PixelContainer * container) } } -//---------------------------------------------------------------------------- template void ImageAdaptor::Graft(const Self * imgData) @@ -79,8 +76,6 @@ ImageAdaptor::Graft(const Self * imgData) } } - -//---------------------------------------------------------------------------- template void ImageAdaptor::Graft(const DataObject * data) @@ -112,9 +107,6 @@ ImageAdaptor::Graft(const DataObject * data) } } -/** - * - */ template void ImageAdaptor::PrintSelf(std::ostream & os, Indent indent) const @@ -122,7 +114,6 @@ ImageAdaptor::PrintSelf(std::ostream & os, Indent indent) con Superclass::PrintSelf(os, indent); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetOffsetTable() const -> const OffsetValueType * @@ -130,7 +121,6 @@ ImageAdaptor::GetOffsetTable() const -> const OffsetValueType return m_Image->GetOffsetTable(); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::ComputeIndex(OffsetValueType offset) const -> IndexType @@ -138,7 +128,6 @@ ImageAdaptor::ComputeIndex(OffsetValueType offset) const -> I return m_Image->ComputeIndex(offset); } -//---------------------------------------------------------------------------- template void ImageAdaptor::Update() @@ -148,7 +137,6 @@ ImageAdaptor::Update() m_Image->Update(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::UpdateOutputInformation() @@ -164,7 +152,6 @@ ImageAdaptor::UpdateOutputInformation() this->UpdateAccessor(m_Image.GetPointer()); } -//---------------------------------------------------------------------------- template void ImageAdaptor::UpdateOutputData() @@ -177,7 +164,6 @@ ImageAdaptor::UpdateOutputData() SetBufferedRegion(m_Image->GetBufferedRegion()); } -//---------------------------------------------------------------------------- template void ImageAdaptor::PropagateRequestedRegion() @@ -189,7 +175,6 @@ ImageAdaptor::PropagateRequestedRegion() m_Image->PropagateRequestedRegion(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetRequestedRegionToLargestPossibleRegion() @@ -201,7 +186,6 @@ ImageAdaptor::SetRequestedRegionToLargestPossibleRegion() m_Image->SetRequestedRegionToLargestPossibleRegion(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::CopyInformation(const DataObject * data) @@ -217,7 +201,6 @@ ImageAdaptor::CopyInformation(const DataObject * data) this->UpdateAccessor(m_Image.GetPointer()); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetSpacing() const -> const SpacingType & @@ -225,7 +208,6 @@ ImageAdaptor::GetSpacing() const -> const SpacingType & return m_Image->GetSpacing(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetSpacing(const SpacingType & spacing) @@ -234,7 +216,6 @@ ImageAdaptor::SetSpacing(const SpacingType & spacing) m_Image->SetSpacing(spacing); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetSpacing(const double * spacing /*[Self::ImageDimension]*/) @@ -243,7 +224,6 @@ ImageAdaptor::SetSpacing(const double * spacing /*[Self::Imag m_Image->SetSpacing(spacing); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetSpacing(const float * spacing /*[Self::ImageDimension]*/) @@ -252,7 +232,6 @@ ImageAdaptor::SetSpacing(const float * spacing /*[Self::Image m_Image->SetSpacing(spacing); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetOrigin(const PointType origin) @@ -261,7 +240,6 @@ ImageAdaptor::SetOrigin(const PointType origin) m_Image->SetOrigin(origin); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetOrigin(const double * origin /*[Self::ImageDimension]*/) @@ -270,7 +248,6 @@ ImageAdaptor::SetOrigin(const double * origin /*[Self::ImageD m_Image->SetOrigin(origin); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetOrigin(const float * origin /*[Self::ImageDimension]*/) @@ -279,7 +256,6 @@ ImageAdaptor::SetOrigin(const float * origin /*[Self::ImageDi m_Image->SetOrigin(origin); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetOrigin() const -> const PointType & @@ -287,7 +263,6 @@ ImageAdaptor::GetOrigin() const -> const PointType & return m_Image->GetOrigin(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetDirection(const DirectionType & direction) @@ -296,7 +271,6 @@ ImageAdaptor::SetDirection(const DirectionType & direction) m_Image->SetDirection(direction); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetDirection() const -> const DirectionType & @@ -304,7 +278,6 @@ ImageAdaptor::GetDirection() const -> const DirectionType & return m_Image->GetDirection(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetImage(TImage * image) @@ -317,7 +290,6 @@ ImageAdaptor::SetImage(TImage * image) this->UpdateAccessor(m_Image.GetPointer()); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetBufferPointer() const -> const InternalPixelType * @@ -325,7 +297,6 @@ ImageAdaptor::GetBufferPointer() const -> const InternalPixel return m_Image->GetBufferPointer(); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetBufferPointer() -> InternalPixelType * @@ -333,7 +304,6 @@ ImageAdaptor::GetBufferPointer() -> InternalPixelType * return m_Image->GetBufferPointer(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::Modified() const @@ -343,7 +313,6 @@ ImageAdaptor::Modified() const m_Image->Modified(); } -//---------------------------------------------------------------------------- template ModifiedTimeType ImageAdaptor::GetMTime() const @@ -356,7 +325,6 @@ ImageAdaptor::GetMTime() const return (mtime1 >= mtime2 ? mtime1 : mtime2); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetBufferedRegion(const RegionType & region) @@ -368,7 +336,6 @@ ImageAdaptor::SetBufferedRegion(const RegionType & region) m_Image->SetBufferedRegion(region); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetBufferedRegion() const -> const RegionType & @@ -377,7 +344,6 @@ ImageAdaptor::GetBufferedRegion() const -> const RegionType & return m_Image->GetBufferedRegion(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetLargestPossibleRegion(const RegionType & region) @@ -389,7 +355,6 @@ ImageAdaptor::SetLargestPossibleRegion(const RegionType & reg m_Image->SetLargestPossibleRegion(region); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetLargestPossibleRegion() const -> const RegionType & @@ -398,7 +363,6 @@ ImageAdaptor::GetLargestPossibleRegion() const -> const Regio return m_Image->GetLargestPossibleRegion(); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetRequestedRegion(const RegionType & region) @@ -410,7 +374,6 @@ ImageAdaptor::SetRequestedRegion(const RegionType & region) m_Image->SetRequestedRegion(region); } -//---------------------------------------------------------------------------- template void ImageAdaptor::SetRequestedRegion(const DataObject * data) @@ -422,7 +385,6 @@ ImageAdaptor::SetRequestedRegion(const DataObject * data) m_Image->SetRequestedRegion(data); } -//---------------------------------------------------------------------------- template bool ImageAdaptor::VerifyRequestedRegion() @@ -434,7 +396,6 @@ ImageAdaptor::VerifyRequestedRegion() return m_Image->VerifyRequestedRegion(); } -//---------------------------------------------------------------------------- template auto ImageAdaptor::GetRequestedRegion() const -> const RegionType & diff --git a/Modules/Core/ImageFunction/include/itkBSplineInterpolateImageFunction.hxx b/Modules/Core/ImageFunction/include/itkBSplineInterpolateImageFunction.hxx index 749dff16662..9fd47292923 100644 --- a/Modules/Core/ImageFunction/include/itkBSplineInterpolateImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkBSplineInterpolateImageFunction.hxx @@ -38,9 +38,7 @@ namespace itk { -/** - * Constructor - */ + template BSplineInterpolateImageFunction::BSplineInterpolateImageFunction() { @@ -55,9 +53,6 @@ BSplineInterpolateImageFunction::BSplin this->m_UseImageDirection = true; } -/** - * Standard "PrintSelf" method - */ template void BSplineInterpolateImageFunction::PrintSelf(std::ostream & os, diff --git a/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.h b/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.h index 97746aecc1e..d003e7ebab2 100644 --- a/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.h +++ b/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.h @@ -217,37 +217,43 @@ class ITK_TEMPLATE_EXPORT CentralDifferenceImageFunction : public ImageFunction< using Type = T; }; - /** Specialized versions of EvaluateAtIndex() method to handle scalar or vector pixel types.*/ + /** Specialized version of EvaluateAtIndex() method to handle scalar pixel types.*/ template inline void EvaluateAtIndexSpecialized(const IndexType & index, OutputType & orientedDerivative, OutputTypeSpecializationStructType) const; + + /** Specialized version of EvaluateAtIndex() method to handle vector pixel types.*/ template inline void EvaluateAtIndexSpecialized(const IndexType & index, OutputType & derivative, OutputTypeSpecializationStructType) const; - /** Specialized versions of EvaluateAtContinuousIndex() method to handle scalar or vector pixel types.*/ + /** Specialized version of EvaluateAtContinuousIndex() method to handle scalar pixel types.*/ template inline void EvaluateAtContinuousIndexSpecialized(const ContinuousIndexType & cindex, OutputType & orientedDerivative, OutputTypeSpecializationStructType) const; + + /** Specialized version of EvaluateAtContinuousIndex() method to handle vector pixel types.*/ template inline void EvaluateAtContinuousIndexSpecialized(const ContinuousIndexType & cindex, OutputType & derivative, OutputTypeSpecializationStructType) const; - /** Specialized versions of Evaluate() method to handle scalar or vector pixel types.*/ + /** Specialized version of Evaluate() method to handle scalar pixel types.*/ // NOTE: for some unknown reason, making these methods inline (as those above are inlined) makes them run *slower*. template void EvaluateSpecialized(const PointType & point, OutputType & orientedDerivative, OutputTypeSpecializationStructType) const; + + /** Specialized version of Evaluate() method to handle vector pixel types.*/ template void EvaluateSpecialized(const PointType & point, OutputType & derivative, OutputTypeSpecializationStructType) const; diff --git a/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.hxx b/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.hxx index f7c59822023..3c4ad0bcfe8 100644 --- a/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkCentralDifferenceImageFunction.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template CentralDifferenceImageFunction::CentralDifferenceImageFunction() { @@ -34,9 +32,6 @@ CentralDifferenceImageFunction::CentralDiff this->m_Interpolator = LinearInterpolatorType::New(); } -/** - * - */ template void CentralDifferenceImageFunction::SetInputImage(const TInputImage * inputData) @@ -67,9 +62,6 @@ CentralDifferenceImageFunction::SetInputIma } } -/** - * - */ template void CentralDifferenceImageFunction::SetInterpolator(InterpolatorType * interpolator) @@ -85,9 +77,6 @@ CentralDifferenceImageFunction::SetInterpol } } -/** - * - */ template void CentralDifferenceImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -96,9 +85,6 @@ CentralDifferenceImageFunction::PrintSelf(s os << indent << "UseImageDirection = " << this->m_UseImageDirection << std::endl; } -/** - * EvaluateAtIndex - */ template auto CentralDifferenceImageFunction::EvaluateAtIndex(const IndexType & index) const @@ -115,9 +101,6 @@ CentralDifferenceImageFunction::EvaluateAtI return derivative; } -/* - * Specialized for scalar pixels - */ template template void @@ -171,9 +154,6 @@ CentralDifferenceImageFunction::EvaluateAtI } } -/* - * Specialized for vector pixels - */ template template void @@ -255,9 +235,6 @@ CentralDifferenceImageFunction::EvaluateAtI } } -/** - * - */ template auto CentralDifferenceImageFunction::Evaluate(const PointType & point) const @@ -274,9 +251,6 @@ CentralDifferenceImageFunction::Evaluate(co return derivative; } -/* - * Specialized for scalar pixels - */ template template void @@ -343,9 +317,6 @@ CentralDifferenceImageFunction::EvaluateSpe } } -/* - * Specialized for vector pixels - */ template template void @@ -457,9 +428,6 @@ CentralDifferenceImageFunction::EvaluateSpe } } -/** - * EvaluateAtContinuousIndex - */ template typename CentralDifferenceImageFunction::OutputType CentralDifferenceImageFunction::EvaluateAtContinuousIndex( @@ -474,9 +442,6 @@ CentralDifferenceImageFunction::EvaluateAtC return derivative; } -/* - * Specialized for scalar pixels - */ template template void @@ -531,9 +496,6 @@ CentralDifferenceImageFunction::EvaluateAtC } } -/* - * Specialized for vector pixels - */ template template void diff --git a/Modules/Core/ImageFunction/include/itkImageFunction.hxx b/Modules/Core/ImageFunction/include/itkImageFunction.hxx index fabd0f012b9..ce4dd675acd 100644 --- a/Modules/Core/ImageFunction/include/itkImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkImageFunction.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template ImageFunction::ImageFunction() { @@ -34,9 +32,7 @@ ImageFunction::ImageFunction() m_EndContinuousIndex.Fill(0.0f); } -/** - * Standard "PrintSelf" method - */ + template void ImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -49,9 +45,6 @@ ImageFunction::PrintSelf(std::ostream & os, Ind os << indent << "EndContinuousIndex: " << m_EndContinuousIndex << std::endl; } -/** - * Initialize by setting the input image - */ template void ImageFunction::SetInputImage(const InputImageType * ptr) diff --git a/Modules/Core/ImageFunction/include/itkMedianImageFunction.hxx b/Modules/Core/ImageFunction/include/itkMedianImageFunction.hxx index 8aa729e1d54..3b6b8bb2ea7 100644 --- a/Modules/Core/ImageFunction/include/itkMedianImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkMedianImageFunction.hxx @@ -26,9 +26,7 @@ namespace itk { -/** - * Constructor - */ + template MedianImageFunction::MedianImageFunction() = default; @@ -44,10 +42,6 @@ MedianImageFunction::SetNeighborhoodRadius(const unsigne } } - -/** - * - */ template void MedianImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -56,9 +50,6 @@ MedianImageFunction::PrintSelf(std::ostream & os, Indent os << indent << "NeighborhoodRadius: " << m_NeighborhoodRadius << std::endl; } -/** - * - */ template auto MedianImageFunction::EvaluateAtIndex(const IndexType & index) const -> OutputType diff --git a/Modules/Core/ImageFunction/include/itkNeighborhoodBinaryThresholdImageFunction.hxx b/Modules/Core/ImageFunction/include/itkNeighborhoodBinaryThresholdImageFunction.hxx index 9f84e3150ea..2c4cccde72b 100644 --- a/Modules/Core/ImageFunction/include/itkNeighborhoodBinaryThresholdImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkNeighborhoodBinaryThresholdImageFunction.hxx @@ -23,18 +23,13 @@ namespace itk { -/** - * Constructor - */ + template NeighborhoodBinaryThresholdImageFunction::NeighborhoodBinaryThresholdImageFunction() { m_Radius.Fill(1); } -/** - * - */ template void NeighborhoodBinaryThresholdImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -44,9 +39,6 @@ NeighborhoodBinaryThresholdImageFunction::PrintSelf(std: os << indent << "Radius: " << m_Radius << std::endl; } -/** - * - */ template bool NeighborhoodBinaryThresholdImageFunction::EvaluateAtIndex(const IndexType & index) const diff --git a/Modules/Core/ImageFunction/include/itkNeighborhoodOperatorImageFunction.hxx b/Modules/Core/ImageFunction/include/itkNeighborhoodOperatorImageFunction.hxx index 2f35a074e01..345c42674af 100644 --- a/Modules/Core/ImageFunction/include/itkNeighborhoodOperatorImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkNeighborhoodOperatorImageFunction.hxx @@ -25,7 +25,7 @@ namespace itk { -/** Print self method */ + template void NeighborhoodOperatorImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -34,7 +34,6 @@ NeighborhoodOperatorImageFunction::PrintSelf(std::ostream os << indent << "Applying Operator Function:" << std::endl; } -/** Evaluate the function at the specified point */ template TOutput NeighborhoodOperatorImageFunction::EvaluateAtIndex(const IndexType & index) const diff --git a/Modules/Core/ImageFunction/include/itkScatterMatrixImageFunction.hxx b/Modules/Core/ImageFunction/include/itkScatterMatrixImageFunction.hxx index 389fcbe5dfd..d51c1110fb8 100644 --- a/Modules/Core/ImageFunction/include/itkScatterMatrixImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkScatterMatrixImageFunction.hxx @@ -22,18 +22,13 @@ namespace itk { -/** - * Constructor - */ + template ScatterMatrixImageFunction::ScatterMatrixImageFunction() { m_NeighborhoodRadius = 1; } -/** - * - */ template void ScatterMatrixImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -42,9 +37,6 @@ ScatterMatrixImageFunction::PrintSelf(std::ostream & os, os << indent << "NeighborhoodRadius: " << m_NeighborhoodRadius << std::endl; } -/** - * - */ template auto ScatterMatrixImageFunction::EvaluateAtIndex(const IndexType & index) const -> RealType diff --git a/Modules/Core/ImageFunction/include/itkVarianceImageFunction.hxx b/Modules/Core/ImageFunction/include/itkVarianceImageFunction.hxx index 7bbc800b901..189b8ef3300 100644 --- a/Modules/Core/ImageFunction/include/itkVarianceImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkVarianceImageFunction.hxx @@ -23,18 +23,13 @@ namespace itk { -/** - * Constructor - */ + template VarianceImageFunction::VarianceImageFunction() { m_NeighborhoodRadius = 1; } -/** - * - */ template void VarianceImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -43,9 +38,6 @@ VarianceImageFunction::PrintSelf(std::ostream & os, Inde os << indent << "NeighborhoodRadius: " << m_NeighborhoodRadius << std::endl; } -/** - * - */ template auto VarianceImageFunction::EvaluateAtIndex(const IndexType & index) const -> RealType diff --git a/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateImageFunction.hxx b/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateImageFunction.hxx index 3917fb4778e..0b8fccb93e9 100644 --- a/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateImageFunction.hxx @@ -23,17 +23,12 @@ namespace itk { -/** - * Define the number of neighbors - */ + template const unsigned long VectorLinearInterpolateImageFunction::m_Neighbors = 1 << TInputImage::ImageDimension; -/** - * Evaluate at image index position - */ template typename VectorLinearInterpolateImageFunction::OutputType VectorLinearInterpolateImageFunction::EvaluateAtContinuousIndex( diff --git a/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.hxx b/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.hxx index bdb1401d39c..e7464ae0e47 100644 --- a/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.hxx @@ -30,9 +30,6 @@ template const unsigned int VectorLinearInterpolateNearestNeighborExtrapolateImageFunction::m_Neighbors = 1 << TInputImage::ImageDimension; -/** - * Evaluate at image index position - */ template typename VectorLinearInterpolateNearestNeighborExtrapolateImageFunction::OutputType VectorLinearInterpolateNearestNeighborExtrapolateImageFunction::EvaluateAtContinuousIndex( diff --git a/Modules/Core/ImageFunction/include/itkVectorMeanImageFunction.hxx b/Modules/Core/ImageFunction/include/itkVectorMeanImageFunction.hxx index 827e1b30cbd..f62b5b96fbd 100644 --- a/Modules/Core/ImageFunction/include/itkVectorMeanImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkVectorMeanImageFunction.hxx @@ -22,18 +22,13 @@ namespace itk { -/** - * Constructor - */ + template VectorMeanImageFunction::VectorMeanImageFunction() { m_NeighborhoodRadius = 1; } -/** - * - */ template void VectorMeanImageFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -42,9 +37,6 @@ VectorMeanImageFunction::PrintSelf(std::ostream & os, In os << indent << "NeighborhoodRadius: " << m_NeighborhoodRadius << std::endl; } -/** - * - */ template auto VectorMeanImageFunction::EvaluateAtIndex(const IndexType & index) const -> RealType diff --git a/Modules/Core/ImageFunction/include/itkWindowedSincInterpolateImageFunction.hxx b/Modules/Core/ImageFunction/include/itkWindowedSincInterpolateImageFunction.hxx index 4973c9e5f7e..75079f10229 100644 --- a/Modules/Core/ImageFunction/include/itkWindowedSincInterpolateImageFunction.hxx +++ b/Modules/Core/ImageFunction/include/itkWindowedSincInterpolateImageFunction.hxx @@ -46,7 +46,6 @@ template const double BlackmanWindowFunction::m_Factor2 = 2.0 * itk::Math::pi / VRadius; } // end namespace Function - template Superclass::PrintSelf(os, indent); } -/** Evaluate at image index position */ template ::SetInput(const InputImageType this->ProcessObject::SetNthInput(0, const_cast(image)); } -/** Generate the data */ template void BinaryMask3DMeshSource::GenerateData() @@ -2689,7 +2688,6 @@ BinaryMask3DMeshSource::SearchThroughLastFrame(int ind return result; } -/** PrintSelf */ template void BinaryMask3DMeshSource::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Mesh/include/itkSimplexMesh.hxx b/Modules/Core/Mesh/include/itkSimplexMesh.hxx index b619906456a..bb929c7af08 100644 --- a/Modules/Core/Mesh/include/itkSimplexMesh.hxx +++ b/Modules/Core/Mesh/include/itkSimplexMesh.hxx @@ -27,11 +27,7 @@ namespace itk { -/** - * A protected default constructor allows the New() routine to create an - * instance of SimplexMesh. All the containers are initialized to empty - * containers. - */ + template SimplexMesh::SimplexMesh() : m_LastCellId(0) @@ -39,11 +35,6 @@ SimplexMesh::SimplexMesh() m_GeometryData = GeometryMapType::New(); } -/** - * Mesh Destructor takes care of releasing the memory of Cells - * and CellBoundaries objects for which normal pointers are - * stored. - */ template SimplexMesh::~SimplexMesh() { @@ -224,7 +215,6 @@ SimplexMesh::ReplaceFace(CellIdentifier return replaceIndex; } -/* PrintSelf. */ template void SimplexMesh::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Mesh/include/itkSimplexMeshAdaptTopologyFilter.hxx b/Modules/Core/Mesh/include/itkSimplexMeshAdaptTopologyFilter.hxx index 01d747783f2..d6aefa62ebd 100644 --- a/Modules/Core/Mesh/include/itkSimplexMeshAdaptTopologyFilter.hxx +++ b/Modules/Core/Mesh/include/itkSimplexMeshAdaptTopologyFilter.hxx @@ -48,7 +48,6 @@ SimplexMeshAdaptTopologyFilter::GenerateData() this->ComputeCellParameters(); } -// template void SimplexMeshAdaptTopologyFilter::Initialize() @@ -375,7 +374,6 @@ SimplexMeshAdaptTopologyFilter::ModifyNeighborCells(Cel outputMesh->BuildCellLinks(); } -/* PrintSelf. */ template void SimplexMeshAdaptTopologyFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Mesh/include/itkSimplexMeshToTriangleMeshFilter.hxx b/Modules/Core/Mesh/include/itkSimplexMeshToTriangleMeshFilter.hxx index 320843bb12f..79cb9391b2b 100644 --- a/Modules/Core/Mesh/include/itkSimplexMeshToTriangleMeshFilter.hxx +++ b/Modules/Core/Mesh/include/itkSimplexMeshToTriangleMeshFilter.hxx @@ -113,7 +113,6 @@ SimplexMeshToTriangleMeshFilter::FindCellId(CellIdentif return *cellIt; } -/* PrintSelf. */ template void SimplexMeshToTriangleMeshFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.h b/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.h index 1da6be07ab7..c7437c158cb 100644 --- a/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.h +++ b/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.h @@ -193,7 +193,7 @@ class ITK_TEMPLATE_EXPORT SimplexMeshVolumeCalculator : public Object void CreateTriangles(); - /** intermediate volume computation */ + /** Calculate volume of triangle. */ void CalculateTriangleVolume(InputPointType p1, InputPointType p2, InputPointType p3); diff --git a/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.hxx b/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.hxx index bea377ae66c..6671d290924 100644 --- a/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.hxx +++ b/Modules/Core/Mesh/include/itkSimplexMeshVolumeCalculator.hxx @@ -91,9 +91,6 @@ SimplexMeshVolumeCalculator::FindCellId(IdentifierType id1, Identifi return *cellIt; } -/** - * Calculate volume of triangle - */ template void SimplexMeshVolumeCalculator::CalculateTriangleVolume(InputPointType p1, @@ -253,9 +250,6 @@ SimplexMeshVolumeCalculator::Compute() this->Finalize(); } -/** - * PrintSelf - */ template void SimplexMeshVolumeCalculator::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Mesh/include/itkTriangleMeshToBinaryImageFilter.h b/Modules/Core/Mesh/include/itkTriangleMeshToBinaryImageFilter.h index 89f80152b69..145cba0dcb1 100644 --- a/Modules/Core/Mesh/include/itkTriangleMeshToBinaryImageFilter.h +++ b/Modules/Core/Mesh/include/itkTriangleMeshToBinaryImageFilter.h @@ -185,7 +185,7 @@ class ITK_TEMPLATE_EXPORT TriangleMeshToBinaryImageFilter : public ImageSource TriangleMeshToBinaryImageFilter::TriangleMeshToBinaryImageFilter() { @@ -47,7 +47,6 @@ TriangleMeshToBinaryImageFilter::TriangleMeshToBinaryI m_InfoImage = nullptr; } -/** Set the Input Mesh */ template void TriangleMeshToBinaryImageFilter::SetInput(TInputMesh * input) @@ -55,7 +54,6 @@ TriangleMeshToBinaryImageFilter::SetInput(TInputMesh * this->ProcessObject::SetNthInput(0, input); } -/** Get the input Mesh */ template auto TriangleMeshToBinaryImageFilter::GetInput() -> InputMeshType * @@ -63,7 +61,6 @@ TriangleMeshToBinaryImageFilter::GetInput() -> InputMe return static_cast(this->ProcessObject::GetInput(0)); } -/** Get the input Mesh */ template auto TriangleMeshToBinaryImageFilter::GetInput(unsigned int idx) -> InputMeshType * @@ -71,7 +68,6 @@ TriangleMeshToBinaryImageFilter::GetInput(unsigned int return itkDynamicCastInDebugMode(this->ProcessObject::GetInput(idx)); } -//---------------------------------------------------------------------------- template void TriangleMeshToBinaryImageFilter::SetSpacing(const double spacing[3]) @@ -94,7 +90,6 @@ TriangleMeshToBinaryImageFilter::SetSpacing(const floa this->SetSpacing(s); } -//---------------------------------------------------------------------------- template void TriangleMeshToBinaryImageFilter::SetOrigin(const double origin[3]) @@ -114,7 +109,6 @@ TriangleMeshToBinaryImageFilter::SetOrigin(const float this->SetOrigin(p); } -// used by an STL sort template bool TriangleMeshToBinaryImageFilter::ComparePoints2D(Point2DType a, Point2DType b) @@ -130,7 +124,6 @@ TriangleMeshToBinaryImageFilter::ComparePoints2D(Point } } -// used by an STL sort template bool TriangleMeshToBinaryImageFilter::ComparePoints1D(Point1D a, Point1D b) @@ -138,9 +131,6 @@ TriangleMeshToBinaryImageFilter::ComparePoints1D(Point return (a.m_X < b.m_X); } -//---------------------------------------------------------------------------- - -/** Update */ template void TriangleMeshToBinaryImageFilter::GenerateData() @@ -181,10 +171,8 @@ TriangleMeshToBinaryImageFilter::GenerateData() RasterizeTriangles(); itkDebugMacro(<< "TriangleMeshToBinaryImageFilter::Update() finished"); -} // end update function +} -//---------------------------------------------------------------------------- -/** convert a single polygon/triangle to raster format */ template int TriangleMeshToBinaryImageFilter::PolygonToImageRaster(PointVector coords, @@ -327,7 +315,6 @@ TriangleMeshToBinaryImageFilter::PolygonToImageRaster( return sign; } -/** raterize : Courtesy of Dr D Gobbi of Atamai Inc.*/ template void TriangleMeshToBinaryImageFilter::RasterizeTriangles() diff --git a/Modules/Core/Mesh/include/itkTriangleMeshToSimplexMeshFilter.hxx b/Modules/Core/Mesh/include/itkTriangleMeshToSimplexMeshFilter.hxx index 713c2a98a74..be94cdef6bd 100644 --- a/Modules/Core/Mesh/include/itkTriangleMeshToSimplexMeshFilter.hxx +++ b/Modules/Core/Mesh/include/itkTriangleMeshToSimplexMeshFilter.hxx @@ -265,7 +265,6 @@ TriangleMeshToSimplexMeshFilter::CreateNewEdge(CellIden } } -/* PrintSelf. */ template void TriangleMeshToSimplexMeshFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshEulerOperatorJoinVertexFunction.hxx b/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshEulerOperatorJoinVertexFunction.hxx index 8f5bb653433..29f461d6dcc 100644 --- a/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshEulerOperatorJoinVertexFunction.hxx +++ b/Modules/Core/QuadEdgeMesh/include/itkQuadEdgeMeshEulerOperatorJoinVertexFunction.hxx @@ -32,7 +32,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::QuadEdgeMeshEulerOp , m_EdgeStatus(STANDARD_CONFIG) {} -//-------------------------------------------------------------------------- template void QuadEdgeMeshEulerOperatorJoinVertexFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -81,7 +80,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::PrintSelf(std::ostr } } -//-------------------------------------------------------------------------- template auto QuadEdgeMeshEulerOperatorJoinVertexFunction::Evaluate(QEType * e) -> OutputType @@ -121,7 +119,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::Evaluate(QEType * e } } -//-------------------------------------------------------------------------- template TQEType * QuadEdgeMeshEulerOperatorJoinVertexFunction::Process(QEType * e) @@ -232,7 +229,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::Process(QEType * e) return (result); } -//-------------------------------------------------------------------------- template TQEType * QuadEdgeMeshEulerOperatorJoinVertexFunction::ProcessIsolatedQuadEdge(QEType * e) @@ -257,7 +253,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::ProcessIsolatedQuad return (rebuildEdge); } -//-------------------------------------------------------------------------- template TQEType * QuadEdgeMeshEulerOperatorJoinVertexFunction::ProcessIsolatedFace( @@ -287,7 +282,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::ProcessIsolatedFace } } -//-------------------------------------------------------------------------- template bool QuadEdgeMeshEulerOperatorJoinVertexFunction::IsFaceIsolated(QEType * e, @@ -316,7 +310,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::IsFaceIsolated(QETy return border; } -//-------------------------------------------------------------------------- template typename QuadEdgeMeshEulerOperatorJoinVertexFunction::EdgeStatusType QuadEdgeMeshEulerOperatorJoinVertexFunction::CheckStatus(QEType * e, @@ -426,7 +419,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::CheckStatus(QEType return STANDARD_CONFIG; } -//-------------------------------------------------------------------------- template bool QuadEdgeMeshEulerOperatorJoinVertexFunction::IsTetrahedron(QEType * e) @@ -499,7 +491,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::IsTetrahedron(QETyp return false; } -//-------------------------------------------------------------------------- template bool QuadEdgeMeshEulerOperatorJoinVertexFunction::IsSamosa(QEType * e) @@ -507,7 +498,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::IsSamosa(QEType * e return ((e->GetOrder() == 2) && (e->GetSym()->GetOrder() == 2)); } -//-------------------------------------------------------------------------- template bool QuadEdgeMeshEulerOperatorJoinVertexFunction::IsEye(QEType * e) @@ -518,7 +508,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::IsEye(QEType * e) return ((OriginOrderIsTwo && !DestinationOrderIsTwo) || (!OriginOrderIsTwo && DestinationOrderIsTwo)); } -//-------------------------------------------------------------------------- template auto QuadEdgeMeshEulerOperatorJoinVertexFunction::CommonVertexNeighboor(QEType * e) -> PointIdentifier @@ -558,7 +547,6 @@ QuadEdgeMeshEulerOperatorJoinVertexFunction::CommonVertexNeighbo return static_cast(intersection_list.size()); } -//-------------------------------------------------------------------------- template bool QuadEdgeMeshEulerOperatorJoinVertexFunction::IsEdgeLinkingTwoDifferentBorders(QEType * e) diff --git a/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.h b/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.h index 2bfa1cf4de9..54d8ea8a718 100644 --- a/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.h @@ -93,14 +93,13 @@ class ITK_TEMPLATE_EXPORT ArrowSpatialObject : public SpatialObject GetLengthInWorldSpace() const; protected: - /** Compute the Object bounding box */ + /** Compute the Object bounding box. */ void ComputeMyBoundingBox() override; ArrowSpatialObject(); ~ArrowSpatialObject() override = default; - /** Method to print the object.*/ void PrintSelf(std::ostream & os, Indent indent) const override; diff --git a/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.hxx index 1ac5da7ce34..07253e9b2fa 100644 --- a/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkArrowSpatialObject.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template ArrowSpatialObject::ArrowSpatialObject() { @@ -51,7 +51,6 @@ ArrowSpatialObject::Clear() this->Modified(); } -/** Compute the bounding box */ template void ArrowSpatialObject::ComputeMyBoundingBox() @@ -64,7 +63,6 @@ ArrowSpatialObject::ComputeMyBoundingBox() this->GetModifiableMyBoundingBoxInObjectSpace()->SetMaximum(pnt); } -/** Check if a given point is on the arrow */ template bool ArrowSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -140,7 +138,6 @@ ArrowSpatialObject::GetLengthInWorldSpace() const return len; } -/** InternalClone */ template typename LightObject::Pointer ArrowSpatialObject::InternalClone() const diff --git a/Modules/Core/SpatialObjects/include/itkBlobSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkBlobSpatialObject.hxx index 100cf92a516..2fe360218cc 100644 --- a/Modules/Core/SpatialObjects/include/itkBlobSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkBlobSpatialObject.hxx @@ -23,7 +23,7 @@ namespace itk { -/** Constructor */ + template BlobSpatialObject::BlobSpatialObject() { @@ -35,7 +35,6 @@ BlobSpatialObject::BlobSpatialObject() this->GetProperty().SetAlpha(1); } -/** InternalClone */ template typename LightObject::Pointer BlobSpatialObject::InternalClone() const @@ -52,7 +51,6 @@ BlobSpatialObject::InternalClone() const return loPtr; } -/** Print the blob spatial object */ template void BlobSpatialObject::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.h b/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.h index 36a22720cc1..36d3e54c12a 100644 --- a/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.h @@ -71,7 +71,7 @@ class ITK_TEMPLATE_EXPORT BoxSpatialObject : public SpatialObject /** Get the position of the box spatial object in object space. */ itkGetConstReferenceMacro(PositionInObjectSpace, PointType); - /** Test whether a point is inside or outside the object */ + /** Test whether a point is inside the object. */ bool IsInsideInObjectSpace(const PointType & point) const override; @@ -88,7 +88,6 @@ class ITK_TEMPLATE_EXPORT BoxSpatialObject : public SpatialObject BoxSpatialObject(); ~BoxSpatialObject() override = default; - /** Print the object information in a stream. */ void PrintSelf(std::ostream & os, Indent indent) const override; @@ -96,7 +95,6 @@ class ITK_TEMPLATE_EXPORT BoxSpatialObject : public SpatialObject InternalClone() const override; private: - /** object space */ SizeType m_SizeInObjectSpace{}; PointType m_PositionInObjectSpace{}; }; diff --git a/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.hxx index 08910cbf76d..986a582db63 100644 --- a/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkBoxSpatialObject.hxx @@ -22,7 +22,7 @@ namespace itk { -/** Constructor */ + template BoxSpatialObject::BoxSpatialObject() { @@ -45,7 +45,6 @@ BoxSpatialObject::Clear() this->Modified(); } -/** Test whether a point is inside or outside the object */ template bool BoxSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -55,7 +54,6 @@ BoxSpatialObject::IsInsideInObjectSpace(const PointType & point) con return this->GetMyBoundingBoxInObjectSpace()->IsInside(point); } -/** Compute the bounds of the box */ template void BoxSpatialObject::ComputeMyBoundingBox() @@ -76,7 +74,6 @@ BoxSpatialObject::ComputeMyBoundingBox() this->GetModifiableMyBoundingBoxInObjectSpace()->ComputeBoundingBox(); } -/** InternalClone */ template typename LightObject::Pointer BoxSpatialObject::InternalClone() const @@ -96,7 +93,6 @@ BoxSpatialObject::InternalClone() const return loPtr; } -/** Print Self function */ template void BoxSpatialObject::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkContourSpatialObject.h b/Modules/Core/SpatialObjects/include/itkContourSpatialObject.h index be6a6b9d08a..b507b876bcd 100644 --- a/Modules/Core/SpatialObjects/include/itkContourSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkContourSpatialObject.h @@ -126,11 +126,11 @@ class ITK_TEMPLATE_EXPORT ContourSpatialObject return m_ControlPoints; } - /** Set the list of control points. */ + /** Set the list of control points defining the contour. */ void SetControlPoints(const ControlPointListType & points); - /** Set the list of control points. */ + /** Add a point to the list of control points defining the contour. */ void AddControlPoint(const ControlPointType & point); diff --git a/Modules/Core/SpatialObjects/include/itkContourSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkContourSpatialObject.hxx index d75337a5f6f..d70fad0e983 100644 --- a/Modules/Core/SpatialObjects/include/itkContourSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkContourSpatialObject.hxx @@ -22,7 +22,7 @@ namespace itk { -/** Constructor */ + template ContourSpatialObject::ContourSpatialObject() { @@ -104,7 +104,6 @@ ContourSpatialObject::GetOrientationInObjectSpace() const return m_OrientationInObjectSpace; } -/** Set the control points which are defining the contour */ template void ContourSpatialObject::SetControlPoints(const ContourPointListType & points) @@ -122,7 +121,6 @@ ContourSpatialObject::SetControlPoints(const ContourPointListType & this->Modified(); } -/** Add a control point which is defining the contour */ template void ContourSpatialObject::AddControlPoint(const ContourPointType & point) @@ -132,7 +130,6 @@ ContourSpatialObject::AddControlPoint(const ContourPointType & point this->Modified(); } -/** InternalClone */ template typename LightObject::Pointer ContourSpatialObject::InternalClone() const @@ -156,7 +153,6 @@ ContourSpatialObject::InternalClone() const return loPtr; } -/** Print the contour spatial object */ template void ContourSpatialObject::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkContourSpatialObjectPoint.hxx b/Modules/Core/SpatialObjects/include/itkContourSpatialObjectPoint.hxx index a5f6e49074b..6d3ae3b48aa 100644 --- a/Modules/Core/SpatialObjects/include/itkContourSpatialObjectPoint.hxx +++ b/Modules/Core/SpatialObjects/include/itkContourSpatialObjectPoint.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template ContourSpatialObjectPoint::ContourSpatialObjectPoint() { @@ -29,7 +29,6 @@ ContourSpatialObjectPoint::ContourSpatialObjectPoint() m_PickedPointInObjectSpace.Fill(0); } -/** Copy Constructor */ template ContourSpatialObjectPoint::ContourSpatialObjectPoint(const ContourSpatialObjectPoint & other) : Superclass(other) diff --git a/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObject.hxx index afefefb87d0..26b26c5f77e 100644 --- a/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObject.hxx @@ -21,14 +21,13 @@ namespace itk { -/** Constructor */ + template DTITubeSpatialObject::DTITubeSpatialObject() { this->SetTypeName("DTITubeSpatialObject"); } -/** InternalClone */ template typename LightObject::Pointer DTITubeSpatialObject::InternalClone() const diff --git a/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.h b/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.h index 255d33ef6e5..c70d54f36d9 100644 --- a/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.h +++ b/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.h @@ -117,33 +117,33 @@ class ITK_TEMPLATE_EXPORT DTITubeSpatialObjectPoint : public TubeSpatialObjectPo return m_TensorMatrix; } - /** Copy one DTITubeSpatialObjectPoint to another */ + /** Copy one DTITubeSpatialObjectPoint to another. */ Self & operator=(const DTITubeSpatialObjectPoint & rhs); - /** Add a field to the point list */ + /** Add a field to the point list. */ void AddField(const char * name, float value); - /** Add a field to the point list */ + /** Add a field to the point list. */ void AddField(DTITubeSpatialObjectPointFieldEnum name, float value); - /** Set a field value */ + /** Set a field value. */ void SetField(DTITubeSpatialObjectPointFieldEnum name, float value); void SetField(const char * name, float value); - /** Return the list of extra fields */ + /** Get the list of fields. */ const FieldListType & GetFields() const { return m_Fields; } - /** Return the value of the specific fields */ + /** Get the value of the specified field. */ float GetField(const char * name) const; @@ -158,7 +158,7 @@ class ITK_TEMPLATE_EXPORT DTITubeSpatialObjectPoint : public TubeSpatialObjectPo void PrintSelf(std::ostream & os, Indent indent) const override; - /** Translate the enum to char */ + /** Translate the enum to a string. */ std::string TranslateEnumToChar(DTITubeSpatialObjectPointFieldEnum name) const; }; diff --git a/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.hxx b/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.hxx index 0d0c6c163b4..438aa54ebdd 100644 --- a/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.hxx +++ b/Modules/Core/SpatialObjects/include/itkDTITubeSpatialObjectPoint.hxx @@ -22,7 +22,7 @@ namespace itk { -/** Constructor */ + template DTITubeSpatialObjectPoint::DTITubeSpatialObjectPoint() { @@ -36,7 +36,6 @@ DTITubeSpatialObjectPoint::DTITubeSpatialObjectPoint() m_TensorMatrix[5] = 1; } -/** Copy Constructor */ template DTITubeSpatialObjectPoint::DTITubeSpatialObjectPoint(const DTITubeSpatialObjectPoint & other) : Superclass(other) @@ -62,7 +61,6 @@ DTITubeSpatialObjectPoint::PrintSelf(std::ostream & os, Indent Superclass::PrintSelf(os, indent); } -/** Translate the enumerated types to a string */ template std::string DTITubeSpatialObjectPoint::TranslateEnumToChar(DTITubeSpatialObjectPointFieldEnum name) const @@ -83,7 +81,6 @@ DTITubeSpatialObjectPoint::TranslateEnumToChar(DTITubeSpatialOb return std::string(""); } -/** Add a field to the point list */ template void DTITubeSpatialObjectPoint::AddField(const char * name, float value) @@ -93,7 +90,6 @@ DTITubeSpatialObjectPoint::AddField(const char * name, float va m_Fields.push_back(field); } -/** Set a field value to the point list */ template void DTITubeSpatialObjectPoint::SetField(const char * name, float value) @@ -110,7 +106,6 @@ DTITubeSpatialObjectPoint::SetField(const char * name, float va } } -/** Set a value to a field in the point list */ template void DTITubeSpatialObjectPoint::SetField(DTITubeSpatialObjectPointFieldEnum name, float value) @@ -127,7 +122,6 @@ DTITubeSpatialObjectPoint::SetField(DTITubeSpatialObjectPointFi } } -/** Add a field to the point list */ template void DTITubeSpatialObjectPoint::AddField(DTITubeSpatialObjectPointFieldEnum name, float value) @@ -145,7 +139,6 @@ DTITubeSpatialObjectPoint::AddField(DTITubeSpatialObjectPointFi } } -/** Return the value of the given field */ template float DTITubeSpatialObjectPoint::GetField(const char * name) const @@ -163,7 +156,6 @@ DTITubeSpatialObjectPoint::GetField(const char * name) const return -1; } -/** Add a field to the point list */ template float DTITubeSpatialObjectPoint::GetField(DTITubeSpatialObjectPointFieldEnum name) const diff --git a/Modules/Core/SpatialObjects/include/itkEllipseSpatialObject.h b/Modules/Core/SpatialObjects/include/itkEllipseSpatialObject.h index e18892a7077..2d847c0034e 100644 --- a/Modules/Core/SpatialObjects/include/itkEllipseSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkEllipseSpatialObject.h @@ -67,8 +67,12 @@ class ITK_TEMPLATE_EXPORT EllipseSpatialObject : public SpatialObject EllipseSpatialObject::EllipseSpatialObject() { @@ -44,8 +44,6 @@ EllipseSpatialObject::Clear() this->Modified(); } -/** Define the radius of the circle in object space. - * An ellipse is formed by setting the ObjectToParentTransform */ template void EllipseSpatialObject::SetRadiusInObjectSpace(double radius) @@ -65,9 +63,6 @@ EllipseSpatialObject::SetRadiusInObjectSpace(double radius) } } -/** Test whether a point is inside or outside the object - * For computational speed purposes, it is faster if the method does not - * check the name of the class and the current depth */ template bool EllipseSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -97,7 +92,6 @@ EllipseSpatialObject::IsInsideInObjectSpace(const PointType & point) return false; } -/** Compute the bounds of the ellipse */ template void EllipseSpatialObject::ComputeMyBoundingBox() @@ -118,7 +112,6 @@ EllipseSpatialObject::ComputeMyBoundingBox() this->GetModifiableMyBoundingBoxInObjectSpace()->ComputeBoundingBox(); } -/** InternalClone */ template typename LightObject::Pointer EllipseSpatialObject::InternalClone() const @@ -136,7 +129,6 @@ EllipseSpatialObject::InternalClone() const return loPtr; } -/** Print Self function */ template void EllipseSpatialObject::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkGaussianSpatialObject.h b/Modules/Core/SpatialObjects/include/itkGaussianSpatialObject.h index 149298df48a..d41eec16944 100644 --- a/Modules/Core/SpatialObjects/include/itkGaussianSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkGaussianSpatialObject.h @@ -85,28 +85,40 @@ class ITK_TEMPLATE_EXPORT GaussianSpatialObject : public SpatialObject::Pointer GetEllipsoid() const; @@ -124,7 +136,6 @@ class ITK_TEMPLATE_EXPORT GaussianSpatialObject : public SpatialObject GaussianSpatialObject::GaussianSpatialObject() { @@ -47,8 +47,6 @@ GaussianSpatialObject::Clear() this->Modified(); } -/** The z-score is the root mean square of the z-scores along - * each principal axis. */ template auto GaussianSpatialObject::SquaredZScoreInObjectSpace(const PointType & point) const -> ScalarType @@ -61,8 +59,6 @@ GaussianSpatialObject::SquaredZScoreInObjectSpace(const PointType & return r / (m_SigmaInObjectSpace * m_SigmaInObjectSpace); } -/** The z-score is the root mean square of the z-scores along - * each principal axis. */ template auto GaussianSpatialObject::SquaredZScoreInWorldSpace(const PointType & point) const -> ScalarType @@ -72,10 +68,6 @@ GaussianSpatialObject::SquaredZScoreInWorldSpace(const PointType & p return this->SquaredZScoreInObjectSpace(transformedPoint); } - -/** Test whether a point is inside or outside the object. - * For computational speed purposes, it is faster if the method does not - * check the name of the class and the current depth. */ template bool GaussianSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -102,8 +94,6 @@ GaussianSpatialObject::IsInsideInObjectSpace(const PointType & point return false; } -/** Compute the bounds of the Gaussian (as determined by the - * specified radius). */ template void GaussianSpatialObject::ComputeMyBoundingBox() @@ -124,7 +114,6 @@ GaussianSpatialObject::ComputeMyBoundingBox() this->GetModifiableMyBoundingBoxInObjectSpace()->ComputeBoundingBox(); } -/** Returns the value at one point. */ template bool GaussianSpatialObject::ValueAtInObjectSpace(const PointType & point, @@ -155,8 +144,6 @@ GaussianSpatialObject::ValueAtInObjectSpace(const PointType & poin return false; } -/** Returns the sigma=m_Radius level set of the Gaussian function, as an - * EllipseSpatialObject. */ template typename EllipseSpatialObject::Pointer GaussianSpatialObject::GetEllipsoid() const @@ -176,7 +163,6 @@ GaussianSpatialObject::GetEllipsoid() const return ellipse; } -/** InternalClone */ template typename LightObject::Pointer GaussianSpatialObject::InternalClone() const @@ -198,7 +184,6 @@ GaussianSpatialObject::InternalClone() const return loPtr; } -/** Print Self function. */ template void GaussianSpatialObject::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkGroupSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkGroupSpatialObject.hxx index 69a09e0067a..b7e739badcf 100644 --- a/Modules/Core/SpatialObjects/include/itkGroupSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkGroupSpatialObject.hxx @@ -21,14 +21,13 @@ namespace itk { -/** Constructor */ + template GroupSpatialObject::GroupSpatialObject() { this->SetTypeName("GroupSpatialObject"); } -/** InternalClone */ template typename LightObject::Pointer GroupSpatialObject::InternalClone() const diff --git a/Modules/Core/SpatialObjects/include/itkImageMaskSpatialObject.h b/Modules/Core/SpatialObjects/include/itkImageMaskSpatialObject.h index 2d11205c677..a4e2d6d4b07 100644 --- a/Modules/Core/SpatialObjects/include/itkImageMaskSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkImageMaskSpatialObject.h @@ -72,8 +72,13 @@ class ITK_TEMPLATE_EXPORT ImageMaskSpatialObject : public ImageSpatialObject ImageMaskSpatialObject::ImageMaskSpatialObject() { this->SetTypeName("ImageMaskSpatialObject"); } -/** Test whether a point is inside or outside the object - * For computational speed purposes, it is faster if the method does not - * check the name of the class and the current depth */ template bool ImageMaskSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -114,8 +111,6 @@ ImageMaskSpatialObject::ComputeMyBoundingBox() } } - -/** InternalClone */ template typename LightObject::Pointer ImageMaskSpatialObject::InternalClone() const diff --git a/Modules/Core/SpatialObjects/include/itkImageSpatialObject.h b/Modules/Core/SpatialObjects/include/itkImageSpatialObject.h index b29b9a96e6b..f456a832673 100644 --- a/Modules/Core/SpatialObjects/include/itkImageSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkImageSpatialObject.h @@ -87,7 +87,11 @@ class ITK_TEMPLATE_EXPORT ImageSpatialObject : public SpatialObject using Superclass::IsInsideInObjectSpace; /** Returns the value of the image at the requested point. - * Returns true if that value is valid */ + * + * Returns true if that value is valid. + * + * The value returned is always of type double; for RGB Images the value returned is the value of the first channel. + */ bool ValueAtInObjectSpace(const PointType & point, double & value, @@ -115,7 +119,7 @@ class ITK_TEMPLATE_EXPORT ImageSpatialObject : public SpatialObject itkLegacyMacro(const char * GetPixelTypeName()) { return m_PixelType.c_str(); } #endif - /** Set/Get the interpolator */ + /** Set/Get the interpolator. */ void SetInterpolator(InterpolatorType * interpolator); itkGetConstMacro(Interpolator, InterpolatorType *); diff --git a/Modules/Core/SpatialObjects/include/itkImageSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkImageSpatialObject.hxx index cf21cfa80a9..eb4e404847b 100644 --- a/Modules/Core/SpatialObjects/include/itkImageSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkImageSpatialObject.hxx @@ -23,7 +23,7 @@ namespace itk { -/** Constructor */ + template ImageSpatialObject::ImageSpatialObject() { @@ -34,7 +34,6 @@ ImageSpatialObject::ImageSpatialObject() this->Update(); } -/** Destructor */ template ImageSpatialObject::~ImageSpatialObject() = default; @@ -56,7 +55,6 @@ ImageSpatialObject::Clear() this->Modified(); } -/** Set the interpolator */ template void ImageSpatialObject::SetInterpolator(InterpolatorType * interpolator) @@ -72,8 +70,6 @@ ImageSpatialObject::SetInterpolator(InterpolatorType * in } } - -/** Return true if the given point is inside the image */ template bool ImageSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -82,10 +78,6 @@ ImageSpatialObject::IsInsideInObjectSpace(const PointType return m_Image->TransformPhysicalPointToIndex(point, index); } -/** Return the value of the image at a specified point - * The value returned is always of type double - * For RGB Images the value returned is the value of the first channel. - */ template bool ImageSpatialObject::ValueAtInObjectSpace(const PointType & point, @@ -119,7 +111,6 @@ ImageSpatialObject::ValueAtInObjectSpace(const PointType return false; } -/** Compute the bounds of the image */ template void ImageSpatialObject::ComputeMyBoundingBox() @@ -145,8 +136,6 @@ ImageSpatialObject::ComputeMyBoundingBox() this->GetModifiableMyBoundingBoxInObjectSpace()->ComputeBoundingBox(); } - -/** Set the image in the spatial object */ template void ImageSpatialObject::SetImage(const ImageType * image) @@ -169,7 +158,6 @@ ImageSpatialObject::SetImage(const ImageType * image) } } -/** Get the image inside the spatial object */ template auto ImageSpatialObject::GetImage() const -> const ImageType * @@ -177,7 +165,6 @@ ImageSpatialObject::GetImage() const -> const ImageType * return m_Image.GetPointer(); } -/** InternalClone */ template typename LightObject::Pointer ImageSpatialObject::InternalClone() const @@ -198,7 +185,6 @@ ImageSpatialObject::InternalClone() const return loPtr; } -/** Print the object */ template void ImageSpatialObject::PrintSelf(std::ostream & os, Indent indent) const @@ -214,7 +200,6 @@ ImageSpatialObject::PrintSelf(std::ostream & os, Indent i #endif } -/** Get the modification time */ template ModifiedTimeType ImageSpatialObject::GetMTime() const @@ -230,7 +215,6 @@ ImageSpatialObject::GetMTime() const return latestMTime; } -/** Set the slice position */ template void ImageSpatialObject::SetSliceNumber(unsigned int dimension, int position) diff --git a/Modules/Core/SpatialObjects/include/itkLandmarkSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkLandmarkSpatialObject.hxx index 09015230433..cfc3fa3f394 100644 --- a/Modules/Core/SpatialObjects/include/itkLandmarkSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkLandmarkSpatialObject.hxx @@ -23,7 +23,7 @@ namespace itk { -/** Constructor */ + template LandmarkSpatialObject::LandmarkSpatialObject() { @@ -35,7 +35,6 @@ LandmarkSpatialObject::LandmarkSpatialObject() this->GetProperty().SetAlpha(1); } -/** InternalClone */ template typename LightObject::Pointer LandmarkSpatialObject::InternalClone() const @@ -53,7 +52,6 @@ LandmarkSpatialObject::InternalClone() const return loPtr; } -/** Print the blob spatial object */ template void LandmarkSpatialObject::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkLineSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkLineSpatialObject.hxx index afcd051ca73..514756324ee 100644 --- a/Modules/Core/SpatialObjects/include/itkLineSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkLineSpatialObject.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template LineSpatialObject::LineSpatialObject() { @@ -32,7 +32,6 @@ LineSpatialObject::LineSpatialObject() this->GetProperty().SetAlpha(1); } -/** InternalClone */ template typename LightObject::Pointer LineSpatialObject::InternalClone() const diff --git a/Modules/Core/SpatialObjects/include/itkLineSpatialObjectPoint.h b/Modules/Core/SpatialObjects/include/itkLineSpatialObjectPoint.h index 29990c29950..e5516f3f993 100644 --- a/Modules/Core/SpatialObjects/include/itkLineSpatialObjectPoint.h +++ b/Modules/Core/SpatialObjects/include/itkLineSpatialObjectPoint.h @@ -58,11 +58,11 @@ class ITK_TEMPLATE_EXPORT LineSpatialObjectPoint : public SpatialObjectPoint LineSpatialObjectPoint::LineSpatialObjectPoint() { @@ -35,7 +35,6 @@ LineSpatialObjectPoint::LineSpatialObjectPoint() } } -/** Copy Constructor */ template LineSpatialObjectPoint::LineSpatialObjectPoint(const LineSpatialObjectPoint & other) : Superclass(other) @@ -43,7 +42,6 @@ LineSpatialObjectPoint::LineSpatialObjectPoint(const LineSpatia this->m_NormalArrayInObjectSpace = other.m_NormalArrayInObjectSpace; } -/** Get the specified normal */ template auto LineSpatialObjectPoint::GetNormalInObjectSpace(unsigned int index) const -> const CovariantVectorType & @@ -51,7 +49,6 @@ LineSpatialObjectPoint::GetNormalInObjectSpace(unsigned int ind return m_NormalArrayInObjectSpace[index]; } -/** Print the object */ template void LineSpatialObjectPoint::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkMeshSpatialObject.h b/Modules/Core/SpatialObjects/include/itkMeshSpatialObject.h index eab48ce0054..4c3b21abec3 100644 --- a/Modules/Core/SpatialObjects/include/itkMeshSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkMeshSpatialObject.h @@ -77,7 +77,13 @@ class ITK_TEMPLATE_EXPORT MeshSpatialObject : public SpatialObject MeshSpatialObject::MeshSpatialObject() { @@ -48,9 +48,6 @@ MeshSpatialObject::Clear() this->Modified(); } -/** Test whether a point is inside or outside the object - * For computational speed purposes, it is faster if the method does not - * check the name of the class and the current depth */ template bool MeshSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -94,7 +91,6 @@ MeshSpatialObject::IsInsideInObjectSpace(const PointType & point) const return false; } -/** Compute the bounds of the object which is the same as the internal mesh */ template void MeshSpatialObject::ComputeMyBoundingBox() @@ -112,7 +108,6 @@ MeshSpatialObject::ComputeMyBoundingBox() this->GetModifiableMyBoundingBoxInObjectSpace()->ComputeBoundingBox(); } -/** Set the Mesh in the spatial object */ template void MeshSpatialObject::SetMesh(MeshType * mesh) @@ -124,7 +119,6 @@ MeshSpatialObject::SetMesh(MeshType * mesh) } } -/** Get the Mesh inside the spatial object */ template auto MeshSpatialObject::GetMesh() -> MeshType * @@ -139,7 +133,6 @@ MeshSpatialObject::GetMesh() const -> const MeshType * return m_Mesh.GetPointer(); } -/** InternalClone */ template typename LightObject::Pointer MeshSpatialObject::InternalClone() const @@ -159,7 +152,6 @@ MeshSpatialObject::InternalClone() const return loPtr; } -/** Print the object */ template void MeshSpatialObject::PrintSelf(std::ostream & os, Indent indent) const @@ -170,7 +162,6 @@ MeshSpatialObject::PrintSelf(std::ostream & os, Indent indent) const os << indent << m_Mesh << std::endl; } -/** Get the modification time */ template ModifiedTimeType MeshSpatialObject::GetMTime() const diff --git a/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.h b/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.h index 1d46d636556..49e83224f4a 100644 --- a/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.h +++ b/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.h @@ -69,11 +69,11 @@ class ITK_TEMPLATE_EXPORT MetaSceneConverter : public Object using MetaConverterPointer = typename MetaConverterBaseType::Pointer; using ConverterMapType = std::map; - /** Read a MetaFile and create a Scene SpatialObject */ + /** Read a MetaFile and create a Scene SpatialObject. */ SpatialObjectPointer ReadMeta(const std::string & name); - /** write out a SpatialObject */ + /** Write out a SpatialObject. */ bool WriteMeta(const SpatialObjectType * soScene, const std::string & fileName, @@ -108,6 +108,10 @@ class ITK_TEMPLATE_EXPORT MetaSceneConverter : public Object const std::string & spatialObjectTypeName, MetaConverterBaseType * converter); + /** Convert a metaScene into a composite SpatialObject + * + * Manages tbe composite SpatialObject to keep a hierarchy. + */ MetaScene * CreateMetaScene(const SpatialObjectType * soScene, unsigned int depth = SpatialObjectType::MaximumDepth, diff --git a/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.hxx b/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.hxx index 8b9f8eea77a..50ab66f940f 100644 --- a/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.hxx +++ b/Modules/Core/SpatialObjects/include/itkMetaSceneConverter.hxx @@ -39,7 +39,7 @@ namespace itk { -/** Constructor */ + template MetaSceneConverter::MetaSceneConverter() { @@ -108,8 +108,6 @@ MetaSceneConverter::SetTransform(SpatialObje so->GetModifiableObjectToParentTransform()->SetOffset(offset); } -/** Convert a metaScene into a Composite Spatial Object - * Also Managed Composite Spatial Object to keep a hierarchy */ template auto MetaSceneConverter::CreateSpatialObjectScene(MetaScene * mScene) @@ -230,7 +228,6 @@ MetaSceneConverter::CreateSpatialObjectScene return soScene; } -/** Read a meta file give the type */ template auto MetaSceneConverter::ReadMeta(const std::string & name) -> SpatialObjectPointer @@ -247,7 +244,6 @@ MetaSceneConverter::ReadMeta(const std::stri return soScene; } -/** Write a meta file give the type */ template MetaScene * MetaSceneConverter::CreateMetaScene(const SpatialObjectType * soScene, @@ -369,7 +365,6 @@ MetaSceneConverter::CreateMetaScene(const Sp return metaScene; } -/** Write a meta file give the type */ template bool MetaSceneConverter::WriteMeta(const SpatialObjectType * soScene, diff --git a/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.h b/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.h index 6bd468cbca2..3028a37a3da 100644 --- a/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.h @@ -70,16 +70,16 @@ class ITK_TEMPLATE_EXPORT PointBasedSpatialObject : public SpatialObject(m_Points.size()); } - /** Method returns the Point closest to the given point */ + /** Get the closest point in world space. */ TSpatialObjectPointType ClosestPointInWorldSpace(const PointType & point) const; + /** Get the closest point in object space. */ TSpatialObjectPointType ClosestPointInObjectSpace(const PointType & point) const; - /** Returns true if the point is inside the Blob, false otherwise. */ + /** Test if a world-coordinate point is inside of this object or its children. + * + * Returns true if the point is inside the blob, false otherwise. + */ bool IsInsideInObjectSpace(const PointType & point) const override; diff --git a/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.hxx index 91ca768ba8e..1ebb05d12f6 100644 --- a/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkPointBasedSpatialObject.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template PointBasedSpatialObject::PointBasedSpatialObject() : SpatialObject() @@ -44,7 +44,6 @@ PointBasedSpatialObject::Clear() this->Modified(); } -/** Set Points from a list */ template void PointBasedSpatialObject::AddPoint(const SpatialObjectPointType & newPoint) @@ -55,7 +54,6 @@ PointBasedSpatialObject::AddPoint(const Spa this->Modified(); } -/** Remove a Point from the list */ template void PointBasedSpatialObject::RemovePoint(IdentifierType id) @@ -70,7 +68,6 @@ PointBasedSpatialObject::RemovePoint(Identi this->Modified(); } -/** Set Points from a list */ template void PointBasedSpatialObject::SetPoints(const SpatialObjectPointListType & newPoints) @@ -88,7 +85,6 @@ PointBasedSpatialObject::SetPoints(const Sp this->Modified(); } -/** Determine closest point in object space */ template TSpatialObjectPointType PointBasedSpatialObject::ClosestPointInObjectSpace(const PointType & point) const @@ -118,7 +114,6 @@ PointBasedSpatialObject::ClosestPointInObje return closestPoint; } -/** Determine closest point in world space */ template TSpatialObjectPointType PointBasedSpatialObject::ClosestPointInWorldSpace(const PointType & point) const @@ -148,7 +143,6 @@ PointBasedSpatialObject::ClosestPointInWorl return closestPoint; } -/** Compute bounding box of just this object */ template void PointBasedSpatialObject::ComputeMyBoundingBox() @@ -180,8 +174,6 @@ PointBasedSpatialObject::ComputeMyBoundingB this->GetModifiableMyBoundingBoxInObjectSpace()->ComputeBoundingBox(); } -/** Test if a world-coordinate point is inside of this object or its - * children, if they match the search depth and name */ template bool PointBasedSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -213,8 +205,6 @@ PointBasedSpatialObject::IsInsideInObjectSp return false; } - -/** InternalClone */ template typename LightObject::Pointer PointBasedSpatialObject::InternalClone() const @@ -234,7 +224,6 @@ PointBasedSpatialObject::InternalClone() co return loPtr; } -/** Print the object */ template void PointBasedSpatialObject::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkSpatialObject.h b/Modules/Core/SpatialObjects/include/itkSpatialObject.h index ddfe0c40c6f..c4999b19b96 100644 --- a/Modules/Core/SpatialObjects/include/itkSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkSpatialObject.h @@ -152,7 +152,12 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject return m_TypeName; } - /** Get the class name with the dimension of the spatial object appended */ + /** Get the class name with the dimension of the spatial object appended. + * + * Returns the type of the spatial object as a string. + * + * Used by the SpatialObjectFactory. + */ virtual std::string GetClassNameAndDimension() const; @@ -200,23 +205,36 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject /* Transforms */ /**************/ - /** This defines the transformation from the global coordinate frame. - * By setting this transform, the object transform is updated */ + /** Set the global to local transformation. + * + * Defines the transformation from the global coordinate frame. + * + * By setting this transform, the object transform is updated. + */ void SetObjectToWorldTransform(const TransformType * transform); itkGetModifiableObjectMacro(ObjectToWorldTransform, TransformType); const TransformType * GetObjectToWorldTransformInverse() const; - /** Transforms points from the object-specific "physical" space - * to the "physical" space of its parent object. */ + + /** Set the local to global transformation. + * + * Transforms points from the object-specific "physical" space to the "physical" space of its parent object. + */ void SetObjectToParentTransform(const TransformType * transform); itkGetModifiableObjectMacro(ObjectToParentTransform, TransformType); const TransformType * GetObjectToParentTransformInverse() const; - /** Compute the Local transform when the global transform is set */ + + /** Set the local to global transformation. + * + * Compute the local transform when the global transform is set. + * + * This does not change the IndexToObjectMatrix. + */ void ComputeObjectToParentTransform(); @@ -232,7 +250,7 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject */ /**********************************************************************/ - /** Returns true if a point is inside the object in object space. */ + /** Returns true if a point is inside the object or its children in object space. */ bool IsInsideInObjectSpace(const PointType & point, unsigned int depth, const std::string & name = "") const; @@ -247,7 +265,7 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject Update() override; - /** Returns the value at a point. Returns true if that value is valid */ + /** Returns the value at a point. Returns true if that value is valid. */ virtual bool ValueAtInObjectSpace(const PointType & point, double & value, @@ -266,15 +284,19 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject /********************************************************/ /* Helper functions to recurse queries through children */ /********************************************************/ + + /** Return if a point is inside the object or its children. */ virtual bool IsInsideChildrenInObjectSpace(const PointType & point, unsigned int depth = 0, const std::string & name = "") const; + /** Return the value of the object at a point. */ virtual bool ValueAtChildrenInObjectSpace(const PointType & point, double & value, unsigned int depth = 0, const std::string & name = "") const; + /** Return if the object is evaluable at a point. */ virtual bool IsEvaluableAtChildrenInObjectSpace(const PointType & point, unsigned int depth = 0, @@ -345,12 +367,17 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject virtual bool HasParent() const; - - /** Return a pointer to the parent object in the hierarchy tree */ + /** Get the parent of the spatial object. + * + * Returns a pointer to the parent object in the hierarchy tree. + */ virtual const Self * GetParent() const; - /** Return a pointer to the parent object in the hierarchy tree */ + /** Get the parent of the spatial object. + * + * Returns a pointer to the parent object in the hierarchy tree. + */ virtual Self * GetParent(); @@ -380,14 +407,19 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject void RemoveAllChildren(unsigned int depth = MaximumDepth); - /** Returns a list of pointer to the children affiliated to this object. + /** Get the children affiliated to this object. * A depth of 0 returns the immediate children. A depth of 1 returns the * children and those children's children. - * \warning User is responsible for freeing the list, but not the elements of + * \warning The user is responsible for freeing the list, but not the elements of * the list. */ virtual ChildrenListType * GetChildren(unsigned int depth = 0, const std::string & name = "") const; + /** Get the children affiliated to this object. + * A depth of 0 returns the immediate children. A depth of 1 returns the + * children and those children's children. + * \warning The user is responsible for freeing the list, but not the elements of + * the list. */ virtual ChildrenConstListType * GetConstChildren(unsigned int depth = 0, const std::string & name = "") const; @@ -399,11 +431,11 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject unsigned int depth = 0, const std::string & name = "") const; - /** Returns the number of children currently assigned to the object. */ + /** Get the number of children currently assigned to the object. */ unsigned int GetNumberOfChildren(unsigned int depth = 0, const std::string & name = "") const; - /** Return a SpatialObject given its ID, if it is a child */ + /** Return a SpatialObject given its ID, if it is a child. */ SpatialObject * GetObjectById(int id); @@ -413,7 +445,10 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject bool FixParentChildHierarchyUsingParentIds(); - /** Confirm that every object inherited from this has a unique Id */ + /** Check if the parent objects have a defined ID. + * + * Confirms that every object inherited from this has a unique Id. + */ bool CheckIdValidity() const; @@ -421,7 +456,10 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject void FixIdValidity(); - /** Generate a unique Id */ + /** Generate a unique Id. + * + * Returns the next available Id. For speed reason the MaxID+1 is returned. + */ int GetNextAvailableId() const; @@ -442,7 +480,10 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject GetMyBoundingBoxInWorldSpace() const; /** Compute an axis-aligned bounding box for an object and its selected - * children, down to a specified depth, in object space. */ + * children, down to a specified depth, in object space. + * + * After computation, the resulting bounding box is stored in m_FamilyBoundingBoxInWorldSpace. + */ virtual bool ComputeFamilyBoundingBox(unsigned int depth = 0, const std::string & name = "") const; @@ -460,7 +501,9 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject /* Regions used by DataObject */ /******************************/ - /** Set the region object that defines the size and starting index + /** Set the largest possible region. + * + * Sets the region object that defines the size and starting index * for the largest possible region this image could represent. This * is used in determining how much memory would be needed to load an * entire dataset. It is also used to determine boundary @@ -559,7 +602,7 @@ class ITK_TEMPLATE_EXPORT SpatialObject : public DataObject void UpdateOutputInformation() override; - /** Copy information from the specified data set. This method is + /** Copy the information from the specified data object. This method is * part of the pipeline execution model. By default, a ProcessObject * will copy meta-data from the first input to all of its * outputs. See ProcessObject::GenerateOutputInformation(). Each diff --git a/Modules/Core/SpatialObjects/include/itkSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkSpatialObject.hxx index 68c81ffa2ad..1196f039a3a 100644 --- a/Modules/Core/SpatialObjects/include/itkSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkSpatialObject.hxx @@ -27,7 +27,6 @@ namespace itk { -/** Destructor */ template SpatialObject::~SpatialObject() { @@ -81,7 +80,6 @@ SpatialObject::SetId(int id) } } -/** Return the Derivative at a point given the order of the derivative */ template void SpatialObject::DerivativeAtInObjectSpace(const PointType & point, @@ -133,7 +131,6 @@ SpatialObject::DerivativeAtInObjectSpace(const PointType & } } -/** Return the Derivative at a point given the order of the derivative */ template void SpatialObject::DerivativeAtInWorldSpace(const PointType & point, @@ -148,7 +145,6 @@ SpatialObject::DerivativeAtInWorldSpace(const PointType & this->DerivativeAtInObjectSpace(pnt, order, value, depth, name, offset); } -/** Return if a point is inside the object or its children */ template bool SpatialObject::IsInsideInObjectSpace(const PointType & point, @@ -181,7 +177,6 @@ SpatialObject::IsInsideInObjectSpace(const PointType & itkNotUsed(po return false; } -/** Return if a point is inside the object or its children */ template bool SpatialObject::IsInsideInWorldSpace(const PointType & point, @@ -193,7 +188,6 @@ SpatialObject::IsInsideInWorldSpace(const PointType & point, return IsInsideInObjectSpace(pnt, depth, name); } -/** Return if a point is inside the object or its children */ template bool SpatialObject::IsInsideChildrenInObjectSpace(const PointType & point, @@ -216,7 +210,6 @@ SpatialObject::IsInsideChildrenInObjectSpace(const PointType & poi return false; } -/** Return if the object is evaluable at a point */ template bool SpatialObject::IsEvaluableAtInObjectSpace(const PointType & point, @@ -240,7 +233,6 @@ SpatialObject::IsEvaluableAtInObjectSpace(const PointType & point, } } -/** Return if the object is evaluable at a point */ template bool SpatialObject::IsEvaluableAtInWorldSpace(const PointType & point, @@ -252,7 +244,6 @@ SpatialObject::IsEvaluableAtInWorldSpace(const PointType & point, return this->IsEvaluableAtInObjectSpace(pnt, depth, name); } -/** Return if the object is evaluable at a point */ template bool SpatialObject::IsEvaluableAtChildrenInObjectSpace(const PointType & point, @@ -275,7 +266,6 @@ SpatialObject::IsEvaluableAtChildrenInObjectSpace(const PointType & return false; } -/** Return the value of the object at a point */ template bool SpatialObject::ValueAtInObjectSpace(const PointType & point, @@ -311,7 +301,6 @@ SpatialObject::ValueAtInObjectSpace(const PointType & point, return false; } -/** Return the value of the object at a point */ template bool SpatialObject::ValueAtInWorldSpace(const PointType & point, @@ -324,7 +313,6 @@ SpatialObject::ValueAtInWorldSpace(const PointType & point, return this->ValueAtInObjectSpace(pnt, value, depth, name); } -/** Return the value of the object at a point */ template bool SpatialObject::ValueAtChildrenInObjectSpace(const PointType & point, @@ -350,8 +338,6 @@ SpatialObject::ValueAtChildrenInObjectSpace(const PointType & poin return false; } - -/** InternalClone */ template typename LightObject::Pointer SpatialObject::InternalClone() const @@ -375,7 +361,6 @@ SpatialObject::InternalClone() const return loPtr; } -/** Print self */ template void SpatialObject::PrintSelf(std::ostream & os, Indent indent) const @@ -408,7 +393,6 @@ SpatialObject::PrintSelf(std::ostream & os, Indent indent) const os << indent << "DefaultOutsideValue:" << m_DefaultOutsideValue << std::endl; } -/** Get the bounds of the object */ template auto SpatialObject::GetFamilyBoundingBoxInWorldSpace() const -> const BoundingBoxType * @@ -435,7 +419,6 @@ SpatialObject::GetFamilyBoundingBoxInWorldSpace() const -> const Bou return m_FamilyBoundingBoxInWorldSpace; } -/** Add a child to the object */ template void SpatialObject::AddChild(Self * pointer) @@ -457,7 +440,6 @@ SpatialObject::AddChild(Self * pointer) } } -/** Remove a child to the object */ template bool SpatialObject::RemoveChild(Self * pointer) @@ -483,7 +465,6 @@ SpatialObject::RemoveChild(Self * pointer) } } -/** Remove a child to the object */ template void SpatialObject::RemoveAllChildren(unsigned int depth) @@ -503,7 +484,6 @@ SpatialObject::RemoveAllChildren(unsigned int depth) this->Modified(); } -/** Set the local to global transformation */ template void SpatialObject::SetObjectToParentTransform(const TransformType * transform) @@ -519,7 +499,6 @@ SpatialObject::SetObjectToParentTransform(const TransformType * tran ProtectedComputeObjectToWorldTransform(); } -/** Set the local to global transformation */ template auto SpatialObject::GetObjectToParentTransformInverse() const -> const TransformType * @@ -531,7 +510,6 @@ SpatialObject::GetObjectToParentTransformInverse() const -> const Tr return m_ObjectToParentTransformInverse.GetPointer(); } -/** Compute the Global Transform */ template void SpatialObject::ProtectedComputeObjectToWorldTransform() @@ -559,7 +537,6 @@ SpatialObject::ProtectedComputeObjectToWorldTransform() this->Modified(); } -/** Set the global to local transformation */ template void SpatialObject::SetObjectToWorldTransform(const TransformType * transform) @@ -576,7 +553,6 @@ SpatialObject::SetObjectToWorldTransform(const TransformType * trans ProtectedComputeObjectToWorldTransform(); } -/** Set the local to global transformation */ template auto SpatialObject::GetObjectToWorldTransformInverse() const -> const TransformType * @@ -588,8 +564,6 @@ SpatialObject::GetObjectToWorldTransformInverse() const -> const Tra return m_ObjectToWorldTransformInverse.GetPointer(); } -/** Compute the Transform when the global transform as been set - * This does not change the IndexToObjectMatrix */ template void SpatialObject::ComputeObjectToParentTransform() @@ -617,7 +591,6 @@ SpatialObject::ComputeObjectToParentTransform() ProtectedComputeObjectToWorldTransform(); } -/** Get the modification time */ template ModifiedTimeType SpatialObject::GetMTime() const @@ -656,7 +629,6 @@ SpatialObject::ComputeMyBoundingBox() } } -/** Get the bounds of the object */ template auto SpatialObject::GetMyBoundingBoxInWorldSpace() const -> const BoundingBoxType * @@ -683,10 +655,6 @@ SpatialObject::GetMyBoundingBoxInWorldSpace() const -> const Boundin return m_MyBoundingBoxInWorldSpace; } -/** - * Compute an axis-aligned bounding box for an object and its selected - * children, down to a specified depth. After computation, the - * resulting bounding box is stored in this->m_FamilyBoundingBoxInWorldSpace. */ template bool SpatialObject::ComputeFamilyBoundingBox(unsigned int depth, const std::string & name) const @@ -750,9 +718,6 @@ SpatialObject::ComputeFamilyBoundingBox(unsigned int depth, const st return bbDefined; } -/** Get the children list. - * User is responsible for freeing the list, but not the elements of - * the list. */ template auto SpatialObject::GetChildren(unsigned int depth, const std::string & name) const -> ChildrenListType * @@ -782,9 +747,6 @@ SpatialObject::GetChildren(unsigned int depth, const std::string & n return childrenSO; } -/** Get the children list as const pointers. - * User is responsible for freeing the list, but not the elements of - * the list. */ template auto SpatialObject::GetConstChildren(unsigned int depth, const std::string & name) const @@ -869,7 +831,6 @@ SpatialObject::AddChildrenToConstList(ChildrenConstListType * childr } } -/** Set children list */ template void SpatialObject::SetChildren(ChildrenListType & children) @@ -885,7 +846,6 @@ SpatialObject::SetChildren(ChildrenListType & children) } } -/** Get the number of children */ template unsigned int SpatialObject::GetNumberOfChildren(unsigned int depth, const std::string & name) const @@ -914,8 +874,6 @@ SpatialObject::GetNumberOfChildren(unsigned int depth, const std::st return ccount; } -/** Return a SpatialObject in the SpatialObject - * given a parent ID */ template SpatialObject * SpatialObject::GetObjectById(int id) @@ -972,7 +930,6 @@ SpatialObject::FixParentChildHierarchyUsingParentIds() return ret; } -/** Check if the parent objects have a defined ID */ template bool SpatialObject::CheckIdValidity() const @@ -1055,7 +1012,6 @@ SpatialObject::FixIdValidity() delete children; } -/** Return the next available Id. For speed reason the MaxID+1 is returned */ template int SpatialObject::GetNextAvailableId() const @@ -1078,7 +1034,6 @@ SpatialObject::GetNextAvailableId() const return maxId + 1; } -/** Get the parent of the spatial object */ template SpatialObject * SpatialObject::GetParent() @@ -1086,7 +1041,6 @@ SpatialObject::GetParent() return m_Parent; } -/** Get the parent of the spatial object */ template const SpatialObject * SpatialObject::GetParent() const @@ -1094,7 +1048,6 @@ SpatialObject::GetParent() const return m_Parent; } -/** Set the parent of the spatial object */ template void SpatialObject::SetParent(Self * parent) @@ -1128,7 +1081,6 @@ SpatialObject::SetParent(Self * parent) } } -/** Return true if the spatial object has a parent */ template bool SpatialObject::HasParent() const @@ -1140,7 +1092,6 @@ SpatialObject::HasParent() const return true; } -/** Set the largest possible region */ template void SpatialObject::SetLargestPossibleRegion(const RegionType & region) @@ -1152,7 +1103,6 @@ SpatialObject::SetLargestPossibleRegion(const RegionType & region) } } -/** Update the Output information */ template void SpatialObject::UpdateOutputInformation() @@ -1297,8 +1247,6 @@ SpatialObject::Update() this->ProtectedComputeObjectToWorldTransform(); } -/** Return the type of the spatial object as a string - * This is used by the SpatialObjectFactory */ template std::string SpatialObject::GetClassNameAndDimension() const @@ -1310,7 +1258,6 @@ SpatialObject::GetClassNameAndDimension() const return n.str(); } -/** Copy the information from another spatial object */ template void SpatialObject::CopyInformation(const DataObject * data) diff --git a/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.h b/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.h index e476565a38a..09790479299 100644 --- a/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.h +++ b/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.h @@ -148,11 +148,11 @@ class ITK_TEMPLATE_EXPORT SpatialObjectPoint return m_Color; } - /** Set the color */ + /** Set the color of the point. */ void SetColor(double r, double g, double b, double a = 1); - /** Set/Get red color of the point */ + /** Set/Get red color of the point. */ void SetRed(double r) { diff --git a/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.hxx b/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.hxx index 144d3746df5..5175d123ab5 100644 --- a/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.hxx +++ b/Modules/Core/SpatialObjects/include/itkSpatialObjectPoint.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template SpatialObjectPoint::SpatialObjectPoint() { @@ -39,7 +39,6 @@ SpatialObjectPoint::SpatialObjectPoint() m_SpatialObject = nullptr; } -/** Copy Constructor */ template SpatialObjectPoint::SpatialObjectPoint(const SpatialObjectPoint & other) { @@ -74,7 +73,6 @@ SpatialObjectPoint::GetPositionInWorldSpace() const -> PointTyp return m_SpatialObject->GetObjectToWorldTransform()->TransformPoint(m_PositionInObjectSpace); } -/** Set the color of the point */ template void SpatialObjectPoint::SetColor(double r, double g, double b, double a) @@ -156,7 +154,6 @@ SpatialObjectPoint::SetTagScalarDictionary(const std::map void SpatialObjectPoint::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageFilter.h b/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageFilter.h index 49518270446..27e69ff219b 100644 --- a/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageFilter.h +++ b/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageFilter.h @@ -78,7 +78,7 @@ class ITK_TEMPLATE_EXPORT SpatialObjectToImageFilter : public ImageSource SpatialObjectToImageFilter::SpatialObjectToImageFilter() { @@ -45,7 +45,6 @@ SpatialObjectToImageFilter::SpatialObjectToIm m_UseObjectValue = false; } -/** Set the Input SpatialObject */ template void SpatialObjectToImageFilter::SetInput(const InputSpatialObjectType * input) @@ -54,7 +53,6 @@ SpatialObjectToImageFilter::SetInput(const In this->ProcessObject::SetNthInput(0, const_cast(input)); } -/** Connect one of the operands */ template void SpatialObjectToImageFilter::SetInput(unsigned int index, @@ -64,7 +62,6 @@ SpatialObjectToImageFilter::SetInput(unsigned this->ProcessObject::SetNthInput(index, const_cast(object)); } -/** Get the input Spatial Object */ template auto SpatialObjectToImageFilter::GetInput() -> const InputSpatialObjectType * @@ -72,7 +69,6 @@ SpatialObjectToImageFilter::GetInput() -> con return static_cast(this->GetPrimaryInput()); } -/** Get the input Spatial Object */ template auto SpatialObjectToImageFilter::GetInput(unsigned int idx) diff --git a/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.h b/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.h index 6a22bd345d5..69dca59d289 100644 --- a/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.h +++ b/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.h @@ -125,6 +125,7 @@ class ITK_TEMPLATE_EXPORT SpatialObjectToImageStatisticsCalculator : public Obje void PrintSelf(std::ostream & os, Indent indent) const override; + /** Compute statistics from the sample vector. */ bool ComputeStatistics(); diff --git a/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.hxx b/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.hxx index 0ace5a987ab..f5fb36022da 100644 --- a/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.hxx +++ b/Modules/Core/SpatialObjects/include/itkSpatialObjectToImageStatisticsCalculator.hxx @@ -26,7 +26,7 @@ namespace itk { -/** Constructor */ + template SpatialObjectToImageStatisticsCalculator:: SpatialObjectToImageStatisticsCalculator() @@ -43,7 +43,6 @@ SpatialObjectToImageStatisticsCalculator bool SpatialObjectToImageStatisticsCalculator::ComputeStatistics() @@ -78,7 +77,6 @@ SpatialObjectToImageStatisticsCalculator void SpatialObjectToImageStatisticsCalculator::Update() diff --git a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.h b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.h index 10ad7624886..0acbb0600cd 100644 --- a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.h @@ -73,11 +73,11 @@ class ITK_TEMPLATE_EXPORT SurfaceSpatialObject Clear() override; #if !defined(ITK_LEGACY_REMOVE) - /** Calculate the normalized tangent - Old spelling of function name */ + /** Approximate the normals of the surface. */ itkLegacyMacro(bool Approximate3DNormals()); #endif - /** Compute the normals to the surface from neighboring points */ + /** Compute the normals to the surface from neighboring points. */ bool ComputeNormals(); diff --git a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.hxx b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.hxx index 3ca4e530f3b..bd33198e270 100644 --- a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.hxx +++ b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObject.hxx @@ -23,7 +23,7 @@ namespace itk { -/** Constructor */ + template SurfaceSpatialObject::SurfaceSpatialObject() { @@ -48,7 +48,6 @@ SurfaceSpatialObject::Clear() this->Modified(); } -/** InternalClone */ template typename LightObject::Pointer SurfaceSpatialObject::InternalClone() const @@ -67,7 +66,6 @@ SurfaceSpatialObject::InternalClone() const } #if !defined(ITK_LEGACY_REMOVE) -/** Approximate the normals of the surface */ template bool SurfaceSpatialObject::Approximate3DNormals() @@ -76,7 +74,6 @@ SurfaceSpatialObject::Approximate3DNormals() } #endif // LEGACY -/** Approximate the normals of the surface in 2D or 3D */ template bool SurfaceSpatialObject::ComputeNormals() diff --git a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.h b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.h index 39d06c547d2..73bb24da408 100644 --- a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.h +++ b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.h @@ -54,23 +54,23 @@ class ITK_TEMPLATE_EXPORT SurfaceSpatialObjectPoint : public SpatialObjectPoint< /** Destructor */ ~SurfaceSpatialObjectPoint() override = default; - /** Get Normal */ + /** Get the normal in object space. */ const CovariantVectorType & GetNormalInObjectSpace() const; - /** Get Normal */ + /** Get the normal in world space. */ const CovariantVectorType GetNormalInWorldSpace() const; - /** Set Normal */ + /** Set the normal in object space. */ void SetNormalInObjectSpace(const CovariantVectorType & normal); - /** Set Normal */ + /** Set the normal in world space. */ void SetNormalInWorldSpace(const CovariantVectorType & normal); - /** Copy one SurfaceSpatialObjectPoint to another */ + /** Copy one SurfaceSpatialObjectPoint to another. */ Self & operator=(const SurfaceSpatialObjectPoint & rhs); diff --git a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.hxx b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.hxx index 7107cd26a52..b93531b94fa 100644 --- a/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.hxx +++ b/Modules/Core/SpatialObjects/include/itkSurfaceSpatialObjectPoint.hxx @@ -21,14 +21,13 @@ namespace itk { -/** Constructor */ + template SurfaceSpatialObjectPoint::SurfaceSpatialObjectPoint() { m_NormalInObjectSpace.Fill(0); } -/** Copy Constructor */ template SurfaceSpatialObjectPoint::SurfaceSpatialObjectPoint(const SurfaceSpatialObjectPoint & other) : Superclass(other) @@ -36,7 +35,6 @@ SurfaceSpatialObjectPoint::SurfaceSpatialObjectPoint(const Surf this->m_NormalInObjectSpace = other.m_NormalInObjectSpace; } -/** Set the normal : N-D case */ template void SurfaceSpatialObjectPoint::SetNormalInObjectSpace(const CovariantVectorType & normal) @@ -44,7 +42,6 @@ SurfaceSpatialObjectPoint::SetNormalInObjectSpace(const Covaria m_NormalInObjectSpace = normal; } -/** Set the normal : N-D case */ template void SurfaceSpatialObjectPoint::SetNormalInWorldSpace(const CovariantVectorType & normal) @@ -58,7 +55,6 @@ SurfaceSpatialObjectPoint::SetNormalInWorldSpace(const Covarian Superclass::m_SpatialObject->GetObjectToWorldTransform()->GetInverseTransform()->TransformCovariantVector(normal); } -/** Get the normal at one point */ template auto SurfaceSpatialObjectPoint::GetNormalInObjectSpace() const -> const CovariantVectorType & @@ -66,7 +62,6 @@ SurfaceSpatialObjectPoint::GetNormalInObjectSpace() const -> co return m_NormalInObjectSpace; } -/** Get the normal at one point */ template auto SurfaceSpatialObjectPoint::GetNormalInWorldSpace() const -> const CovariantVectorType @@ -79,7 +74,6 @@ SurfaceSpatialObjectPoint::GetNormalInWorldSpace() const -> con return Superclass::m_SpatialObject->GetObjectToWorldTransform()->TransformCovariantVector(m_NormalInObjectSpace); } -/** Print the object */ template void SurfaceSpatialObjectPoint::PrintSelf(std::ostream & os, Indent indent) const @@ -90,7 +84,6 @@ SurfaceSpatialObjectPoint::PrintSelf(std::ostream & os, Indent os << indent << m_NormalInObjectSpace << std::endl; } -/** Copy a surface point to another */ template auto SurfaceSpatialObjectPoint::operator=(const SurfaceSpatialObjectPoint & rhs) -> Self & diff --git a/Modules/Core/SpatialObjects/include/itkTubeSpatialObject.h b/Modules/Core/SpatialObjects/include/itkTubeSpatialObject.h index 0ea8ec40950..f9b67cd69ea 100644 --- a/Modules/Core/SpatialObjects/include/itkTubeSpatialObject.h +++ b/Modules/Core/SpatialObjects/include/itkTubeSpatialObject.h @@ -79,16 +79,16 @@ class ITK_TEMPLATE_EXPORT TubeSpatialObject : public PointBasedSpatialObject TubeSpatialObject::TubeSpatialObject() { @@ -52,7 +52,6 @@ TubeSpatialObject::Clear() this->Modified(); } -/** Copy the information from another spatial object */ template void TubeSpatialObject::CopyInformation(const DataObject * data) @@ -87,7 +86,6 @@ TubeSpatialObject::CopyInformation(const DataObject // this->SetParentPoint(source->GetParentPoint()); } -/** InternalClone */ template typename LightObject::Pointer TubeSpatialObject::InternalClone() const @@ -107,7 +105,6 @@ TubeSpatialObject::InternalClone() const return loPtr; } -/** Print the object */ template void TubeSpatialObject::PrintSelf(std::ostream & os, Indent indent) const @@ -120,7 +117,6 @@ TubeSpatialObject::PrintSelf(std::ostream & os, Inde Superclass::PrintSelf(os, indent); } -/** Compute the bounds of the tube */ template void TubeSpatialObject::ComputeMyBoundingBox() @@ -179,9 +175,6 @@ TubeSpatialObject::ComputeMyBoundingBox() this->GetModifiableMyBoundingBoxInObjectSpace()->ComputeBoundingBox(); } -/** Test whether a point is inside or outside the object - * For computational speed purposes, it is faster if the method does not - * check the name of the class and the current depth */ template bool TubeSpatialObject::IsInsideInObjectSpace(const PointType & point) const @@ -295,7 +288,6 @@ TubeSpatialObject::IsInsideInObjectSpace(const Point return false; } -/** Remove duplicate points */ template unsigned int TubeSpatialObject::RemoveDuplicatePointsInObjectSpace(double minSpacingInObjectSpace) @@ -322,7 +314,6 @@ TubeSpatialObject::RemoveDuplicatePointsInObjectSpac return nPoints; } -/** Compute the tangent of the centerline of the tube */ template bool TubeSpatialObject::ComputeTangentsAndNormals() diff --git a/Modules/Core/SpatialObjects/include/itkTubeSpatialObjectPoint.h b/Modules/Core/SpatialObjects/include/itkTubeSpatialObjectPoint.h index f5c0e3b4e58..c50a224d422 100644 --- a/Modules/Core/SpatialObjects/include/itkTubeSpatialObjectPoint.h +++ b/Modules/Core/SpatialObjects/include/itkTubeSpatialObjectPoint.h @@ -55,36 +55,36 @@ class ITK_TEMPLATE_EXPORT TubeSpatialObjectPoint : public SpatialObjectPoint TubeSpatialObjectPoint::TubeSpatialObjectPoint() { @@ -42,7 +42,6 @@ TubeSpatialObjectPoint::TubeSpatialObjectPoint() m_Alpha3 = 0; } -/** Copy Constructor */ template TubeSpatialObjectPoint::TubeSpatialObjectPoint(const TubeSpatialObjectPoint & other) : Superclass(other) @@ -64,7 +63,6 @@ TubeSpatialObjectPoint::TubeSpatialObjectPoint(const TubeSpatia this->SetAlpha3(other.GetAlpha3()); } -/** Get the radius */ template double TubeSpatialObjectPoint::GetRadiusInWorldSpace() const @@ -86,7 +84,6 @@ TubeSpatialObjectPoint::GetRadiusInWorldSpace() const return worldR; } -/** Get the radius */ template void TubeSpatialObjectPoint::SetRadiusInWorldSpace(double newR) diff --git a/Modules/Core/Transform/include/itkAffineTransform.h b/Modules/Core/Transform/include/itkAffineTransform.h index fbfeb6a2a66..6f73972df3f 100644 --- a/Modules/Core/Transform/include/itkAffineTransform.h +++ b/Modules/Core/Transform/include/itkAffineTransform.h @@ -148,7 +148,7 @@ class ITK_TEMPLATE_EXPORT AffineTransform using InverseTransformBaseType = typename Superclass::InverseTransformBaseType; using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer; - /** Compose affine transformation with a translation + /** Compose affine transformation with a translation. * * This method modifies self to include a translation of the * origin. The translation is precomposed with self if pre is @@ -157,7 +157,7 @@ class ITK_TEMPLATE_EXPORT AffineTransform void Translate(const OutputVectorType & trans, bool pre = false); - /** Compose affine transformation with a scaling + /** Compose affine transformation with a scaling. * * This method modifies self to magnify the source by a given * factor along each axis. If all factors are the same, or only a @@ -174,7 +174,7 @@ class ITK_TEMPLATE_EXPORT AffineTransform void Scale(const TParametersValueType & factor, bool pre = false); - /** Compose affine transformation with an elementary rotation + /** Compose affine transformation with an elementary rotation. * * This method composes self with a rotation that affects two * specified axes, replacing the current value of self. The @@ -192,7 +192,7 @@ class ITK_TEMPLATE_EXPORT AffineTransform void Rotate(int axis1, int axis2, TParametersValueType angle, bool pre = false); - /** Compose 2D affine transformation with a rotation + /** Compose 2D affine transformation with a rotation. * * This method composes self, which must be a 2D affine * transformation, with a clockwise rotation through a given angle @@ -208,7 +208,7 @@ class ITK_TEMPLATE_EXPORT AffineTransform void Rotate2D(TParametersValueType angle, bool pre = false); - /** Compose 3D affine transformation with a rotation + /** Compose 3D affine transformation with a rotation. * * This method composes self, which must be a 3D affine * transformation, with a clockwise rotation around a specified @@ -238,15 +238,15 @@ class ITK_TEMPLATE_EXPORT AffineTransform void Shear(int axis1, int axis2, TParametersValueType coef, bool pre = false); - /** Get an inverse of this transform. */ + /** Get the inverse of the transform. */ bool GetInverse(Self * inverse) const; - /** Return an inverse of this transform. */ + /** Get the inverse of the transform. */ InverseTransformBasePointer GetInverseTransform() const override; - /** Compute distance between two affine transformations + /** Compute distance between two affine transformations. * * This method computes a "distance" between two affine * transformations. This distance is guaranteed to be a metric, diff --git a/Modules/Core/Transform/include/itkAffineTransform.hxx b/Modules/Core/Transform/include/itkAffineTransform.hxx index 50985323e2e..aa1f2c49266 100644 --- a/Modules/Core/Transform/include/itkAffineTransform.hxx +++ b/Modules/Core/Transform/include/itkAffineTransform.hxx @@ -23,26 +23,23 @@ namespace itk { -/** Constructor with default arguments */ + template AffineTransform::AffineTransform() : Superclass(ParametersDimension) {} -/** Constructor with default arguments */ template AffineTransform::AffineTransform(unsigned int parametersDimension) : Superclass(parametersDimension) {} -/** Constructor with explicit arguments */ template AffineTransform::AffineTransform(const MatrixType & matrix, const OutputVectorType & offset) : Superclass(matrix, offset) {} -/** Compose with a translation */ template void AffineTransform::Translate(const OutputVectorType & trans, bool pre) @@ -62,7 +59,6 @@ AffineTransform::Translate(const OutputVectorT this->Modified(); } -/** Compose with isotropic scaling */ template void AffineTransform::Scale(const TParametersValueType & factor, bool pre) @@ -88,7 +84,6 @@ AffineTransform::Scale(const TParametersValueT this->Modified(); } -/** Compose with anisotropic scaling */ template void AffineTransform::Scale(const OutputVectorType & factor, bool pre) @@ -118,7 +113,6 @@ AffineTransform::Scale(const OutputVectorType this->Modified(); } -/** Compose with elementary rotation */ template void AffineTransform::Rotate(int axis1, int axis2, TParametersValueType angle, bool pre) @@ -152,9 +146,6 @@ AffineTransform::Rotate(int axis1, int axis2, this->Modified(); } -/** Compose with 2D rotation - * \todo Find a way to generate a compile-time error - * is this is used with VDimension != 2. */ template void AffineTransform::Rotate2D(TParametersValueType angle, bool pre) @@ -179,9 +170,6 @@ AffineTransform::Rotate2D(TParametersValueType this->Modified(); } -/** Compose with 3D rotation - * \todo Find a way to generate a compile-time error - * is this is used with VDimension != 3. */ template void AffineTransform::Rotate3D(const OutputVectorType & axis, @@ -230,7 +218,6 @@ AffineTransform::Rotate3D(const OutputVectorTy this->Modified(); } -/** Compose with elementary rotation */ template void AffineTransform::Shear(int axis1, int axis2, TParametersValueType coef, bool pre) @@ -261,7 +248,6 @@ AffineTransform::Shear(int axis1, int axis2, T this->Modified(); } -/** Get an inverse of this transform. */ template bool AffineTransform::GetInverse(Self * inverse) const @@ -269,7 +255,6 @@ AffineTransform::GetInverse(Self * inverse) co return this->Superclass::GetInverse(inverse); } -/** Return an inverse of this transform. */ template typename AffineTransform::InverseTransformBasePointer AffineTransform::GetInverseTransform() const @@ -279,7 +264,6 @@ AffineTransform::GetInverseTransform() const return this->GetInverse(inv) ? inv.GetPointer() : nullptr; } -/** Compute a distance between two affine transforms */ template typename AffineTransform::ScalarType AffineTransform::Metric(const Self * other) const @@ -299,7 +283,6 @@ AffineTransform::Metric(const Self * other) co return std::sqrt(result); } -/** Compute a distance between self and the identity transform */ template typename AffineTransform::ScalarType AffineTransform::Metric() const diff --git a/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.h b/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.h index 5d15de87fba..025bb4bb689 100644 --- a/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.h +++ b/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.h @@ -188,13 +188,11 @@ class ITK_TEMPLATE_EXPORT AzimuthElevationToCartesianTransform void SetForwardCartesianToAzimuthElevation(); - /** Perform conversion from Azimuth Elevation coordinates to Cartesian - * Coordinates. */ + /** Transform a point from azimuth-elevation coordinates to Cartesian coordinates. */ OutputPointType TransformAzElToCartesian(const InputPointType & point) const; - /** Perform conversion from Cartesian Coordinates to Azimuth Elevation - * coordinates. */ + /** Transform a point from Cartesian coordinates to azimuth-elevation coordinates. */ OutputPointType TransformCartesianToAzEl(const OutputPointType & point) const; diff --git a/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.hxx b/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.hxx index f3a33799768..9dfc1c5f660 100644 --- a/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.hxx +++ b/Modules/Core/Transform/include/itkAzimuthElevationToCartesianTransform.hxx @@ -21,7 +21,7 @@ namespace itk { -// Constructor with default arguments + template AzimuthElevationToCartesianTransform::AzimuthElevationToCartesianTransform() // add this construction call when deriving from itk::Transform @@ -36,7 +36,6 @@ AzimuthElevationToCartesianTransform::AzimuthE m_ForwardAzimuthElevationToPhysical = true; } -// Print self template void AzimuthElevationToCartesianTransform::PrintSelf(std::ostream & os, @@ -84,7 +83,6 @@ AzimuthElevationToCartesianTransform::Transfor return result; } -/** Transform a point, from azimuth-elevation to cartesian */ template typename AzimuthElevationToCartesianTransform::OutputPointType AzimuthElevationToCartesianTransform::TransformAzElToCartesian( @@ -120,7 +118,6 @@ AzimuthElevationToCartesianTransform::Transfor return result; } -// Set parameters template void AzimuthElevationToCartesianTransform::SetAzimuthElevationToCartesianParameters( diff --git a/Modules/Core/Transform/include/itkEuler3DTransform.h b/Modules/Core/Transform/include/itkEuler3DTransform.h index 05d79c83e9e..41d2df9bbb6 100644 --- a/Modules/Core/Transform/include/itkEuler3DTransform.h +++ b/Modules/Core/Transform/include/itkEuler3DTransform.h @@ -131,6 +131,10 @@ class ITK_TEMPLATE_EXPORT Euler3DTransform : public Rigid3DTransform Euler3DTransform::Euler3DTransform() : Superclass(ParametersDimension) @@ -32,7 +32,6 @@ Euler3DTransform::Euler3DTransform() this->m_FixedParameters.Fill(0.0); } -// Constructor with default arguments template Euler3DTransform::Euler3DTransform(const MatrixType & matrix, const OutputPointType & offset) { @@ -48,7 +47,6 @@ Euler3DTransform::Euler3DTransform(const MatrixType & matr this->m_FixedParameters.Fill(0.0); } -// Constructor with arguments template Euler3DTransform::Euler3DTransform(unsigned int parametersDimension) : Superclass(parametersDimension) @@ -59,7 +57,6 @@ Euler3DTransform::Euler3DTransform(unsigned int parameters this->m_FixedParameters.Fill(0.0); } -// Set Angles template void Euler3DTransform::SetVarRotation(ScalarType angleX, ScalarType angleY, ScalarType angleZ) @@ -69,7 +66,6 @@ Euler3DTransform::SetVarRotation(ScalarType angleX, Scalar this->m_AngleZ = angleZ; } -// Set Parameters template void Euler3DTransform::SetParameters(const ParametersType & parameters) @@ -103,7 +99,6 @@ Euler3DTransform::SetParameters(const ParametersType & par itkDebugMacro(<< "After setting parameters "); } -// Get Parameters template auto Euler3DTransform::GetParameters() const -> const ParametersType & @@ -156,7 +151,6 @@ Euler3DTransform::SetFixedParameters(const FixedParameters } } -// Set Rotational Part template void Euler3DTransform::SetRotation(ScalarType angleX, ScalarType angleY, ScalarType angleZ) @@ -168,7 +162,6 @@ Euler3DTransform::SetRotation(ScalarType angleX, ScalarTyp this->ComputeOffset(); } -// Compose template void Euler3DTransform::SetIdentity() @@ -179,7 +172,6 @@ Euler3DTransform::SetIdentity() m_AngleZ = 0; } -// Compute angles from the rotation matrix template void Euler3DTransform::ComputeMatrixParameters() @@ -230,7 +222,6 @@ Euler3DTransform::ComputeMatrixParameters() this->ComputeMatrix(); } -// Compute the matrix template void Euler3DTransform::ComputeMatrix() @@ -362,7 +353,6 @@ Euler3DTransform::SetComputeZYX(const bool flag) } } -// Print self template void Euler3DTransform::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Core/Transform/include/itkFixedCenterOfRotationAffineTransform.hxx b/Modules/Core/Transform/include/itkFixedCenterOfRotationAffineTransform.hxx index ed320ee4638..a72a2bba903 100644 --- a/Modules/Core/Transform/include/itkFixedCenterOfRotationAffineTransform.hxx +++ b/Modules/Core/Transform/include/itkFixedCenterOfRotationAffineTransform.hxx @@ -24,7 +24,7 @@ namespace itk { -/** Constructor with default arguments */ + template FixedCenterOfRotationAffineTransform::FixedCenterOfRotationAffineTransform() : Superclass(ParametersDimension) diff --git a/Modules/Core/Transform/include/itkVersorTransform.h b/Modules/Core/Transform/include/itkVersorTransform.h index a570520b7d6..c382d73348a 100644 --- a/Modules/Core/Transform/include/itkVersorTransform.h +++ b/Modules/Core/Transform/include/itkVersorTransform.h @@ -112,7 +112,7 @@ class ITK_TEMPLATE_EXPORT VersorTransform : public Rigid3DTransform VersorTransform::VersorTransform() : Superclass(ParametersDimension) @@ -30,7 +30,6 @@ VersorTransform::VersorTransform() m_Versor.SetIdentity(); } -/** Constructor with default arguments */ template VersorTransform::VersorTransform(unsigned int parametersDimension) : Superclass(parametersDimension) @@ -38,7 +37,6 @@ VersorTransform::VersorTransform(unsigned int parametersDi m_Versor.SetIdentity(); } -/** Constructor with default arguments */ template VersorTransform::VersorTransform(const MatrixType & matrix, const OutputVectorType & offset) : Superclass(matrix, offset) @@ -46,7 +44,6 @@ VersorTransform::VersorTransform(const MatrixType & matrix this->ComputeMatrixParameters(); // called in MatrixOffset baseclass } -/** Set Parameters */ template void VersorTransform::SetParameters(const ParametersType & parameters) @@ -81,7 +78,6 @@ VersorTransform::SetParameters(const ParametersType & para itkDebugMacro(<< "After setting parameters "); } -/** Set Parameters */ template auto VersorTransform::GetParameters() const -> const ParametersType & @@ -93,7 +89,6 @@ VersorTransform::GetParameters() const -> const Parameters return this->m_Parameters; } -/** Set Rotational Part */ template void VersorTransform::SetRotation(const VersorType & versor) @@ -103,7 +98,6 @@ VersorTransform::SetRotation(const VersorType & versor) this->ComputeOffset(); } -/** Set Rotational Part */ template void VersorTransform::SetRotation(const AxisType & axis, AngleType angle) @@ -113,7 +107,6 @@ VersorTransform::SetRotation(const AxisType & axis, AngleT this->ComputeOffset(); } -/** Set Identity */ template void VersorTransform::SetIdentity() @@ -125,7 +118,6 @@ VersorTransform::SetIdentity() this->Modified(); } -/** Compute the matrix */ template void VersorTransform::ComputeMatrix() @@ -133,7 +125,6 @@ VersorTransform::ComputeMatrix() this->SetVarMatrix(m_Versor.GetMatrix()); } -/** Compute the matrix */ template void VersorTransform::ComputeMatrixParameters() @@ -189,7 +180,6 @@ VersorTransform::ComputeJacobianWithRespectToParameters(co jacobian[2][2] = 2.0 * ((vxw + vyz) * px + (vyw - vxz) * py) / vw; } -/** Print self */ template void VersorTransform::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Filtering/AnisotropicSmoothing/include/itkAnisotropicDiffusionImageFilter.hxx b/Modules/Filtering/AnisotropicSmoothing/include/itkAnisotropicDiffusionImageFilter.hxx index f8ef5b74103..1b580d4ff79 100644 --- a/Modules/Filtering/AnisotropicSmoothing/include/itkAnisotropicDiffusionImageFilter.hxx +++ b/Modules/Filtering/AnisotropicSmoothing/include/itkAnisotropicDiffusionImageFilter.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template AnisotropicDiffusionImageFilter::AnisotropicDiffusionImageFilter() { @@ -36,7 +34,6 @@ AnisotropicDiffusionImageFilter::AnisotropicDiffusion m_GradientMagnitudeIsFixed = false; } -/** Prepare for the iteration process. */ template void AnisotropicDiffusionImageFilter::InitializeIteration() diff --git a/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.h b/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.h index ccfe6ad99f2..b44469c51db 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.h +++ b/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.h @@ -79,8 +79,7 @@ class ITK_TEMPLATE_EXPORT BinaryMinMaxCurvatureFlowFunction : public MinMaxCurva return m_Threshold; } - /** This method computes the solution update for each pixel that does not - * lie on a the data set boundary. */ + /** Compute the solution update for each pixel that does not lie on a the data set boundary. */ PixelType ComputeUpdate(const NeighborhoodType & it, void * globalData, diff --git a/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.hxx b/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.hxx index fb17fb1e075..5da03992177 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.hxx +++ b/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowFunction.hxx @@ -23,19 +23,13 @@ namespace itk { -/** - * Constructor - */ + template BinaryMinMaxCurvatureFlowFunction::BinaryMinMaxCurvatureFlowFunction() { m_Threshold = 0.0; } -/** - * Update the solution at pixels which does not lie on the - * data boundary. - */ template typename BinaryMinMaxCurvatureFlowFunction::PixelType BinaryMinMaxCurvatureFlowFunction::ComputeUpdate(const NeighborhoodType & it, diff --git a/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowImageFilter.hxx b/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowImageFilter.hxx index 14e20cc1567..45aea0f1378 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowImageFilter.hxx +++ b/Modules/Filtering/CurvatureFlow/include/itkBinaryMinMaxCurvatureFlowImageFilter.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template BinaryMinMaxCurvatureFlowImageFilter::BinaryMinMaxCurvatureFlowImageFilter() { @@ -36,20 +34,15 @@ BinaryMinMaxCurvatureFlowImageFilter::BinaryMinMaxCur this->SetDifferenceFunction(static_cast(cffp.GetPointer())); } -/** - * Standard PrintSelf method. - */ template void BinaryMinMaxCurvatureFlowImageFilter::PrintSelf(std::ostream & os, Indent indent) const { Superclass::PrintSelf(os, indent); + os << indent << "Threshold: " << m_Threshold << std::endl; } -/** - * Initialize the state of filter and equation before each iteration. - */ template void BinaryMinMaxCurvatureFlowImageFilter::InitializeIteration() diff --git a/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.h b/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.h index 6cf2a051c65..e941aabc5b0 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.h +++ b/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.h @@ -123,8 +123,7 @@ class ITK_TEMPLATE_EXPORT CurvatureFlowFunction : public FiniteDifferenceFunctio return m_TimeStep; } - /** This method computes the solution update for each pixel that does not - * lie on a the data set boundary. */ + /** Compute the solution update for each pixel that does not lie on a the data set boundary. */ PixelType ComputeUpdate(const NeighborhoodType & it, void * globalData, diff --git a/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.hxx b/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.hxx index 949ae0b6e82..bb5d8b5247a 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.hxx +++ b/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowFunction.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template CurvatureFlowFunction::CurvatureFlowFunction() { @@ -41,9 +39,6 @@ CurvatureFlowFunction::CurvatureFlowFunction() m_TimeStep = 0.05f; } -/** - * Compute the global time step - */ template auto CurvatureFlowFunction::ComputeGlobalTimeStep(void * itkNotUsed(gd)) const -> TimeStepType @@ -51,9 +46,6 @@ CurvatureFlowFunction::ComputeGlobalTimeStep(void * itkNotUsed(gd)) cons return this->GetTimeStep(); } -/** - * Update the solution at pixels which lies on the data boundary. - */ template typename CurvatureFlowFunction::PixelType CurvatureFlowFunction::ComputeUpdate(const NeighborhoodType & it, diff --git a/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowImageFilter.hxx b/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowImageFilter.hxx index 657d8a27aba..fe5a754e409 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowImageFilter.hxx +++ b/Modules/Filtering/CurvatureFlow/include/itkCurvatureFlowImageFilter.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template CurvatureFlowImageFilter::CurvatureFlowImageFilter() { @@ -37,9 +35,6 @@ CurvatureFlowImageFilter::CurvatureFlowImageFilter() this->SetDifferenceFunction(static_cast(cffp.GetPointer())); } -/** - * Standard PrintSelf method. - */ template void CurvatureFlowImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -49,9 +44,6 @@ CurvatureFlowImageFilter::PrintSelf(std::ostream & os os << std::endl; } -/** - * Initialize the state of filter and equation before each iteration. - */ template void CurvatureFlowImageFilter::InitializeIteration() @@ -77,9 +69,6 @@ CurvatureFlowImageFilter::InitializeIteration() } } -/** - * GenerateInputRequestedRegion - */ template void CurvatureFlowImageFilter::GenerateInputRequestedRegion() @@ -101,9 +90,6 @@ CurvatureFlowImageFilter::GenerateInputRequestedRegio inputPtr->SetRequestedRegion(outputPtr->GetRequestedRegion()); } -/** - * EnlargeOutputRequestedRegion - */ template void CurvatureFlowImageFilter::EnlargeOutputRequestedRegion(DataObject * ptr) diff --git a/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.h b/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.h index 95debfe45ca..41fbb52caea 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.h +++ b/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.h @@ -87,8 +87,7 @@ class ITK_TEMPLATE_EXPORT MinMaxCurvatureFlowFunction : public CurvatureFlowFunc return GetRadiusValueType(); } - /** This method computes the solution update for each pixel that does not - * lie on a the data set boundary. */ + /** Compute the solution update for each pixel that does not lie on a the data set boundary. */ PixelType ComputeUpdate(const NeighborhoodType & it, void * globalData, @@ -116,8 +115,7 @@ class ITK_TEMPLATE_EXPORT MinMaxCurvatureFlowFunction : public CurvatureFlowFunc struct Dispatch : public DispatchBase {}; - /** This method computes the threshold by averaging the intensity - * in direction perpendicular to the image gradient. */ + /** Compute the threshold by averaging the intensity in direction perpendicular to the image gradient. */ PixelType ComputeThreshold(const Dispatch<2> &, const NeighborhoodType & it) const; diff --git a/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.hxx b/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.hxx index 955fbd8523c..7edee2df6a2 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.hxx +++ b/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowFunction.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Constructor - */ + template MinMaxCurvatureFlowFunction::MinMaxCurvatureFlowFunction() { @@ -33,9 +31,6 @@ MinMaxCurvatureFlowFunction::MinMaxCurvatureFlowFunction() this->SetStencilRadius(2); } -/** - * Set the stencil radius. - */ template void MinMaxCurvatureFlowFunction::SetStencilRadius(const RadiusValueType value) @@ -58,9 +53,6 @@ MinMaxCurvatureFlowFunction::SetStencilRadius(const RadiusValueType valu this->InitializeStencilOperator(); } -/** - * Initialize the stencil operator. - */ template void MinMaxCurvatureFlowFunction::InitializeStencilOperator() @@ -123,10 +115,6 @@ MinMaxCurvatureFlowFunction::InitializeStencilOperator() } } -/** - * Compute the threshold by averaging the image intensity in - * the direction perpendicular to the image gradient. - */ template auto MinMaxCurvatureFlowFunction::ComputeThreshold(const DispatchBase &, const NeighborhoodType & it) const @@ -224,10 +212,6 @@ MinMaxCurvatureFlowFunction::ComputeThreshold(const DispatchBase &, cons return threshold; } -/** - * Compute the threshold by averaging the image intensity in - * the direction perpendicular to the image gradient. - */ template auto MinMaxCurvatureFlowFunction::ComputeThreshold(const Dispatch<2> &, const NeighborhoodType & it) const @@ -290,10 +274,6 @@ MinMaxCurvatureFlowFunction::ComputeThreshold(const Dispatch<2> &, const return threshold; } -/* - * Compute the threshold by averaging the image intensity in - * the direction perpendicular to the image gradient. - */ template auto MinMaxCurvatureFlowFunction::ComputeThreshold(const Dispatch<3> &, const NeighborhoodType & it) const @@ -411,9 +391,6 @@ MinMaxCurvatureFlowFunction::ComputeThreshold(const Dispatch<3> &, const return threshold; } -/* - * Update the solution at pixels which lies on the data boundary. - */ template typename MinMaxCurvatureFlowFunction::PixelType MinMaxCurvatureFlowFunction::ComputeUpdate(const NeighborhoodType & it, diff --git a/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowImageFilter.hxx b/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowImageFilter.hxx index f14be094901..690a57d8e48 100644 --- a/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowImageFilter.hxx +++ b/Modules/Filtering/CurvatureFlow/include/itkMinMaxCurvatureFlowImageFilter.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Constructor - */ + template MinMaxCurvatureFlowImageFilter::MinMaxCurvatureFlowImageFilter() { @@ -37,9 +35,6 @@ MinMaxCurvatureFlowImageFilter::MinMaxCurvatureFlowIm this->SetDifferenceFunction(static_cast(cffp.GetPointer())); } -/* - * Standard PrintSelf method. - */ template void MinMaxCurvatureFlowImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -48,9 +43,6 @@ MinMaxCurvatureFlowImageFilter::PrintSelf(std::ostrea os << indent << "StencilRadius: " << m_StencilRadius << std::endl; } -/* - * Initialize the state of filter and equation before each iteration. - */ template void MinMaxCurvatureFlowImageFilter::InitializeIteration() diff --git a/Modules/Filtering/DisplacementField/include/itkBSplineExponentialDiffeomorphicTransform.hxx b/Modules/Filtering/DisplacementField/include/itkBSplineExponentialDiffeomorphicTransform.hxx index 8a23832d643..f707d11eafd 100644 --- a/Modules/Filtering/DisplacementField/include/itkBSplineExponentialDiffeomorphicTransform.hxx +++ b/Modules/Filtering/DisplacementField/include/itkBSplineExponentialDiffeomorphicTransform.hxx @@ -27,9 +27,6 @@ namespace itk { -/** - * Constructor - */ template BSplineExponentialDiffeomorphicTransform::BSplineExponentialDiffeomorphicTransform() @@ -38,9 +35,6 @@ BSplineExponentialDiffeomorphicTransform::BSpl this->m_NumberOfControlPointsForTheUpdateField.Fill(4); } -/** - * set mesh size for update field - */ template void BSplineExponentialDiffeomorphicTransform::SetMeshSizeForTheUpdateField( @@ -54,9 +48,6 @@ BSplineExponentialDiffeomorphicTransform::SetM this->SetNumberOfControlPointsForTheUpdateField(numberOfControlPoints); } -/** - * set mesh size for update field - */ template void BSplineExponentialDiffeomorphicTransform::SetMeshSizeForTheConstantVelocityField( @@ -193,9 +184,6 @@ BSplineExponentialDiffeomorphicTransform::BSpl return smoothField; } -/** - * Standard "PrintSelf" method - */ template void BSplineExponentialDiffeomorphicTransform::PrintSelf(std::ostream & os, diff --git a/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h b/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h index 859eb122930..4c93c7af18c 100644 --- a/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h +++ b/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h @@ -188,8 +188,9 @@ class ITK_TEMPLATE_EXPORT BSplineSmoothingOnUpdateDisplacementFieldTransform typename LightObject::Pointer InternalClone() const override; - /** - * Smooth the displacement field using B-splines. + /** Smooth the displacement field using B-splines. + * + * Sets displacement field and projects it onto the space of B-spline transforms. */ DisplacementFieldPointer BSplineSmoothDisplacementField(const DisplacementFieldType *, const ArrayType &); diff --git a/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.hxx b/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.hxx index cd2288affc6..4fcc1a5a20b 100644 --- a/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.hxx +++ b/Modules/Filtering/DisplacementField/include/itkBSplineSmoothingOnUpdateDisplacementFieldTransform.hxx @@ -27,9 +27,6 @@ namespace itk { -/** - * Constructor - */ template BSplineSmoothingOnUpdateDisplacementFieldTransform::BSplineSmoothingOnUpdateDisplacementFieldTransform() @@ -39,9 +36,6 @@ BSplineSmoothingOnUpdateDisplacementFieldTransformm_NumberOfControlPointsForTheTotalField.Fill(0); } -/** - * set mesh size for update field - */ template void BSplineSmoothingOnUpdateDisplacementFieldTransform::SetMeshSizeForTheUpdateField( @@ -55,9 +49,6 @@ BSplineSmoothingOnUpdateDisplacementFieldTransformSetNumberOfControlPointsForTheUpdateField(numberOfControlPoints); } -/** - * set mesh size for total field - */ template void BSplineSmoothingOnUpdateDisplacementFieldTransform::SetMeshSizeForTheTotalField( @@ -169,9 +160,6 @@ BSplineSmoothingOnUpdateDisplacementFieldTransform typename BSplineSmoothingOnUpdateDisplacementFieldTransform::DisplacementFieldPointer BSplineSmoothingOnUpdateDisplacementFieldTransform::BSplineSmoothDisplacementField( diff --git a/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.h b/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.h index 15e483ae4ef..e5b700ce620 100644 --- a/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.h +++ b/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.h @@ -138,11 +138,11 @@ class ITK_TEMPLATE_EXPORT ConstantVelocityFieldTransform void UpdateTransformParameters(const DerivativeType & update, ScalarType factor = 1.0) override; - /** Return an inverse of this transform. */ + /** Get the inverse of the transform. */ bool GetInverse(Self * inverse) const; - /** Return an inverse of this transform. */ + /** Get the inverse of the transform. */ InverseTransformBasePointer GetInverseTransform() const override; diff --git a/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.hxx b/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.hxx index 371ee9d2472..8f77d200846 100644 --- a/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.hxx +++ b/Modules/Filtering/DisplacementField/include/itkConstantVelocityFieldTransform.hxx @@ -27,9 +27,6 @@ namespace itk { -/** - * Constructor - */ template ConstantVelocityFieldTransform::ConstantVelocityFieldTransform() : m_ConstantVelocityField(nullptr) @@ -69,9 +66,6 @@ ConstantVelocityFieldTransform::UpdateTransfor this->IntegrateVelocityField(); } -/** - * return an inverse transformation - */ template bool ConstantVelocityFieldTransform::GetInverse(Self * inverse) const @@ -94,7 +88,6 @@ ConstantVelocityFieldTransform::GetInverse(Sel } } -// Return an inverse of this transform template auto ConstantVelocityFieldTransform::GetInverseTransform() const diff --git a/Modules/Filtering/DisplacementField/include/itkTimeVaryingBSplineVelocityFieldTransform.hxx b/Modules/Filtering/DisplacementField/include/itkTimeVaryingBSplineVelocityFieldTransform.hxx index 5ec24614f3f..ca805672757 100644 --- a/Modules/Filtering/DisplacementField/include/itkTimeVaryingBSplineVelocityFieldTransform.hxx +++ b/Modules/Filtering/DisplacementField/include/itkTimeVaryingBSplineVelocityFieldTransform.hxx @@ -29,9 +29,6 @@ namespace itk { -/** - * Constructor - */ template TimeVaryingBSplineVelocityFieldTransform::TimeVaryingBSplineVelocityFieldTransform() { diff --git a/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.h b/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.h index 4efccc71db8..931519321fa 100644 --- a/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.h +++ b/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.h @@ -156,11 +156,11 @@ class ITK_TEMPLATE_EXPORT VelocityFieldTransform : public DisplacementFieldTrans void UpdateTransformParameters(const DerivativeType & update, ScalarType factor = 1.0) override; - /** Return an inverse of this transform. */ + /** Get the inverse of the transform. */ bool GetInverse(Self * inverse) const; - /** Return an inverse of this transform. */ + /** Get the inverse of the transform. */ InverseTransformBasePointer GetInverseTransform() const override; diff --git a/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.hxx b/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.hxx index a82968fc887..6a1ce22d6e4 100644 --- a/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.hxx +++ b/Modules/Filtering/DisplacementField/include/itkVelocityFieldTransform.hxx @@ -26,9 +26,6 @@ namespace itk { -/** - * Constructor - */ template VelocityFieldTransform::VelocityFieldTransform() { @@ -67,9 +64,6 @@ VelocityFieldTransform::UpdateTransformParamet this->IntegrateVelocityField(); } -/** - * return an inverse transformation - */ template bool VelocityFieldTransform::GetInverse(Self * inverse) const @@ -92,7 +86,6 @@ VelocityFieldTransform::GetInverse(Self * inve } } -// Return an inverse of this transform template auto VelocityFieldTransform::GetInverseTransform() const -> InverseTransformBasePointer diff --git a/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.h b/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.h index 9d95d01b6bd..c570ad0dfc7 100644 --- a/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.h +++ b/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.h @@ -172,6 +172,7 @@ class ITK_TEMPLATE_EXPORT IsoContourDistanceImageFilter : public ImageToImageFil void ThreadedGenerateDataBand(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId); + /** Split the band if the narrowband mode is used. */ void BeforeThreadedGenerateData() override; diff --git a/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.hxx b/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.hxx index c2411388802..00f342fa551 100644 --- a/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.hxx +++ b/Modules/Filtering/DistanceMap/include/itkIsoContourDistanceImageFilter.hxx @@ -24,9 +24,7 @@ namespace itk { -/** - * Default constructor. - */ + template IsoContourDistanceImageFilter::IsoContourDistanceImageFilter() { @@ -38,9 +36,6 @@ IsoContourDistanceImageFilter::IsoContourDistanceImag m_NarrowBand = nullptr; } -/** - * Set the input narrowband container. - */ template void IsoContourDistanceImageFilter::SetNarrowBand(NarrowBandType * ptr) @@ -52,23 +47,18 @@ IsoContourDistanceImageFilter::SetNarrowBand(NarrowBa } } -/** - * PrintSelf method. - */ template void IsoContourDistanceImageFilter::PrintSelf(std::ostream & os, Indent indent) const { Superclass::PrintSelf(os, indent); + os << indent << "Narrowbanding: " << m_NarrowBanding << std::endl; os << indent << "LevelSetValue: " << m_LevelSetValue << std::endl; os << indent << "FarValue: " << m_FarValue << std::endl; os << std::endl; } -/** - * GenerateInputRequestedRegion method. - */ template void IsoContourDistanceImageFilter::GenerateInputRequestedRegion() @@ -77,9 +67,6 @@ IsoContourDistanceImageFilter::GenerateInputRequested this->Superclass::GenerateInputRequestedRegion(); } -/** - * EnlargeOutputRequestedRegion method. - */ template void IsoContourDistanceImageFilter::EnlargeOutputRequestedRegion(DataObject * output) @@ -157,10 +144,6 @@ IsoContourDistanceImageFilter::ThreaderFullCallback(v return ITK_THREAD_RETURN_DEFAULT_VALUE; } -/** - * Before ThreadedGenerateData: - * Split the band if we use narrowband mode - */ template void IsoContourDistanceImageFilter::BeforeThreadedGenerateData() @@ -181,8 +164,6 @@ IsoContourDistanceImageFilter::BeforeThreadedGenerate } } -//---------------------------------------------------------------------------- -// The execute method created by the subclass. template void IsoContourDistanceImageFilter::ThreadedGenerateData( @@ -223,7 +204,6 @@ IsoContourDistanceImageFilter::ThreadedGenerateData( } } -// The execute method created by the subclass. template void IsoContourDistanceImageFilter::ThreadedGenerateDataFull( @@ -266,8 +246,6 @@ IsoContourDistanceImageFilter::ThreadedGenerateDataFu } } - -// The execute method created by the subclass. template void IsoContourDistanceImageFilter::ThreadedGenerateDataBand( diff --git a/Modules/Filtering/FastMarching/include/itkFastMarchingUpwindGradientImageFilter.hxx b/Modules/Filtering/FastMarching/include/itkFastMarchingUpwindGradientImageFilter.hxx index 07d6b6d6be7..e803c98186e 100644 --- a/Modules/Filtering/FastMarching/include/itkFastMarchingUpwindGradientImageFilter.hxx +++ b/Modules/Filtering/FastMarching/include/itkFastMarchingUpwindGradientImageFilter.hxx @@ -25,9 +25,7 @@ namespace itk { -/** - * - */ + template FastMarchingUpwindGradientImageFilter::FastMarchingUpwindGradientImageFilter() { @@ -41,9 +39,6 @@ FastMarchingUpwindGradientImageFilter::FastMarchingUpwin m_NumberOfTargets = 0; } -/** - * - */ template void FastMarchingUpwindGradientImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -83,9 +78,6 @@ FastMarchingUpwindGradientImageFilter::VerifyPreconditio } } -/** - * - */ template void FastMarchingUpwindGradientImageFilter::Initialize(LevelSetImageType * output) @@ -250,9 +242,6 @@ FastMarchingUpwindGradientImageFilter::UpdateNeighbors(c } } -/** - * - */ template void FastMarchingUpwindGradientImageFilter::ComputeGradient( diff --git a/Modules/Filtering/GPUAnisotropicSmoothing/include/itkGPUAnisotropicDiffusionImageFilter.hxx b/Modules/Filtering/GPUAnisotropicSmoothing/include/itkGPUAnisotropicDiffusionImageFilter.hxx index 641dfe5fd31..6700c9d8aed 100644 --- a/Modules/Filtering/GPUAnisotropicSmoothing/include/itkGPUAnisotropicDiffusionImageFilter.hxx +++ b/Modules/Filtering/GPUAnisotropicSmoothing/include/itkGPUAnisotropicDiffusionImageFilter.hxx @@ -23,7 +23,6 @@ namespace itk { -/** Prepare for the iteration process. */ template void GPUAnisotropicDiffusionImageFilter::InitializeIteration() diff --git a/Modules/Filtering/GPUThresholding/include/itkGPUBinaryThresholdImageFilter.hxx b/Modules/Filtering/GPUThresholding/include/itkGPUBinaryThresholdImageFilter.hxx index 33bc17f570c..d79d0a1ffba 100644 --- a/Modules/Filtering/GPUThresholding/include/itkGPUBinaryThresholdImageFilter.hxx +++ b/Modules/Filtering/GPUThresholding/include/itkGPUBinaryThresholdImageFilter.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template GPUBinaryThresholdImageFilter::GPUBinaryThresholdImageFilter() { diff --git a/Modules/Filtering/ImageFeature/include/itkHessian3DToVesselnessMeasureImageFilter.hxx b/Modules/Filtering/ImageFeature/include/itkHessian3DToVesselnessMeasureImageFilter.hxx index f361e29647b..307667df1a4 100644 --- a/Modules/Filtering/ImageFeature/include/itkHessian3DToVesselnessMeasureImageFilter.hxx +++ b/Modules/Filtering/ImageFeature/include/itkHessian3DToVesselnessMeasureImageFilter.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Constructor - */ + template Hessian3DToVesselnessMeasureImageFilter::Hessian3DToVesselnessMeasureImageFilter() { diff --git a/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.h b/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.h index b471e9263cf..c188ed0e0d8 100644 --- a/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.h +++ b/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.h @@ -112,7 +112,7 @@ class ITK_TEMPLATE_EXPORT HessianRecursiveGaussianImageFilter : public ImageToIm /** Method for creation through the object factory. */ itkNewMacro(Self); - /** Set Sigma value. Sigma is measured in the units of image spacing. */ + /** Set/Get Sigma value. Sigma is measured in the units of image spacing. */ void SetSigma(RealType sigma); RealType diff --git a/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.hxx b/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.hxx index b57489a65d1..28beca53d2b 100644 --- a/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.hxx +++ b/Modules/Filtering/ImageFeature/include/itkHessianRecursiveGaussianImageFilter.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Constructor - */ + template HessianRecursiveGaussianImageFilter::HessianRecursiveGaussianImageFilter() { @@ -79,9 +77,6 @@ HessianRecursiveGaussianImageFilter::HessianRecursive this->SetSigma(1.0); } -/** - * Set value of Sigma - */ template void HessianRecursiveGaussianImageFilter::SetSigma(RealType sigma) @@ -98,9 +93,6 @@ HessianRecursiveGaussianImageFilter::SetSigma(RealTyp this->Modified(); } -/** - * Get value of Sigma - */ template auto HessianRecursiveGaussianImageFilter::GetSigma() const -> RealType @@ -108,9 +100,6 @@ HessianRecursiveGaussianImageFilter::GetSigma() const return m_DerivativeFilterA->GetSigma(); } -/** - * Set Normalize Across Scale Space - */ template void HessianRecursiveGaussianImageFilter::SetNormalizeAcrossScale(bool normalize) @@ -125,9 +114,6 @@ HessianRecursiveGaussianImageFilter::SetNormalizeAcro this->Modified(); } -// -// -// template void HessianRecursiveGaussianImageFilter::GenerateInputRequestedRegion() @@ -145,9 +131,6 @@ HessianRecursiveGaussianImageFilter::GenerateInputReq } } -// -// -// template void HessianRecursiveGaussianImageFilter::EnlargeOutputRequestedRegion(DataObject * output) @@ -160,9 +143,6 @@ HessianRecursiveGaussianImageFilter::EnlargeOutputReq } } -/** - * Compute filter for Gaussian kernel - */ template void HessianRecursiveGaussianImageFilter::GenerateData() diff --git a/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.h b/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.h index f35c0c12eb7..d2721105c07 100644 --- a/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.h +++ b/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.h @@ -99,7 +99,7 @@ class ITK_TEMPLATE_EXPORT LaplacianRecursiveGaussianImageFilter : public ImageTo /** Runtime information support. */ itkTypeMacro(LaplacianRecursiveGaussianImageFilter, ImageToImageFilter); - /** Set Sigma value. Sigma is measured in the units of image spacing. */ + /** Set/Get Sigma value. Sigma is measured in the units of image spacing. */ void SetSigma(RealType sigma); RealType diff --git a/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.hxx b/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.hxx index bfdeebe6491..921ef7df492 100644 --- a/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.hxx +++ b/Modules/Filtering/ImageFeature/include/itkLaplacianRecursiveGaussianImageFilter.hxx @@ -25,9 +25,7 @@ namespace itk { -/** - * Constructor - */ + template LaplacianRecursiveGaussianImageFilter::LaplacianRecursiveGaussianImageFilter() { @@ -63,9 +61,6 @@ LaplacianRecursiveGaussianImageFilter::LaplacianRecur this->SetSigma(1.0); } -/** - * Set value of Sigma - */ template void LaplacianRecursiveGaussianImageFilter::SetSigma(RealType sigma) @@ -79,9 +74,6 @@ LaplacianRecursiveGaussianImageFilter::SetSigma(RealT this->Modified(); } -/** - * Get value of Sigma - */ template auto LaplacianRecursiveGaussianImageFilter::GetSigma() const -> RealType @@ -89,9 +81,6 @@ LaplacianRecursiveGaussianImageFilter::GetSigma() con return m_DerivativeFilter->GetSigma(); } -/** - * Set Normalize Across Scale Space - */ template void LaplacianRecursiveGaussianImageFilter::SetNormalizeAcrossScale(bool normalize) @@ -107,10 +96,6 @@ LaplacianRecursiveGaussianImageFilter::SetNormalizeAc this->Modified(); } - -// -// -// template void LaplacianRecursiveGaussianImageFilter::EnlargeOutputRequestedRegion(DataObject * output) @@ -123,9 +108,6 @@ LaplacianRecursiveGaussianImageFilter::EnlargeOutputR } } -/** - * Compute filter for Gaussian kernel - */ template void LaplacianRecursiveGaussianImageFilter::GenerateData() diff --git a/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.h b/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.h index 695dbefd3d8..577967734d8 100644 --- a/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.h +++ b/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.h @@ -162,7 +162,8 @@ class ITK_TEMPLATE_EXPORT UnaryGeneratorImageFilter : public InPlaceImageFilter< * execution model. The original documentation of this method is * below. * - * \sa ProcessObject::GenerateOutputInformation() */ + * \sa ProcessObject::GenerateOutputInformation() + */ void GenerateOutputInformation() override; diff --git a/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.hxx b/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.hxx index 0d46a2f208d..fac10885849 100644 --- a/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.hxx +++ b/Modules/Filtering/ImageFilterBase/include/itkUnaryGeneratorImageFilter.hxx @@ -24,9 +24,7 @@ namespace itk { -/** - * Constructor - */ + template UnaryGeneratorImageFilter::UnaryGeneratorImageFilter() { @@ -35,15 +33,6 @@ UnaryGeneratorImageFilter::UnaryGeneratorImageFilter( this->DynamicMultiThreadingOn(); } -/** - * UnaryGeneratorImageFilter can produce an image which is a different resolution - * than its input image. As such, UnaryGeneratorImageFilter needs to provide an - * implementation for GenerateOutputInformation() in order to inform - * the pipeline execution model. The original documentation of this - * method is below. - * - * \sa ProcessObject::GenerateOutputInformation() - */ template void UnaryGeneratorImageFilter::GenerateOutputInformation() diff --git a/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.h b/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.h index 207909ccf11..c1ddcf11eb0 100644 --- a/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.h +++ b/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.h @@ -85,21 +85,19 @@ class ITK_TEMPLATE_EXPORT LabelOverlayImageFilter /** Method for creation through the object factory. */ itkNewMacro(Self); - /** Set the label image */ + /** Set/Get the label image. */ void SetLabelImage(const TLabelImage * input); - - /** Get the label image */ const LabelImageType * GetLabelImage() const; /** Set/Get the opacity of the colored label image. The value must be - * between 0 and 1 + * between 0 and 1. */ itkSetMacro(Opacity, double); itkGetConstReferenceMacro(Opacity, double); - /** Set/Get the background value */ + /** Set/Get the background value. */ itkSetMacro(BackgroundValue, LabelPixelType); itkGetConstReferenceMacro(BackgroundValue, LabelPixelType); @@ -111,18 +109,18 @@ class ITK_TEMPLATE_EXPORT LabelOverlayImageFilter // End concept checking #endif - /** Empty the color LUT container */ + /** Empty the color LUT container. */ void ResetColors(); - /** Get number of colors in the LUT container */ + /** Get number of colors in the LUT container. */ unsigned int GetNumberOfColors() const; - /** type of the color component */ + /** type of the color component. */ using ComponentType = typename OutputPixelType::ComponentType; - /** Add color to the LUT container */ + /** Add color to the LUT container. */ void AddColor(ComponentType r, ComponentType g, ComponentType b); diff --git a/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.hxx b/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.hxx index 31296d043ea..5d645c85c60 100644 --- a/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.hxx +++ b/Modules/Filtering/ImageFusion/include/itkLabelOverlayImageFilter.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor method - */ + template LabelOverlayImageFilter::LabelOverlayImageFilter() { @@ -51,10 +49,6 @@ LabelOverlayImageFilter::GenerateOutputI } } - -/** - * Destructor method - */ template void LabelOverlayImageFilter::BeforeThreadedGenerateData() @@ -64,9 +58,6 @@ LabelOverlayImageFilter::BeforeThreadedG this->SetFunctor(this->GetFunctor()); } -/** - * Set Label Image - */ template void LabelOverlayImageFilter::SetLabelImage(const TLabelImage * input) @@ -74,9 +65,6 @@ LabelOverlayImageFilter::SetLabelImage(c this->SetInput2(input); } -/** - * Get Label Image - */ template auto LabelOverlayImageFilter::GetLabelImage() const -> const LabelImageType * @@ -84,9 +72,6 @@ LabelOverlayImageFilter::GetLabelImage() return itkDynamicCastInDebugMode(const_cast(this->ProcessObject::GetInput(1))); } -/** - * Get number of colors in the LUT container - */ template unsigned int LabelOverlayImageFilter::GetNumberOfColors() const @@ -94,9 +79,6 @@ LabelOverlayImageFilter::GetNumberOfColo return this->GetFunctor().GetNumberOfColors(); } -/** - * Empty the color LUT container - */ template void LabelOverlayImageFilter::ResetColors() @@ -104,9 +86,6 @@ LabelOverlayImageFilter::ResetColors() this->GetFunctor().ResetColors(); } -/** - * Add a color to the LUT container - */ template void LabelOverlayImageFilter::AddColor(ComponentType r, @@ -116,9 +95,6 @@ LabelOverlayImageFilter::AddColor(Compon this->GetFunctor().AddColor(r, g, b); } -/** - * Standard PrintSelf method - */ template void LabelOverlayImageFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Filtering/ImageGradient/include/itkGradientImageFilter.hxx b/Modules/Filtering/ImageGradient/include/itkGradientImageFilter.hxx index ee2b705fe21..a355e52a337 100644 --- a/Modules/Filtering/ImageGradient/include/itkGradientImageFilter.hxx +++ b/Modules/Filtering/ImageGradient/include/itkGradientImageFilter.hxx @@ -28,9 +28,7 @@ namespace itk { -// -// Constructor -// + template GradientImageFilter::GradientImageFilter() { @@ -42,9 +40,6 @@ GradientImageFilterThreaderUpdateProgressOff(); } -// -// Destructor -// template GradientImageFilter::~GradientImageFilter() { diff --git a/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.h b/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.h index 131eb246469..ef1400d037f 100644 --- a/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.h +++ b/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.h @@ -110,13 +110,14 @@ class ITK_TEMPLATE_EXPORT GradientMagnitudeRecursiveGaussianImageFilter /** Runtime information support. */ itkTypeMacro(GradientMagnitudeRecursiveGaussianImageFilter, InPlaceImageFilter); - /** Set Sigma value. Sigma is measured in the units of image spacing. */ + /** Set/Get Sigma value. Sigma is measured in the units of image spacing. */ void SetSigma(RealType sigma); RealType GetSigma(); - /** Define which normalization factor will be used for the Gaussian + /** Set/Get the normalization factor that will be used for the Gaussian. + * * \sa RecursiveGaussianImageFilter::SetNormalizeAcrossScale */ void diff --git a/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.hxx b/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.hxx index 1d7c91dba4e..f9d7e8ecb5a 100644 --- a/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.hxx +++ b/Modules/Filtering/ImageGradient/include/itkGradientMagnitudeRecursiveGaussianImageFilter.hxx @@ -24,9 +24,7 @@ namespace itk { -/** - * Constructor - */ + template GradientMagnitudeRecursiveGaussianImageFilter::GradientMagnitudeRecursiveGaussianImageFilter() @@ -76,9 +74,6 @@ GradientMagnitudeRecursiveGaussianImageFilter::PrintS os << indent << "Sigma: " << m_DerivativeFilter->GetSigma() << std::endl; } -/** - * Set value of Sigma - */ template void GradientMagnitudeRecursiveGaussianImageFilter::SetSigma(RealType sigma) @@ -117,9 +112,6 @@ GradientMagnitudeRecursiveGaussianImageFilter::SetNum m_SqrtFilter->SetNumberOfWorkUnits(nb); } -/** - * Set Normalize Across Scale Space - */ template void GradientMagnitudeRecursiveGaussianImageFilter::SetNormalizeAcrossScale(bool normalize) @@ -138,9 +130,6 @@ GradientMagnitudeRecursiveGaussianImageFilter::SetNor } } -// -// -// template void GradientMagnitudeRecursiveGaussianImageFilter::GenerateInputRequestedRegion() @@ -158,9 +147,6 @@ GradientMagnitudeRecursiveGaussianImageFilter::Genera } } -// -// -// template void GradientMagnitudeRecursiveGaussianImageFilter::EnlargeOutputRequestedRegion( @@ -174,9 +160,6 @@ GradientMagnitudeRecursiveGaussianImageFilter::Enlarg } } -/** - * Compute filter for Gaussian kernel - */ template void GradientMagnitudeRecursiveGaussianImageFilter::GenerateData() diff --git a/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.h b/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.h index f058c85d703..d8ff08f6604 100644 --- a/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.h +++ b/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.h @@ -129,7 +129,7 @@ class ITK_TEMPLATE_EXPORT GradientRecursiveGaussianImageFilter : public ImageToI /** Runtime information support. */ itkTypeMacro(GradientRecursiveGaussianImageFilter, ImageToImageFilter); - /** Set Sigma value. Sigma is measured in the units of image spacing. */ + /** Set/Get the Sigma value. Sigma is measured in the units of image spacing. */ void SetSigmaArray(const SigmaArrayType & sigma); void @@ -137,6 +137,8 @@ class ITK_TEMPLATE_EXPORT GradientRecursiveGaussianImageFilter : public ImageToI SigmaArrayType GetSigmaArray() const; + + /** Get the value of Sigma along the first dimension. */ ScalarRealType GetSigma() const; diff --git a/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.hxx b/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.hxx index 3c80fa888fc..4a3162e3cd9 100644 --- a/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.hxx +++ b/Modules/Filtering/ImageGradient/include/itkGradientRecursiveGaussianImageFilter.hxx @@ -24,9 +24,7 @@ namespace itk { -/** - * Constructor - */ + template GradientRecursiveGaussianImageFilter::GradientRecursiveGaussianImageFilter() { @@ -75,9 +73,6 @@ GradientRecursiveGaussianImageFilter::GradientRecursi this->SetSigma(1.0); } -/** - * Set value of Sigma along all dimensions. - */ template void GradientRecursiveGaussianImageFilter::SetSigma(ScalarRealType sigma) @@ -86,9 +81,6 @@ GradientRecursiveGaussianImageFilter::SetSigma(Scalar this->SetSigmaArray(sigmas); } -/** - * Set value of Sigma array. - */ template void GradientRecursiveGaussianImageFilter::SetSigmaArray(const SigmaArrayType & sigma) @@ -108,9 +100,6 @@ GradientRecursiveGaussianImageFilter::SetSigmaArray(c } } -/** - * Get the Sigma array. - */ template auto GradientRecursiveGaussianImageFilter::GetSigmaArray() const -> SigmaArrayType @@ -118,9 +107,6 @@ GradientRecursiveGaussianImageFilter::GetSigmaArray() return m_Sigma; } -/** - * Get value of Sigma. Returns the sigma along the first dimension. - */ template auto GradientRecursiveGaussianImageFilter::GetSigma() const -> ScalarRealType @@ -128,9 +114,6 @@ GradientRecursiveGaussianImageFilter::GetSigma() cons return m_Sigma[0]; } -/** - * Set Normalize Across Scale Space - */ template void GradientRecursiveGaussianImageFilter::SetNormalizeAcrossScale(bool normalize) @@ -148,9 +131,6 @@ GradientRecursiveGaussianImageFilter::SetNormalizeAcr this->Modified(); } -// -// -// template void GradientRecursiveGaussianImageFilter::GenerateInputRequestedRegion() @@ -168,9 +148,6 @@ GradientRecursiveGaussianImageFilter::GenerateInputRe } } -// -// -// template void GradientRecursiveGaussianImageFilter::EnlargeOutputRequestedRegion(DataObject * output) @@ -183,9 +160,6 @@ GradientRecursiveGaussianImageFilter::EnlargeOutputRe } } -/** - * Compute filter for Gaussian kernel - */ template void GradientRecursiveGaussianImageFilter::GenerateData() diff --git a/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.h b/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.h index 62c4e467e0e..8b9f2ebc6cc 100644 --- a/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.h +++ b/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.h @@ -146,14 +146,22 @@ class ITK_TEMPLATE_EXPORT BSplineResampleImageFilterBase : public ImageToImageFi virtual void InitializePyramidSplineFilter(int SplineOrder); - /** The basic operator for reducing a line of data by a factor of 2 */ + /** Reduce the input data vector by a factor of 2 and writes the results to the location specified by the output + * Iterator. + * + * \p inTraverseSize is the size of the input vector. + */ virtual void Reduce1DImage(const std::vector & in, OutputImageIterator & out, unsigned int inTraverseSize, ProgressReporter & progress); - /** The basic operator for expanding a line of data by a factor of 2 */ + /** Expand the input data vector by a factor of 2 and writes the results to the location specified by the output + * Iterator + * + * \p inTraverseSize is the size of the in vector. + */ virtual void Expand1DImage(const std::vector & in, OutputImageIterator & out, @@ -173,12 +181,11 @@ class ITK_TEMPLATE_EXPORT BSplineResampleImageFilterBase : public ImageToImageFi std::vector m_H; // upsampling filter coefficients private: - // Resizes m_Scratch Variable based on image sizes + /** Allocate scratch space based on image sizes. */ void InitializeScratch(SizeType DataLength); - // Copies a line of data from the input to the m_Scratch for subsequent - // processing + /** Copy a line of data from the input to the m_Scratch for subsequent processing. */ void CopyInputLineToScratch(ConstInputImageIterator & Iter); diff --git a/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.hxx b/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.hxx index 0887b395e3f..7d6713846c6 100644 --- a/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.hxx +++ b/Modules/Filtering/ImageGrid/include/itkBSplineResampleImageFilterBase.hxx @@ -31,9 +31,7 @@ namespace itk { -/** - * Constructor - */ + template BSplineResampleImageFilterBase::BSplineResampleImageFilterBase() { @@ -43,9 +41,6 @@ BSplineResampleImageFilterBase::BSplineResampleImageF this->SetSplineOrder(0); } -/** - * Standard "PrintSelf" method - */ template void BSplineResampleImageFilterBase::PrintSelf(std::ostream & os, Indent indent) const @@ -54,9 +49,6 @@ BSplineResampleImageFilterBase::PrintSelf(std::ostrea os << indent << "Spline Order: " << m_SplineOrder << std::endl; } -/** - * Initializes the Pyramid Spline Filter parameters for an "l2" filter - */ template void BSplineResampleImageFilterBase::InitializePyramidSplineFilter(int SplineOrder) @@ -180,10 +172,6 @@ BSplineResampleImageFilterBase::SetSplineOrder(int sp this->Modified(); } -/** Reduce1DImage - reduces the vector of data (in) by a - * factor of 2 and writes the results to the location specified - * by the Iterator (out). inTraverseSize is the size of the in vector. - */ template void BSplineResampleImageFilterBase::Reduce1DImage(const std::vector & in, @@ -263,10 +251,6 @@ BSplineResampleImageFilterBase::Reduce1DImage(const s } } -/** Expand1DImage - expands the vector of data (in) by a - * factor of 2 and writes the results to the location specified - * by the Iterator (out). inTraverseSize is the size of the in vector. - */ template void BSplineResampleImageFilterBase::Expand1DImage(const std::vector & in, @@ -337,8 +321,6 @@ BSplineResampleImageFilterBase::Expand1DImage(const s } } -/** Reduce an Image by a factor of 2 in each dimension. - */ template void BSplineResampleImageFilterBase::ReduceNDImage(OutputImageIterator & outItr) @@ -454,8 +436,6 @@ BSplineResampleImageFilterBase::ReduceNDImage(OutputI } } -/** Expand an Image by a factor of 2 in each dimension. - */ template void BSplineResampleImageFilterBase::ExpandNDImage(OutputImageIterator & outItr) @@ -570,7 +550,6 @@ BSplineResampleImageFilterBase::ExpandNDImage(OutputI } } -// Allocate scratch space template void BSplineResampleImageFilterBase::InitializeScratch(SizeType DataLength) diff --git a/Modules/Filtering/ImageGrid/include/itkChangeInformationImageFilter.hxx b/Modules/Filtering/ImageGrid/include/itkChangeInformationImageFilter.hxx index cd276be34ed..80cb9d1f119 100644 --- a/Modules/Filtering/ImageGrid/include/itkChangeInformationImageFilter.hxx +++ b/Modules/Filtering/ImageGrid/include/itkChangeInformationImageFilter.hxx @@ -174,9 +174,6 @@ ChangeInformationImageFilter::GenerateData() output->SetBufferedRegion(region); } -/** - * - */ template void ChangeInformationImageFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Filtering/ImageGrid/include/itkPermuteAxesImageFilter.h b/Modules/Filtering/ImageGrid/include/itkPermuteAxesImageFilter.h index 84d3bf0f479..8b1209e502b 100644 --- a/Modules/Filtering/ImageGrid/include/itkPermuteAxesImageFilter.h +++ b/Modules/Filtering/ImageGrid/include/itkPermuteAxesImageFilter.h @@ -88,20 +88,25 @@ class ITK_TEMPLATE_EXPORT PermuteAxesImageFilter : public ImageToImageFilter PermuteAxesImageFilter::PermuteAxesImageFilter() { @@ -39,9 +37,6 @@ PermuteAxesImageFilter::PermuteAxesImageFilter() this->ThreaderUpdateProgressOff(); } -/** - * PrintSelf - */ template void PermuteAxesImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -65,9 +60,6 @@ PermuteAxesImageFilter::PrintSelf(std::ostream & os, Indent indent) cons os << m_InverseOrder[j] << "]" << std::endl; } -/** - * Set the permutation order - */ template void PermuteAxesImageFilter::SetOrder(const PermuteOrderArrayType & order) @@ -113,10 +105,6 @@ PermuteAxesImageFilter::SetOrder(const PermuteOrderArrayType & order) } } -/** - * The output image meta information is obtained by permuting - * the input image meta information. - */ template void PermuteAxesImageFilter::GenerateOutputInformation() @@ -170,10 +158,6 @@ PermuteAxesImageFilter::GenerateOutputInformation() outputPtr->SetLargestPossibleRegion(outputRegion); } -/** - * The required input requested region is obtained by permuting - * the index and size of the output requested region - */ template void PermuteAxesImageFilter::GenerateInputRequestedRegion() @@ -208,9 +192,6 @@ PermuteAxesImageFilter::GenerateInputRequestedRegion() inputPtr->SetRequestedRegion(inputRegion); } -/** - * - */ template void PermuteAxesImageFilter::DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) diff --git a/Modules/Filtering/ImageIntensity/include/itkPolylineMask2DImageFilter.hxx b/Modules/Filtering/ImageIntensity/include/itkPolylineMask2DImageFilter.hxx index fa7e4367a36..19cf1da89df 100644 --- a/Modules/Filtering/ImageIntensity/include/itkPolylineMask2DImageFilter.hxx +++ b/Modules/Filtering/ImageIntensity/include/itkPolylineMask2DImageFilter.hxx @@ -27,18 +27,13 @@ namespace itk { -/** - * Constructor - */ + template PolylineMask2DImageFilter::PolylineMask2DImageFilter() { this->SetNumberOfRequiredInputs(2); } -/** - * - */ template void PolylineMask2DImageFilter::SetInput1(const TInputImage * input) @@ -48,9 +43,6 @@ PolylineMask2DImageFilter::SetInput1(const this->ProcessObject::SetNthInput(0, const_cast(input)); } -/** - * - */ template void PolylineMask2DImageFilter::SetInput2(const TPolyline * input) @@ -59,9 +51,6 @@ PolylineMask2DImageFilter::SetInput2(const this->ProcessObject::SetNthInput(1, const_cast(input)); } -/** - * - */ template void PolylineMask2DImageFilter::GenerateData() diff --git a/Modules/Filtering/ImageStatistics/include/itkAccumulateImageFilter.hxx b/Modules/Filtering/ImageStatistics/include/itkAccumulateImageFilter.hxx index d148a849ec8..9837812ff59 100644 --- a/Modules/Filtering/ImageStatistics/include/itkAccumulateImageFilter.hxx +++ b/Modules/Filtering/ImageStatistics/include/itkAccumulateImageFilter.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template AccumulateImageFilter::AccumulateImageFilter() { @@ -135,9 +133,6 @@ AccumulateImageFilter::GenerateInputRequestedRegion() itkDebugMacro("GenerateInputRequestedRegion End"); } -/** - * GenerateData Performs the accumulation - */ template void AccumulateImageFilter::GenerateData() diff --git a/Modules/Filtering/ImageStatistics/include/itkGetAverageSliceImageFilter.hxx b/Modules/Filtering/ImageStatistics/include/itkGetAverageSliceImageFilter.hxx index 16012a48eff..32c0c878904 100644 --- a/Modules/Filtering/ImageStatistics/include/itkGetAverageSliceImageFilter.hxx +++ b/Modules/Filtering/ImageStatistics/include/itkGetAverageSliceImageFilter.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template GetAverageSliceImageFilter::GetAverageSliceImageFilter() { diff --git a/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.h b/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.h index 55041abbff6..f70795bc60d 100644 --- a/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.h +++ b/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.h @@ -137,9 +137,11 @@ class ITK_TEMPLATE_EXPORT ImagePCADecompositionCalculator : public Object void PrintSelf(std::ostream & os, Indent indent) const override; + /** Convert a vector of basis images into a matrix flattening each image into 1-D. */ void CalculateBasisMatrix(); + /** Convert an image into a 1-D vector changing the pixel type if necessary. */ void CalculateRecenteredImageAsVector(); diff --git a/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.hxx b/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.hxx index 8a2466d6d29..6457c511e06 100644 --- a/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.hxx +++ b/Modules/Filtering/ImageStatistics/include/itkImagePCADecompositionCalculator.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template ImagePCADecompositionCalculator::ImagePCADecompositionCalculator() { @@ -50,9 +48,6 @@ ImagePCADecompositionCalculator::SetBasisImages(const this->Modified(); } -/** - * Compute the projection - */ template void ImagePCADecompositionCalculator::Compute() @@ -65,9 +60,6 @@ ImagePCADecompositionCalculator::Compute() m_Projection = m_BasisMatrix * m_ImageAsVector; } -/* - * Convert a vector of basis images into a matrix. Each image is flattened into 1-D. - */ template void ImagePCADecompositionCalculator::CalculateBasisMatrix() @@ -103,9 +95,6 @@ ImagePCADecompositionCalculator::CalculateBasisMatrix( m_ImageAsVector.set_size(m_NumPixels); } -/** - * Convert an image into a 1-D vector, changing the pixel type if necessary. - */ template void ImagePCADecompositionCalculator::CalculateRecenteredImageAsVector() diff --git a/Modules/Filtering/Path/include/itkChainCodePath.hxx b/Modules/Filtering/Path/include/itkChainCodePath.hxx index 0f762e6879c..453a64aeecb 100644 --- a/Modules/Filtering/Path/include/itkChainCodePath.hxx +++ b/Modules/Filtering/Path/include/itkChainCodePath.hxx @@ -84,14 +84,12 @@ ChainCodePath::IncrementInput(InputType & input) const -> OffsetType } } -/** Constructor */ template ChainCodePath::ChainCodePath() { m_Start = this->GetZeroIndex(); } -/** Standard "PrintSelf" method */ template void ChainCodePath::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Filtering/Path/include/itkChainCodeToFourierSeriesPathFilter.hxx b/Modules/Filtering/Path/include/itkChainCodeToFourierSeriesPathFilter.hxx index cf6680647d9..7c331d014c1 100644 --- a/Modules/Filtering/Path/include/itkChainCodeToFourierSeriesPathFilter.hxx +++ b/Modules/Filtering/Path/include/itkChainCodeToFourierSeriesPathFilter.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template ChainCodeToFourierSeriesPathFilter::ChainCodeToFourierSeriesPathFilter() { @@ -32,9 +30,6 @@ ChainCodeToFourierSeriesPathFilter void ChainCodeToFourierSeriesPathFilter::GenerateData() diff --git a/Modules/Filtering/Path/include/itkFourierSeriesPath.hxx b/Modules/Filtering/Path/include/itkFourierSeriesPath.hxx index c9f1f0bb66f..931ca4eaf53 100644 --- a/Modules/Filtering/Path/include/itkFourierSeriesPath.hxx +++ b/Modules/Filtering/Path/include/itkFourierSeriesPath.hxx @@ -86,9 +86,6 @@ FourierSeriesPath::AddHarmonic(const VectorType & CosCoefficients, c this->Modified(); } -/** - * Constructor - */ template FourierSeriesPath::FourierSeriesPath() { @@ -97,9 +94,6 @@ FourierSeriesPath::FourierSeriesPath() m_SinCoefficients = CoefficientsType::New(); } -/** - * Standard "PrintSelf" method - */ template void FourierSeriesPath::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Filtering/Path/include/itkHilbertPath.hxx b/Modules/Filtering/Path/include/itkHilbertPath.hxx index a6bc9a8ae72..d70d0527cd0 100644 --- a/Modules/Filtering/Path/include/itkHilbertPath.hxx +++ b/Modules/Filtering/Path/include/itkHilbertPath.hxx @@ -22,7 +22,6 @@ namespace itk { -/** Constructor */ template HilbertPath::HilbertPath() @@ -239,7 +238,6 @@ HilbertPath::GetEntry(const PathIndexType x) -> PathInd } } -/** Standard "PrintSelf" method */ template void HilbertPath::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Filtering/Path/include/itkParametricPath.hxx b/Modules/Filtering/Path/include/itkParametricPath.hxx index eda7ab1ea65..4d717087a92 100644 --- a/Modules/Filtering/Path/include/itkParametricPath.hxx +++ b/Modules/Filtering/Path/include/itkParametricPath.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template ParametricPath::ParametricPath() { diff --git a/Modules/Filtering/Path/include/itkPathToImageFilter.h b/Modules/Filtering/Path/include/itkPathToImageFilter.h index a3c01733d4a..d23e025135c 100644 --- a/Modules/Filtering/Path/include/itkPathToImageFilter.h +++ b/Modules/Filtering/Path/include/itkPathToImageFilter.h @@ -64,7 +64,7 @@ class ITK_TEMPLATE_EXPORT PathToImageFilter : public ImageSource /** ImageDimension constants */ static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension; - /** Set/Get the path input of this process object. */ + /** Set/Get the input path. */ using Superclass::SetInput; virtual void SetInput(const InputPathType * input); diff --git a/Modules/Filtering/Path/include/itkPathToImageFilter.hxx b/Modules/Filtering/Path/include/itkPathToImageFilter.hxx index 6502459331e..d3f958449b2 100644 --- a/Modules/Filtering/Path/include/itkPathToImageFilter.hxx +++ b/Modules/Filtering/Path/include/itkPathToImageFilter.hxx @@ -25,7 +25,7 @@ namespace itk { -/** Constructor */ + template PathToImageFilter::PathToImageFilter() { @@ -129,7 +129,6 @@ PathToImageFilter::GetSpacing() const return m_Spacing; } -//---------------------------------------------------------------------------- template void PathToImageFilter::SetOrigin(const double * origin) @@ -181,8 +180,6 @@ PathToImageFilter::GetOrigin() const return m_Origin; } -//---------------------------------------------------------------------------- - template void PathToImageFilter::GenerateData() @@ -281,7 +278,7 @@ PathToImageFilter::GenerateData() } itkDebugMacro(<< "PathToImageFilter::GenerateData() finished"); -} // end update function +} template void diff --git a/Modules/IO/GDCM/src/itkGDCMImageIO.cxx b/Modules/IO/GDCM/src/itkGDCMImageIO.cxx index b770c3b77f0..31ee8be0ca6 100644 --- a/Modules/IO/GDCM/src/itkGDCMImageIO.cxx +++ b/Modules/IO/GDCM/src/itkGDCMImageIO.cxx @@ -1636,7 +1636,6 @@ GDCMImageIO::PrintSelf(std::ostream & os, Indent indent) const #endif } -/** Print enum values */ std::ostream & operator<<(std::ostream & out, const GDCMImageIOEnums::Compression value) { diff --git a/Modules/Nonunit/Review/include/itkComplexBSplineInterpolateImageFunction.hxx b/Modules/Nonunit/Review/include/itkComplexBSplineInterpolateImageFunction.hxx index b3563525d7b..2e3c8a5e76b 100644 --- a/Modules/Nonunit/Review/include/itkComplexBSplineInterpolateImageFunction.hxx +++ b/Modules/Nonunit/Review/include/itkComplexBSplineInterpolateImageFunction.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template ComplexBSplineInterpolateImageFunction:: ComplexBSplineInterpolateImageFunction() @@ -37,9 +35,6 @@ ComplexBSplineInterpolateImageFunction: this->SetSplineOrder(3); } -/** - * Standard "PrintSelf" method - */ template void ComplexBSplineInterpolateImageFunction::PrintSelf(std::ostream & os, diff --git a/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.h b/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.h index 7aaf6972f10..c9ccfe299f5 100644 --- a/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.h +++ b/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.h @@ -79,36 +79,49 @@ class ITK_TEMPLATE_EXPORT EigenAnalysis2DImageFilter : public ImageToImageFilter static constexpr unsigned int ImageDimension = TInputImage::ImageDimension; /** Connect the image containing the elements [0,0] - * of the input 2D matrix */ + * of the input 2D matrix. */ void SetInput1(TInputImage * image); /** Connect the image containing the elements [0,1] * of the input 2D matrix. This is the same [1,0] * element given that the input matrix is expected - * to be symmetric */ + * to be symmetric. */ void SetInput2(TInputImage * image); /** Connect the image containing the elements [1,1] - * of the input 2D matrix */ + * of the input 2D matrix. */ void SetInput3(TInputImage * image); - /** Get the Output image with the greatest eigenvalue */ + /** Get the output image with the largest eigenvalue. + * + * The sign is taken into account in the computation. + */ EigenValueImageType * GetMaxEigenValue(); - /** Get the Output image with the smallest eigenvalue */ + /** Get the output image with the smallest eigenvalue. + * + * The sign is taken into account in the computation. + */ EigenValueImageType * GetMinEigenValue(); - /** Get the Output image with the eigen vector associated with - * the greatest eigen value */ + /** Get the output image with the eigenvector associated with + * the greatest eigenvalue + * + * The sign is taken into account in the computation. + */ EigenVectorImageType * GetMaxEigenVector(); - /** Create the Output */ + /** Create the output. + * + * \todo Verify that MakeOutput is creating the right type of objects + * this could be the cause of the reinterpret_cast bug in this class. + */ using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType; using Superclass::MakeOutput; DataObject::Pointer diff --git a/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.hxx b/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.hxx index 2de4e5c10b7..024b05c59ac 100644 --- a/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.hxx +++ b/Modules/Numerics/Eigen/include/itkEigenAnalysis2DImageFilter.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Constructor - */ + template EigenAnalysis2DImageFilter::EigenAnalysis2DImageFilter() { @@ -37,9 +35,6 @@ EigenAnalysis2DImageFilter::Ei static_assert(EigenVectorType::Dimension == 2, "Error: PixelType of EigenVector Image must have exactly 2 elements!"); } -/** - * Connect one the image containing the [0,0] elements of the input matrix - */ template void EigenAnalysis2DImageFilter::SetInput1(TInputImage * image) @@ -47,11 +42,6 @@ EigenAnalysis2DImageFilter::Se this->SetNthInput(0, image); } -/** - * Connect one the image containing the [0,1] elements of the input matrix - * this element is the same [1,0] because this filter assumes symmetric - * matrices - */ template void EigenAnalysis2DImageFilter::SetInput2(TInputImage * image) @@ -59,9 +49,6 @@ EigenAnalysis2DImageFilter::Se this->SetNthInput(1, image); } -/** - * Connect one the image containing the [1,1] elements of the input matrix - */ template void EigenAnalysis2DImageFilter::SetInput3(TInputImage * image) @@ -69,9 +56,6 @@ EigenAnalysis2DImageFilter::Se this->SetNthInput(2, image); } -/** - * Get the largest eigenvalue considering the sign - */ template auto EigenAnalysis2DImageFilter::GetMaxEigenValue() @@ -80,9 +64,6 @@ EigenAnalysis2DImageFilter::Ge return dynamic_cast(this->ProcessObject::GetOutput(0)); } -/** - * Get the smallest eigenvalue considering the sign - */ template auto EigenAnalysis2DImageFilter::GetMinEigenValue() @@ -91,9 +72,6 @@ EigenAnalysis2DImageFilter::Ge return dynamic_cast(this->ProcessObject::GetOutput(1)); } -/** - * Get the eigenvector corresponding to the largest eigenvalue (considering the sign) - */ template auto EigenAnalysis2DImageFilter::GetMaxEigenVector() @@ -117,11 +95,6 @@ EigenAnalysis2DImageFilter::Ge } } -/** - * Make Output - * \todo Verify that MakeOutput is creating the right type of objects - * this could be the cause of the reinterpret_cast bug in this class - */ template DataObject::Pointer EigenAnalysis2DImageFilter::MakeOutput( diff --git a/Modules/Numerics/FEM/include/itkFEMObject.hxx b/Modules/Numerics/FEM/include/itkFEMObject.hxx index 73ee834bb7a..300412d2a25 100644 --- a/Modules/Numerics/FEM/include/itkFEMObject.hxx +++ b/Modules/Numerics/FEM/include/itkFEMObject.hxx @@ -36,9 +36,7 @@ namespace itk { namespace fem { -/* - * Default constructor for FEMObject class - */ + template FEMObject::FEMObject() { @@ -333,9 +331,6 @@ FEMObject::FinalizeMesh() this->GenerateMFC(); } -/** - * Assign a global freedom number to each DOF in a system. - */ template void FEMObject::GenerateMFC() @@ -369,9 +364,6 @@ FEMObject::GenerateMFC() } } -/** - * Assign a global freedom number to each DOF in a system. - */ template void FEMObject::GenerateGFN() diff --git a/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.h b/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.h index 0d39d14a4a2..8fbd08258f3 100644 --- a/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.h +++ b/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.h @@ -103,15 +103,15 @@ class ITK_TEMPLATE_EXPORT ImageToRectilinearFEMObjectFilter : public ProcessObje /**Get the number of element in each dimension of the generated mesh*/ itkGetMacro(NumberOfElements, vnl_vector); - /**Get/Set the material used for the mesh */ + /**Get/Set the material used for the mesh. */ itkGetMacro(Material, MaterialPointerType); itkSetMacro(Material, MaterialPointerType); - /**Get/Set the element type used to generate the mesh */ + /**Get/Set the element type used to generate the mesh. */ itkGetMacro(Element, ElementBasePointerType); itkSetMacro(Element, ElementBasePointerType); - /** Set/Get the image input of this process object. */ + /** Set/Get the input image. */ using Superclass::SetInput; void SetInput(InputImageType * image); @@ -161,9 +161,11 @@ class ITK_TEMPLATE_EXPORT ImageToRectilinearFEMObjectFilter : public ProcessObje void GenerateData() override; + /** Generate a rectangular mesh of quadrilateral elements. */ void Generate2DRectilinearMesh(); + /** Generate a rectangular mesh of hexahedron elements. */ void Generate3DRectilinearMesh(); diff --git a/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.hxx b/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.hxx index c0ff6c8b299..a37e411c0c9 100644 --- a/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.hxx +++ b/Modules/Numerics/FEM/include/itkImageToRectilinearFEMObjectFilter.hxx @@ -26,9 +26,6 @@ namespace itk namespace fem { -/* - * Default constructor for Filter - */ template ImageToRectilinearFEMObjectFilter::ImageToRectilinearFEMObjectFilter() { @@ -49,9 +46,6 @@ ImageToRectilinearFEMObjectFilter::SetInput(InputImageType * image) this->ProcessObject::SetNthInput(0, const_cast(image)); } -/** - * Connect one of the operands for pixel-wise addition - */ template void ImageToRectilinearFEMObjectFilter::SetInput(unsigned int index, InputImageType * image) @@ -60,9 +54,6 @@ ImageToRectilinearFEMObjectFilter::SetInput(unsigned int index, Inp this->ProcessObject::SetNthInput(index, const_cast(image)); } -/** - * - */ template auto ImageToRectilinearFEMObjectFilter::GetInput() -> InputImageType * @@ -75,9 +66,6 @@ ImageToRectilinearFEMObjectFilter::GetInput() -> InputImageType * return itkDynamicCastInDebugMode(this->ProcessObject::GetInput(0)); } -/** - * - */ template auto ImageToRectilinearFEMObjectFilter::GetInput(unsigned int idx) -> InputImageType * @@ -85,9 +73,6 @@ ImageToRectilinearFEMObjectFilter::GetInput(unsigned int idx) -> In return itkDynamicCastInDebugMode(this->ProcessObject::GetInput(idx)); } -/** - * - */ template auto ImageToRectilinearFEMObjectFilter::MakeOutput(DataObjectPointerArraySizeType itkNotUsed(idx)) @@ -96,9 +81,6 @@ ImageToRectilinearFEMObjectFilter::MakeOutput(DataObjectPointerArra return FEMObjectType::New().GetPointer(); } -/** - * - */ template auto ImageToRectilinearFEMObjectFilter::GetOutput() -> FEMObjectType * @@ -111,9 +93,6 @@ ImageToRectilinearFEMObjectFilter::GetOutput() -> FEMObjectType * return itkDynamicCastInDebugMode(this->ProcessObject::GetOutput(0)); } -/** - * - */ template auto ImageToRectilinearFEMObjectFilter::GetOutput(unsigned int idx) -> FEMObjectType * @@ -147,9 +126,6 @@ ImageToRectilinearFEMObjectFilter::GenerateData() } } -/** - * Generate a rectangular mesh of quadrilateral elements - */ template void ImageToRectilinearFEMObjectFilter::Generate2DRectilinearMesh() @@ -218,9 +194,6 @@ ImageToRectilinearFEMObjectFilter::Generate2DRectilinearMesh() } } -/** - * Generate a rectangular mesh of hexahedron elements - */ template void ImageToRectilinearFEMObjectFilter::Generate3DRectilinearMesh() @@ -317,9 +290,6 @@ ImageToRectilinearFEMObjectFilter::Generate3DRectilinearMesh() } } -/** - * PrintSelf - */ template void ImageToRectilinearFEMObjectFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Numerics/FEM/include/itkMetaFEMObjectConverter.h b/Modules/Numerics/FEM/include/itkMetaFEMObjectConverter.h index 00420a64ca9..ef42458deb8 100644 --- a/Modules/Numerics/FEM/include/itkMetaFEMObjectConverter.h +++ b/Modules/Numerics/FEM/include/itkMetaFEMObjectConverter.h @@ -68,16 +68,16 @@ class ITK_TEMPLATE_EXPORT MetaFEMObjectConverter : public MetaConverterBase MetaFEMObjectConverter::MetaFEMObjectConverter() = default; @@ -40,7 +39,6 @@ MetaFEMObjectConverter::CreateMetaObject() -> MetaObjectType * return dynamic_cast(new FEMObjectMetaObjectType); } -/** Convert a metaFEMObject into an FEMObject SpatialObject */ template auto MetaFEMObjectConverter::MetaObjectToSpatialObject(const MetaObjectType * mo) -> SpatialObjectPointer @@ -312,7 +310,6 @@ MetaFEMObjectConverter::MetaObjectToSpatialObject(const MetaObjectTy return FEMSO.GetPointer(); } -/** Convert an FEMObject SpatialObject into a metaFEMObject */ template auto MetaFEMObjectConverter::SpatialObjectToMetaObject(const SpatialObjectType * so) -> MetaObjectType * diff --git a/Modules/Numerics/Optimizers/src/itkFRPROptimizer.cxx b/Modules/Numerics/Optimizers/src/itkFRPROptimizer.cxx index bf7302c729d..922613073cb 100644 --- a/Modules/Numerics/Optimizers/src/itkFRPROptimizer.cxx +++ b/Modules/Numerics/Optimizers/src/itkFRPROptimizer.cxx @@ -200,27 +200,18 @@ FRPROptimizer::StartOptimization() this->InvokeEvent(EndEvent()); } -/** - * - */ void FRPROptimizer::SetToPolakRibiere() { m_OptimizationType = OptimizationEnum::PolakRibiere; } -/** - * - */ void FRPROptimizer::SetToFletchReeves() { m_OptimizationType = OptimizationEnum::FletchReeves; } -/** - * - */ void FRPROptimizer::PrintSelf(std::ostream & os, Indent indent) const { @@ -230,7 +221,6 @@ FRPROptimizer::PrintSelf(std::ostream & os, Indent indent) const os << indent << "Use unit length gradient = " << m_UseUnitLengthGradient << std::endl; } -/** Print enum values */ std::ostream & operator<<(std::ostream & out, const FRPROptimizerEnums::Optimization value) { diff --git a/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.h b/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.h index 5fe9ff85617..6f6d3f6e108 100644 --- a/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.h +++ b/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.h @@ -125,6 +125,14 @@ class ITK_TEMPLATE_EXPORT GradientDescentLineSearchOptimizerv4Template void PrintSelf(std::ostream & os, Indent indent) const override; + /** Search the golden section. + * + * \p a and \p c are the current bounds; the minimum is between them. + * \p b is a center point. + * \c f(x) is some mathematical function elsewhere defined. + * \p a corresponds to \c x1; \p b corresponds to \c x2; \p c corresponds to \c x3. + * \c x corresponds to \c x4. + */ TInternalComputationValueType GoldenSectionSearch(TInternalComputationValueType a, TInternalComputationValueType b, diff --git a/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.hxx b/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.hxx index 202e7d60147..ebb4135676f 100644 --- a/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.hxx +++ b/Modules/Numerics/Optimizersv4/include/itkGradientDescentLineSearchOptimizerv4.hxx @@ -22,9 +22,6 @@ namespace itk { -/** - * Default constructor - */ template GradientDescentLineSearchOptimizerv4Template< TInternalComputationValueType>::GradientDescentLineSearchOptimizerv4Template() @@ -50,9 +47,6 @@ GradientDescentLineSearchOptimizerv4Template::Pri Superclass::PrintSelf(os, indent); } -/** - * Advance one Step following the gradient direction - */ template void GradientDescentLineSearchOptimizerv4Template::AdvanceOneStep() @@ -94,11 +88,6 @@ GradientDescentLineSearchOptimizerv4Template::Adv } -// a and c are the current bounds; the minimum is between them. -// b is a center point -// f(x) is some mathematical function elsewhere defined -// a corresponds to x1; b corresponds to x2; c corresponds to x3 -// x corresponds to x4 template TInternalComputationValueType GradientDescentLineSearchOptimizerv4Template::GoldenSectionSearch( diff --git a/Modules/Numerics/Optimizersv4/include/itkGradientDescentOptimizerBasev4.hxx b/Modules/Numerics/Optimizersv4/include/itkGradientDescentOptimizerBasev4.hxx index 98933cbdbf4..368128fba3e 100644 --- a/Modules/Numerics/Optimizersv4/include/itkGradientDescentOptimizerBasev4.hxx +++ b/Modules/Numerics/Optimizersv4/include/itkGradientDescentOptimizerBasev4.hxx @@ -24,7 +24,6 @@ namespace itk { -//------------------------------------------------------------------- template GradientDescentOptimizerBasev4Template::GradientDescentOptimizerBasev4Template() @@ -53,7 +52,6 @@ GradientDescentOptimizerBasev4Template::GradientD this->m_DoEstimateLearningRateOnce = true; } -//------------------------------------------------------------------- template void GradientDescentOptimizerBasev4Template::PrintSelf(std::ostream & os, Indent indent) const @@ -85,8 +83,6 @@ GradientDescentOptimizerBasev4Template::PrintSelf << std::endl; } - -//------------------------------------------------------------------- template auto GradientDescentOptimizerBasev4Template::GetStopConditionDescription() const @@ -95,7 +91,6 @@ GradientDescentOptimizerBasev4Template::GetStopCo return this->m_StopConditionDescription.str(); } -//------------------------------------------------------------------- template void GradientDescentOptimizerBasev4Template::StopOptimization() @@ -105,7 +100,6 @@ GradientDescentOptimizerBasev4Template::StopOptim this->InvokeEvent(EndEvent()); } -//------------------------------------------------------------------- template void GradientDescentOptimizerBasev4Template::ModifyGradientByScales() @@ -174,7 +168,6 @@ GradientDescentOptimizerBasev4Template::StartOpti Superclass::StartOptimization(doOnlyInitialization); } -//------------------------------------------------------------------- template void GradientDescentOptimizerBasev4Template::ModifyGradientByLearningRate() diff --git a/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.h b/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.h index 4636f530bfa..fc418678c8b 100644 --- a/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.h +++ b/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.h @@ -116,15 +116,15 @@ class ITK_TEMPLATE_EXPORT MultiGradientOptimizerv4Template const StopConditionReturnStringType GetStopConditionDescription() const override; - /** Get the list of optimizers currently held. */ + /** Get the list of optimizers currently held. */ OptimizersListType & GetOptimizersList(); - /** Set the list of optimizers to combine */ + /** Set the list of optimizers to combine. */ void SetOptimizersList(OptimizersListType & p); - /** Get the list of metric values that we produced after the multi-objective search. */ + /** Get the list of metric values that we produced after the multi-objective search. */ const MetricValuesListType & GetMetricValuesList() const; diff --git a/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.hxx b/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.hxx index 607105899ca..ec3f21ee7b0 100644 --- a/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.hxx +++ b/Modules/Numerics/Optimizersv4/include/itkMultiGradientOptimizerv4.hxx @@ -22,7 +22,6 @@ namespace itk { -//------------------------------------------------------------------- template MultiGradientOptimizerv4Template::MultiGradientOptimizerv4Template() @@ -35,7 +34,6 @@ MultiGradientOptimizerv4Template::MultiGradientOp this->m_MinimumMetricValue = this->m_MaximumMetricValue; } -//------------------------------------------------------------------- template void MultiGradientOptimizerv4Template::PrintSelf(std::ostream & os, Indent indent) const @@ -45,7 +43,6 @@ MultiGradientOptimizerv4Template::PrintSelf(std:: os << indent << "Stop condition description: " << this->m_StopConditionDescription.str() << std::endl; } -//------------------------------------------------------------------- template auto MultiGradientOptimizerv4Template::GetOptimizersList() -> OptimizersListType & @@ -53,7 +50,6 @@ MultiGradientOptimizerv4Template::GetOptimizersLi return this->m_OptimizersList; } -/** Set the list of optimizers to use in the multiple gradient descent */ template void MultiGradientOptimizerv4Template::SetOptimizersList( @@ -66,7 +62,6 @@ MultiGradientOptimizerv4Template::SetOptimizersLi } } -/** Get the list of metric values that we produced after the multi-gradient optimization. */ template auto MultiGradientOptimizerv4Template::GetMetricValuesList() const @@ -75,7 +70,6 @@ MultiGradientOptimizerv4Template::GetMetricValues return this->m_MetricValuesList; } -//------------------------------------------------------------------- template auto MultiGradientOptimizerv4Template::GetStopConditionDescription() const @@ -84,7 +78,6 @@ MultiGradientOptimizerv4Template::GetStopConditio return this->m_StopConditionDescription.str(); } -//------------------------------------------------------------------- template void MultiGradientOptimizerv4Template::StopOptimization() @@ -97,9 +90,6 @@ MultiGradientOptimizerv4Template::StopOptimizatio this->InvokeEvent(EndEvent()); } -/** - * Start and run the optimization - */ template void MultiGradientOptimizerv4Template::StartOptimization(bool doOnlyInitialization) @@ -143,9 +133,6 @@ MultiGradientOptimizerv4Template::StartOptimizati } } -/** - * Resume optimization. - */ template void MultiGradientOptimizerv4Template::ResumeOptimization() diff --git a/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.h b/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.h index 79cf9ca45c2..4eac718b716 100644 --- a/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.h +++ b/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.h @@ -134,15 +134,15 @@ class ITK_TEMPLATE_EXPORT MultiStartOptimizerv4Template ParametersListType & GetParametersList(); - /** Set the list of parameters over which to search */ + /** Set the list of parameters over which to search. */ void SetParametersList(ParametersListType & p); - /** Get the list of metric values that we produced after the multi-start search. */ + /** Get the list of metric values that we produced after the multi-start search. */ const MetricValuesListType & GetMetricValuesList() const; - /** Return the parameters from the best visited position */ + /** Return the parameters from the best visited position. */ ParametersType GetBestParameters(); diff --git a/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.hxx b/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.hxx index 45b116d77f6..18dbf587d13 100644 --- a/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.hxx +++ b/Modules/Numerics/Optimizersv4/include/itkMultiStartOptimizerv4.hxx @@ -22,7 +22,6 @@ namespace itk { -//------------------------------------------------------------------- template MultiStartOptimizerv4Template::MultiStartOptimizerv4Template() @@ -37,7 +36,6 @@ MultiStartOptimizerv4Template::MultiStartOptimize m_LocalOptimizer = nullptr; } -//------------------------------------------------------------------- template void MultiStartOptimizerv4Template::PrintSelf(std::ostream & os, Indent indent) const @@ -47,7 +45,6 @@ MultiStartOptimizerv4Template::PrintSelf(std::ost os << indent << "Stop condition description: " << this->m_StopConditionDescription.str() << std::endl; } -//------------------------------------------------------------------- template auto MultiStartOptimizerv4Template::GetParametersList() -> ParametersListType & @@ -55,7 +52,6 @@ MultiStartOptimizerv4Template::GetParametersList( return this->m_ParametersList; } -/** Set the list of parameters over which to search */ template void MultiStartOptimizerv4Template::SetParametersList( @@ -68,7 +64,6 @@ MultiStartOptimizerv4Template::SetParametersList( } } -/** Get the list of metric values that we produced after the multi-start search. */ template auto MultiStartOptimizerv4Template::GetMetricValuesList() const @@ -77,7 +72,6 @@ MultiStartOptimizerv4Template::GetMetricValuesLis return this->m_MetricValuesList; } -//------------------------------------------------------------------- template auto MultiStartOptimizerv4Template::GetBestParameters() -> ParametersType @@ -85,8 +79,6 @@ MultiStartOptimizerv4Template::GetBestParameters( return this->m_ParametersList[m_BestParametersIndex]; } - -//------------------------------------------------------------------- template void MultiStartOptimizerv4Template::InstantiateLocalOptimizer() @@ -97,7 +89,6 @@ MultiStartOptimizerv4Template::InstantiateLocalOp this->m_LocalOptimizer = optimizer; } -//------------------------------------------------------------------- template auto MultiStartOptimizerv4Template::GetStopConditionDescription() const @@ -106,7 +97,6 @@ MultiStartOptimizerv4Template::GetStopConditionDe return this->m_StopConditionDescription.str(); } -//------------------------------------------------------------------- template void MultiStartOptimizerv4Template::StopOptimization() @@ -119,9 +109,6 @@ MultiStartOptimizerv4Template::StopOptimization() this->InvokeEvent(EndEvent()); } -/** - * Start and run the optimization - */ template void MultiStartOptimizerv4Template::StartOptimization(bool doOnlyInitialization) @@ -150,9 +137,6 @@ MultiStartOptimizerv4Template::StartOptimization( } } -/** - * Resume optimization. - */ template void MultiStartOptimizerv4Template::ResumeOptimization() diff --git a/Modules/Numerics/Optimizersv4/include/itkObjectToObjectMetric.hxx b/Modules/Numerics/Optimizersv4/include/itkObjectToObjectMetric.hxx index 0b65a913945..fc720688460 100644 --- a/Modules/Numerics/Optimizersv4/include/itkObjectToObjectMetric.hxx +++ b/Modules/Numerics/Optimizersv4/include/itkObjectToObjectMetric.hxx @@ -25,9 +25,6 @@ namespace itk { -/* - * constructor - */ template m_UserHasSetVirtualDomain = false; } -/* - * Initialize - */ template SetMovingTransform(transform); } -/* - * GetTransform - */ template GetMovingTransform(); } -/* - * UpdateTransformParameters - */ template m_MovingTransform->UpdateTransformParameters(derivative, factor); } -/* - * GetNumberOfParameters - */ template m_MovingTransform->GetNumberOfParameters(); } -/* - * GetParameters - */ template m_MovingTransform->GetParameters(); } -/* - * SetParameters - */ template m_MovingTransform->SetParametersByValue(params); } -/* - * GetNumberOfLocalParameters - */ template m_MovingTransform->GetNumberOfLocalParameters(); } -/* - * HasLocalSupport - */ template bool CheckGeneralAffineTransformTemplated(); - /** Transform a physical point to a new physical point. */ + /** Transform a physical point to a new physical point. + * + * We want to compute shift in physical space so that the scales is not sensitive to spacings and directions of + * voxel sampling. + */ template void TransformPoint(const VirtualPointType & point, TTargetPointType & mappedPoint); @@ -234,7 +241,7 @@ class ITK_TEMPLATE_EXPORT RegistrationParameterScalesEstimator void TransformPointToContinuousIndex(const VirtualPointType & point, TContinuousIndexType & mappedIndex); - /** Compute the transform Jacobian at a physical point. */ + /** Compute the squared norms of the transform Jacobians w.r.t parameters at a physical point. */ void ComputeSquaredJacobianNorms(const VirtualPointType & point, ParametersType & squareNorms); @@ -258,7 +265,7 @@ class ITK_TEMPLATE_EXPORT RegistrationParameterScalesEstimator void UpdateTransformParameters(const ParametersType & deltaParameters); - /** Sample the virtual domain and store the physical points in m_SamplePoints. */ + /** Sample the virtual domain with phyical points and store the results in m_SamplePoints. */ virtual void SampleVirtualDomain(); @@ -266,7 +273,10 @@ class ITK_TEMPLATE_EXPORT RegistrationParameterScalesEstimator void SampleVirtualDomainFully(); - /** Sample the virtual domain with corners. */ + /** Sample the virtual domain with corners. + * + * Sample the virtual domain with the points at image corners, and store the results in m_SamplePoints. + */ void SampleVirtualDomainWithCorners(); @@ -274,7 +284,10 @@ class ITK_TEMPLATE_EXPORT RegistrationParameterScalesEstimator void SampleVirtualDomainRandomly(); - /** Sample the virtual domain with voxel in the central region. */ + /** Sample the virtual domain with the voxel in the central region. + * + * Samples the virtual domain with the voxels around the center. + */ void SampleVirtualDomainWithCentralRegion(); @@ -286,7 +299,10 @@ class ITK_TEMPLATE_EXPORT RegistrationParameterScalesEstimator void SampleVirtualDomainWithPointSet(); - /** Get the central index of the virtual domain. */ + /** Get the central index of the virtual domain. + * + * Gets the region around the virtual image center. + */ VirtualIndexType GetVirtualDomainCentralIndex(); diff --git a/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesEstimator.hxx b/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesEstimator.hxx index 372327916cb..156a89e171c 100644 --- a/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesEstimator.hxx +++ b/Modules/Numerics/Optimizersv4/include/itkRegistrationParameterScalesEstimator.hxx @@ -44,7 +44,6 @@ RegistrationParameterScalesEstimator::RegistrationParameterScalesEstima // the metric object must be set before EstimateScales() } -/** Estimate the trusted scale for steps. It returns the voxel spacing. */ template auto RegistrationParameterScalesEstimator::EstimateMaximumStepSize() -> FloatType @@ -68,7 +67,6 @@ RegistrationParameterScalesEstimator::EstimateMaximumStepSize() -> Floa return minSpacing; } -/** Validate and set metric and its transforms. */ template bool RegistrationParameterScalesEstimator::CheckAndSetInputs() @@ -90,7 +88,6 @@ RegistrationParameterScalesEstimator::CheckAndSetInputs() return true; } -/** Get the transform being estimated scales for. */ template const TransformBaseTemplate * RegistrationParameterScalesEstimator::GetTransform() @@ -105,7 +102,6 @@ RegistrationParameterScalesEstimator::GetTransform() } } -/** Get the dimension of the target transformed to. */ template itk::SizeValueType RegistrationParameterScalesEstimator::GetDimension() @@ -120,8 +116,6 @@ RegistrationParameterScalesEstimator::GetDimension() } } -/** Check if the transform being optimized has local support. */ - template bool RegistrationParameterScalesEstimator::IsDisplacementFieldTransform() @@ -226,7 +220,6 @@ RegistrationParameterScalesEstimator::TransformHasLocalSupportForScales } } -/** Get the number of scales. */ template SizeValueType RegistrationParameterScalesEstimator::GetNumberOfLocalParameters() @@ -241,7 +234,6 @@ RegistrationParameterScalesEstimator::GetNumberOfLocalParameters() } } -/** Update the transform with a change in parameters. */ template void RegistrationParameterScalesEstimator::UpdateTransformParameters(const ParametersType & deltaParameters) @@ -263,10 +255,6 @@ RegistrationParameterScalesEstimator::UpdateTransformParameters(const P } } -/** Transform a physical point to a new physical point. - * We want to compute shift in physical space so that the scales is not - * sensitive to spacings and directions of voxel sampling. - */ template template void @@ -283,7 +271,6 @@ RegistrationParameterScalesEstimator::TransformPoint(const VirtualPoint } } -/** Get the squared norms of the transform Jacobians w.r.t parameters at a point */ template void RegistrationParameterScalesEstimator::ComputeSquaredJacobianNorms(const VirtualPointType & point, @@ -321,9 +308,6 @@ RegistrationParameterScalesEstimator::ComputeSquaredJacobianNorms(const } } -/** Sample the virtual domain with phyical points - * and store the results into this->m_SamplePoints. - */ template void RegistrationParameterScalesEstimator::SampleVirtualDomain() @@ -371,9 +355,6 @@ RegistrationParameterScalesEstimator::SampleVirtualDomain() this->m_SamplingTime = this->GetTimeStamp(); } -/** - * Set the sampling strategy automatically for scales estimation. - */ template void RegistrationParameterScalesEstimator::SetScalesSamplingStrategy() @@ -397,9 +378,6 @@ RegistrationParameterScalesEstimator::SetScalesSamplingStrategy() } } -/** - * Set the sampling strategy automatically for step scale estimation. - */ template void RegistrationParameterScalesEstimator::SetStepScaleSamplingStrategy() @@ -424,10 +402,6 @@ RegistrationParameterScalesEstimator::SetStepScaleSamplingStrategy() } } -/** - * Check if the transform is a general affine transform that maps a line - * segment to a line segment. - */ template bool RegistrationParameterScalesEstimator::CheckGeneralAffineTransform() @@ -442,14 +416,6 @@ RegistrationParameterScalesEstimator::CheckGeneralAffineTransform() } } -/** - * The templated version of CheckGeneralAffineTransform to check if the - * transform is a general affine transform that maps a line segment to - * a line segment. - * - * Examples are subclasses of MatrixOffsetTransformBaseType, TranslationTransform, - * Rigid3DPerspectiveTransform, IdentityTransform, etc. - */ template template bool @@ -472,9 +438,6 @@ RegistrationParameterScalesEstimator::CheckGeneralAffineTransformTempla return false; } -/** - * Get the index of the virtual image center. - */ template auto RegistrationParameterScalesEstimator::GetVirtualDomainCentralIndex() -> VirtualIndexType @@ -494,9 +457,6 @@ RegistrationParameterScalesEstimator::GetVirtualDomainCentralIndex() -> return centralIndex; } -/** - * Get the region around the virtual image center. - */ template auto RegistrationParameterScalesEstimator::GetVirtualDomainCentralRegion() -> VirtualRegionType @@ -529,9 +489,6 @@ RegistrationParameterScalesEstimator::GetVirtualDomainCentralRegion() - return centralRegion; } -/** - * Sample the virtual domain with the voxels around the center. - */ template void RegistrationParameterScalesEstimator::SampleVirtualDomainWithCentralRegion() @@ -540,9 +497,6 @@ RegistrationParameterScalesEstimator::SampleVirtualDomainWithCentralReg SampleVirtualDomainWithRegion(centralRegion); } -/** - * Sample the virtual domain with all voxels inside a region. - */ template void RegistrationParameterScalesEstimator::SampleVirtualDomainWithRegion(VirtualRegionType region) @@ -569,10 +523,6 @@ RegistrationParameterScalesEstimator::SampleVirtualDomainWithRegion(Vir } } -/** - * Sample the virtual domain with the points at image corners. - * And store the results into this->m_SamplePoints. - */ template void RegistrationParameterScalesEstimator::SampleVirtualDomainWithCorners() @@ -602,9 +552,6 @@ RegistrationParameterScalesEstimator::SampleVirtualDomainWithCorners() } } -/** - * Sample the physical points of the virtual domain in a uniform random distribution. - */ template void RegistrationParameterScalesEstimator::SampleVirtualDomainRandomly() @@ -649,9 +596,6 @@ RegistrationParameterScalesEstimator::SampleVirtualDomainRandomly() } } -/** - * Sample the virtual domain using a point set. - */ template void RegistrationParameterScalesEstimator::SampleVirtualDomainWithPointSet() @@ -678,9 +622,6 @@ RegistrationParameterScalesEstimator::SampleVirtualDomainWithPointSet() } } -/** - * Sample the virtual domain fully with all pixels. - */ template void RegistrationParameterScalesEstimator::SampleVirtualDomainFully() @@ -689,9 +630,6 @@ RegistrationParameterScalesEstimator::SampleVirtualDomainFully() this->SampleVirtualDomainWithRegion(region); } -/** - * Print the information about this class. - */ template void RegistrationParameterScalesEstimator::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Numerics/Optimizersv4/src/itkObjectToObjectOptimizerBase.cxx b/Modules/Numerics/Optimizersv4/src/itkObjectToObjectOptimizerBase.cxx index 0054d8d0892..7e8a97b14b2 100644 --- a/Modules/Numerics/Optimizersv4/src/itkObjectToObjectOptimizerBase.cxx +++ b/Modules/Numerics/Optimizersv4/src/itkObjectToObjectOptimizerBase.cxx @@ -25,7 +25,6 @@ namespace itk ITK_GCC_PRAGMA_DIAG_PUSH() ITK_GCC_PRAGMA_DIAG(ignored "-Wattributes") -//------------------------------------------------------------------- template ObjectToObjectOptimizerBaseTemplate::ObjectToObjectOptimizerBaseTemplate() { @@ -41,11 +40,9 @@ ObjectToObjectOptimizerBaseTemplate::ObjectToObje this->m_DoEstimateScales = true; } -//------------------------------------------------------------------- template ObjectToObjectOptimizerBaseTemplate::~ObjectToObjectOptimizerBaseTemplate() = default; -//------------------------------------------------------------------- template void ObjectToObjectOptimizerBaseTemplate::PrintSelf(std::ostream & os, Indent indent) const @@ -84,7 +81,6 @@ ObjectToObjectOptimizerBaseTemplate::PrintSelf(st os << indent << "DoEstimateScales: " << this->m_DoEstimateScales << std::endl; } -//------------------------------------------------------------------- template void ObjectToObjectOptimizerBaseTemplate::SetNumberOfWorkUnits(ThreadIdType number) @@ -100,7 +96,6 @@ ObjectToObjectOptimizerBaseTemplate::SetNumberOfW } } -//------------------------------------------------------------------- template void ObjectToObjectOptimizerBaseTemplate::StartOptimization( @@ -191,7 +186,6 @@ ObjectToObjectOptimizerBaseTemplate::StartOptimiz } } -//------------------------------------------------------------------- template const typename ObjectToObjectOptimizerBaseTemplate::ParametersType & ObjectToObjectOptimizerBaseTemplate::GetCurrentPosition() const @@ -203,7 +197,6 @@ ObjectToObjectOptimizerBaseTemplate::GetCurrentPo return this->m_Metric->GetParameters(); } -//------------------------------------------------------------------- template const typename ObjectToObjectOptimizerBaseTemplate::MeasureType & ObjectToObjectOptimizerBaseTemplate::GetValue() const diff --git a/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.h b/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.h index 05d6bdcc499..96b16c956c0 100644 --- a/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.h +++ b/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.h @@ -86,7 +86,7 @@ class ITK_TEMPLATE_EXPORT HistogramToImageFilter : public ImageSource /** Determine the image dimension. */ static constexpr unsigned int ImageDimension = OutputImageType::ImageDimension; - /** Set/Get the input of this process object. */ + /** Set/Get the input histogram. */ using Superclass::SetInput; virtual void SetInput(const HistogramType * input); diff --git a/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.hxx b/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.hxx index 6f69153c22d..88ee012f125 100644 --- a/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.hxx +++ b/Modules/Numerics/Statistics/include/itkHistogramToImageFilter.hxx @@ -23,14 +23,13 @@ namespace itk { -/** Constructor */ + template HistogramToImageFilter::HistogramToImageFilter() { this->SetNumberOfRequiredInputs(1); } -/** Set the Input Histogram */ template void HistogramToImageFilter::SetInput(const HistogramType * input) @@ -111,9 +110,6 @@ HistogramToImageFilter::GenerateOutputInformation outputImage->SetOrigin(origin); // and origin } -//---------------------------------------------------------------------------- - -/** Update */ template void HistogramToImageFilter::GenerateData() diff --git a/Modules/Registration/Common/include/itkBlockMatchingImageFilter.h b/Modules/Registration/Common/include/itkBlockMatchingImageFilter.h index f99c4e064fe..82f186622ec 100644 --- a/Modules/Registration/Common/include/itkBlockMatchingImageFilter.h +++ b/Modules/Registration/Common/include/itkBlockMatchingImageFilter.h @@ -198,9 +198,11 @@ class ITK_TEMPLATE_EXPORT BlockMatchingImageFilter : public MeshToMeshFilter GradientDifferenceImageToImageMetric::GradientDifferenceImageToImageMetric() { @@ -56,9 +54,6 @@ GradientDifferenceImageToImageMetric::GradientDiffere this->m_DerivativeDelta = 0.001; } -/** - * Initialize - */ template void GradientDifferenceImageToImageMetric::Initialize() @@ -135,9 +130,6 @@ GradientDifferenceImageToImageMetric::Initialize() } } -/** - * PrintSelf - */ template void GradientDifferenceImageToImageMetric::PrintSelf(std::ostream & os, Indent indent) const @@ -146,9 +138,6 @@ GradientDifferenceImageToImageMetric::PrintSelf(std:: os << indent << "DerivativeDelta: " << this->m_DerivativeDelta << std::endl; } -/** - * Compute the range of the moved image gradients - */ template void GradientDifferenceImageToImageMetric::ComputeMovedGradientRange() const @@ -186,9 +175,6 @@ GradientDifferenceImageToImageMetric::ComputeMovedGra } } -/** - * Compute the gradient variances in each dimension. - */ template void GradientDifferenceImageToImageMetric::ComputeVariance() const @@ -262,9 +248,6 @@ GradientDifferenceImageToImageMetric::ComputeVariance } } -/** - * Get the value of the similarity measure - */ template typename GradientDifferenceImageToImageMetric::MeasureType GradientDifferenceImageToImageMetric::ComputeMeasure( @@ -325,9 +308,6 @@ GradientDifferenceImageToImageMetric::ComputeMeasure( return measure; } -/** - * Get the value of the similarity measure - */ template typename GradientDifferenceImageToImageMetric::MeasureType GradientDifferenceImageToImageMetric::GetValue( @@ -371,9 +351,6 @@ GradientDifferenceImageToImageMetric::GetValue( return currentMeasure; } -/** - * Get the Derivative Measure - */ template void GradientDifferenceImageToImageMetric::GetDerivative( @@ -398,9 +375,6 @@ GradientDifferenceImageToImageMetric::GetDerivative( } } -/** - * Get both the match Measure and theDerivative Measure - */ template void GradientDifferenceImageToImageMetric::GetValueAndDerivative( diff --git a/Modules/Registration/Common/include/itkImageRegistrationMethod.h b/Modules/Registration/Common/include/itkImageRegistrationMethod.h index 582091e2fa4..509be09d7f2 100644 --- a/Modules/Registration/Common/include/itkImageRegistrationMethod.h +++ b/Modules/Registration/Common/include/itkImageRegistrationMethod.h @@ -214,7 +214,7 @@ class ITK_TEMPLATE_EXPORT ImageRegistrationMethod : public ProcessObject /** Provides derived classes with the ability to set this private var */ itkSetMacro(LastTransformParameters, ParametersType); - /* Start the Optimization */ + /** Start the optimization. */ void StartOptimization(); diff --git a/Modules/Registration/Common/include/itkImageRegistrationMethod.hxx b/Modules/Registration/Common/include/itkImageRegistrationMethod.hxx index 4abe953407b..ee7e93655c6 100644 --- a/Modules/Registration/Common/include/itkImageRegistrationMethod.hxx +++ b/Modules/Registration/Common/include/itkImageRegistrationMethod.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template ImageRegistrationMethod::ImageRegistrationMethod() { @@ -52,9 +50,6 @@ ImageRegistrationMethod::ImageRegistrationMethod() this->SetNumberOfWorkUnits(this->GetMultiThreader()->GetNumberOfWorkUnits()); } -/** - * - */ template ModifiedTimeType ImageRegistrationMethod::GetMTime() const @@ -104,9 +99,6 @@ ImageRegistrationMethod::GetMTime() const return mtime; } -/* - * Set the initial transform parameters - */ template void ImageRegistrationMethod::SetInitialTransformParameters(const ParametersType & param) @@ -115,10 +107,6 @@ ImageRegistrationMethod::SetInitialTransformParameter this->Modified(); } -/** - - * Set the region of the fixed image to be considered for registration - */ template void ImageRegistrationMethod::SetFixedImageRegion(const FixedImageRegionType & region) @@ -128,9 +116,6 @@ ImageRegistrationMethod::SetFixedImageRegion(const Fi this->Modified(); } -/** - * Initialize by setting the interconnects between components. - */ template void ImageRegistrationMethod::Initialize() @@ -205,9 +190,6 @@ ImageRegistrationMethod::Initialize() m_Optimizer->SetInitialPosition(m_InitialTransformParameters); } -/** - * Starts the Optimization process - */ template void ImageRegistrationMethod::StartOptimization() @@ -232,9 +214,6 @@ ImageRegistrationMethod::StartOptimization() m_Transform->SetParameters(m_LastTransformParameters); } -/** - * PrintSelf - */ template void ImageRegistrationMethod::PrintSelf(std::ostream & os, Indent indent) const @@ -252,9 +231,6 @@ ImageRegistrationMethod::PrintSelf(std::ostream & os, os << indent << "Last Transform Parameters: " << m_LastTransformParameters << std::endl; } -/* - * Generate Data - */ template void ImageRegistrationMethod::GenerateData() @@ -277,9 +253,6 @@ ImageRegistrationMethod::GenerateData() this->StartOptimization(); } -/** - * Get Output - */ template auto ImageRegistrationMethod::GetOutput() const -> const TransformOutputType * diff --git a/Modules/Registration/Common/include/itkImageToImageMetric.h b/Modules/Registration/Common/include/itkImageToImageMetric.h index 00bc54edca4..73cdab66ef2 100644 --- a/Modules/Registration/Common/include/itkImageToImageMetric.h +++ b/Modules/Registration/Common/include/itkImageToImageMetric.h @@ -219,8 +219,7 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction return m_Transform->GetNumberOfParameters(); } - /** Initialize the Metric by making sure that all the components - * are present and plugged together correctly */ + /** Initialize the Metric by making sure that all the components are present and plugged together correctly. */ virtual void Initialize(); @@ -228,8 +227,10 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction virtual void MultiThreadingInitialize(); - /** Number of spatial samples to used to compute metric - * This sets the number of samples. */ + /** Number of spatial samples to compute the metric. + * + * Sets the number of samples. + */ virtual void SetNumberOfFixedImageSamples(SizeValueType numSamples); itkGetConstReferenceMacro(NumberOfFixedImageSamples, SizeValueType); @@ -371,14 +372,21 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction /** FixedImageSamplePoint type alias support */ using FixedImageSampleContainer = std::vector; - /** Uniformly select a sample set from the fixed image domain. */ + /** Uniformly select a sample set from the fixed image domain. + * + * Samples the fixed image using a random walk. + */ virtual void SampleFixedImageRegion(FixedImageSampleContainer & samples) const; + /** Use the indexes that have been passed to the metric. */ virtual void SampleFixedImageIndexes(FixedImageSampleContainer & samples) const; - /** Gather all the pixels from the fixed image domain. */ + /** Sample the fixed image domain using all pixels in the Fixed image region. + * + * Gathers all the pixels from the fixed image domain. + */ virtual void SampleFullFixedImageRegion(FixedImageSampleContainer & samples) const; @@ -476,11 +484,14 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction mutable std::unique_ptr m_ThreaderBSplineTransformWeights; mutable std::unique_ptr m_ThreaderBSplineTransformIndices; + /** Cache pre-transformed points, weights and indices. */ virtual void PreComputeTransformValues(); /** Transform a point from FixedImage domain to MovingImage domain. - * This function also checks if mapped point is within support region. */ + * + * This function also checks if mapped point is within support region. + */ virtual void TransformPoint(unsigned int sampleNumber, MovingImagePointType & mappedPoint, @@ -488,6 +499,10 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction double & movingImageValue, ThreadIdType threadId) const; + /** Transform a point from FixedImage domain to MovingImage domain. + * + * This function also checks if mapped point is within support region. + */ virtual void TransformPointWithDerivatives(unsigned int sampleNumber, MovingImagePointType & mappedPoint, @@ -504,7 +519,9 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction /** Pointer to central difference calculator. */ typename DerivativeFunctionType::Pointer m_DerivativeCalculator; - /** Compute image derivatives at a point. */ + /** Compute image derivatives at a point using a central difference function if we are not using a + * BSplineInterpolator, which includes derivatives. + */ virtual void ComputeImageDerivatives(const MovingImagePointType & mappedPoint, ImageDerivativesType & gradient, @@ -578,15 +595,19 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction void GetValueMultiThreadedPostProcessInitiate() const; + /** Get the match Measure. */ static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueMultiThreaded(void * workunitInfoAsVoid); + /** Get the match Measure. */ static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetValueMultiThreadedPostProcess(void * workunitInfoAsVoid); + /** Get the match Measur.e */ virtual inline void GetValueThread(ThreadIdType threadId) const; + /** Get the match Measure. */ virtual inline void GetValueThreadPreProcess(ThreadIdType itkNotUsed(threadId), bool itkNotUsed(withinSampleThread)) const {} @@ -633,8 +654,10 @@ class ITK_TEMPLATE_EXPORT ImageToImageMetric : public SingleValuedCostFunction GetValueAndDerivativeThreadPostProcess(ThreadIdType itkNotUsed(threadId), bool itkNotUsed(withinSampleThread)) const {} - /** Synchronizes the threader transforms with the transform - * member variable. + /** Synchronizes the threader transforms with the transform member variable. + * + * This method can be const because we are not altering the m_ThreaderTransform pointer. We are altering the object + * that m_ThreaderTransform[idx] points at.* This is allowed under C++ const rules. */ virtual void SynchronizeTransforms() const; diff --git a/Modules/Registration/Common/include/itkImageToImageMetric.hxx b/Modules/Registration/Common/include/itkImageToImageMetric.hxx index f2122fb219f..3be5b66f188 100644 --- a/Modules/Registration/Common/include/itkImageToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkImageToImageMetric.hxx @@ -24,9 +24,7 @@ namespace itk { -/** - * Constructor - */ + template ImageToImageMetric::ImageToImageMetric() : m_FixedImageIndexes(0) @@ -71,11 +69,6 @@ ImageToImageMetric::ImageToImageMetric() */ } - -/** - * Set the number of work units. This will be clamped by the - * multithreader, so we must check to see if it is accepted. - */ template void ImageToImageMetric::SetNumberOfWorkUnits(ThreadIdType numberOfWorkUnits) @@ -84,9 +77,6 @@ ImageToImageMetric::SetNumberOfWorkUnits(ThreadIdType m_NumberOfWorkUnits = m_Threader->GetNumberOfWorkUnits(); } -/** - * Set the parameters that define a unique transform - */ template void ImageToImageMetric::SetTransformParameters(const ParametersType & parameters) const @@ -228,9 +218,6 @@ ImageToImageMetric::SetUseSequentialSampling(bool use } } -/** - * Initialize - */ template void ImageToImageMetric::Initialize() @@ -297,9 +284,6 @@ ImageToImageMetric::Initialize() this->InvokeEvent(InitializeEvent()); } -/** - * MultiThreading Initialize - */ template void ImageToImageMetric::MultiThreadingInitialize() @@ -436,9 +420,6 @@ ImageToImageMetric::MultiThreadingInitialize() } } -/** - * Use the indexes that have been passed to the metric - */ template void ImageToImageMetric::SampleFixedImageIndexes(FixedImageSampleContainer & samples) const @@ -467,9 +448,6 @@ ImageToImageMetric::SampleFixedImageIndexes(FixedImag } } -/** - * Sample the fixed image using a random walk - */ template void ImageToImageMetric::SampleFixedImageRegion(FixedImageSampleContainer & samples) const @@ -586,9 +564,6 @@ ImageToImageMetric::SampleFixedImageRegion(FixedImage } } -/** - * Sample the fixed image domain using all pixels in the Fixed image region - */ template void ImageToImageMetric::SampleFullFixedImageRegion(FixedImageSampleContainer & samples) const @@ -680,9 +655,6 @@ ImageToImageMetric::SampleFullFixedImageRegion(FixedI } } -/** - * Compute the gradient image and assign it to m_GradientImage. - */ template void ImageToImageMetric::ComputeGradient() @@ -709,7 +681,6 @@ ImageToImageMetric::ComputeGradient() m_GradientImage = gradientFilter->GetOutput(); } -// Method to reinitialize the seed of the random number generator template void ImageToImageMetric::ReinitializeSeed() @@ -717,7 +688,6 @@ ImageToImageMetric::ReinitializeSeed() m_ReseedIterator = true; } -// Method to reinitialize the seed of the random number generator template void ImageToImageMetric::ReinitializeSeed(int seed) @@ -726,9 +696,6 @@ ImageToImageMetric::ReinitializeSeed(int seed) m_RandomSeed = seed; } -/** - * Cache pre-transformed points, weights and indices. - */ template void ImageToImageMetric::PreComputeTransformValues() @@ -784,10 +751,6 @@ ImageToImageMetric::PreComputeTransformValues() // m_Transform->SetParameters( *previousParameters ); } -/** - * Transform a point from FixedImage domain to MovingImage domain. - * This function also checks if mapped point is within support region. - */ template void ImageToImageMetric::TransformPoint(unsigned int sampleNumber, @@ -896,10 +859,6 @@ ImageToImageMetric::TransformPoint(unsigned int } } -/** - * Transform a point from FixedImage domain to MovingImage domain. - * This function also checks if mapped point is within support region. - */ template void ImageToImageMetric::TransformPointWithDerivatives(unsigned int sampleNumber, @@ -1014,11 +973,6 @@ ImageToImageMetric::TransformPointWithDerivatives(uns } } -/** - * Compute image derivatives using a central difference function - * if we are not using a BSplineInterpolator, which includes - * derivatives. - */ template void ImageToImageMetric::ComputeImageDerivatives(const MovingImagePointType & mappedPoint, @@ -1071,9 +1025,6 @@ ImageToImageMetric::GetValueMultiThreadedPostProcessI m_Threader->SingleMethodExecute(); } -/** - * Get the match Measure - */ template ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ImageToImageMetric::GetValueMultiThreaded(void * workunitInfoAsVoid) @@ -1084,9 +1035,6 @@ ImageToImageMetric::GetValueMultiThreaded(void * work return ITK_THREAD_RETURN_DEFAULT_VALUE; } -/** - * Get the match Measure - */ template ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ImageToImageMetric::GetValueMultiThreadedPostProcess(void * workunitInfoAsVoid) @@ -1177,9 +1125,6 @@ ImageToImageMetric::GetValueAndDerivativeMultiThreade m_Threader->SingleMethodExecute(); } -/** - * Get the match Measure - */ template ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ImageToImageMetric::GetValueAndDerivativeMultiThreaded(void * workunitInfoAsVoid) @@ -1190,9 +1135,6 @@ ImageToImageMetric::GetValueAndDerivativeMultiThreade return ITK_THREAD_RETURN_DEFAULT_VALUE; } -/** - * Get the match Measure - */ template ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ImageToImageMetric::GetValueAndDerivativeMultiThreadedPostProcess(void * workunitInfoAsVoid) @@ -1262,9 +1204,6 @@ ImageToImageMetric::GetValueAndDerivativeThread(Threa } } -/** - * PrintSelf - */ template void ImageToImageMetric::PrintSelf(std::ostream & os, Indent indent) const @@ -1335,10 +1274,6 @@ ImageToImageMetric::PrintSelf(std::ostream & os, Inde os << this->m_UseCachingOfBSplineWeights << std::endl; } -/** This method can be const because we are not altering the m_ThreaderTransform - * pointer. We are altering the object that m_ThreaderTransform[idx] points at. - * This is allowed under C++ const rules. - */ template void ImageToImageMetric::SynchronizeTransforms() const diff --git a/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.h b/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.h index ab1e527436b..66ef79d012e 100644 --- a/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.h +++ b/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.h @@ -144,16 +144,16 @@ class ITK_TEMPLATE_EXPORT ImageToSpatialObjectMetric : public SingleValuedCostFu MeasureType & Value, DerivativeType & Derivative) const override = 0; - /** Return the number of parameters required by the Transform */ + /** Return the number of parameters required by the Transform. */ unsigned int GetNumberOfParameters() const override; - /** Initialize the metric */ + /** Initialize the metric. */ virtual void Initialize(); /** Get the last transformation parameters visited by - * the optimizer. This function overload the superclass's one */ + * the optimizer. This function overload the superclass's one. */ itkGetConstReferenceMacro(LastTransformParameters, ParametersType); /** Set/Get the Transform. */ diff --git a/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.hxx b/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.hxx index e7526feba59..83d01b9cfcc 100644 --- a/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.hxx +++ b/Modules/Registration/Common/include/itkImageToSpatialObjectMetric.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template ImageToSpatialObjectMetric::ImageToSpatialObjectMetric() @@ -32,7 +32,6 @@ ImageToSpatialObjectMetric::ImageToSpatialObj m_Interpolator = nullptr; // has to be provided by the user. } -/** Return the number of parameters required by the Transform */ template unsigned int ImageToSpatialObjectMetric::GetNumberOfParameters() const @@ -44,10 +43,6 @@ ImageToSpatialObjectMetric::GetNumberOfParame return m_Transform->GetNumberOfParameters(); } -/** - * Initialize - */ - template void ImageToSpatialObjectMetric::Initialize() @@ -82,7 +77,6 @@ ImageToSpatialObjectMetric::Initialize() this->InvokeEvent(InitializeEvent()); } -/** PrintSelf */ template void ImageToSpatialObjectMetric::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.h b/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.h index ffcc38ce3af..46319cdd4f0 100644 --- a/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.h +++ b/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.h @@ -162,7 +162,10 @@ class ITK_TEMPLATE_EXPORT MatchCardinalityImageToImageMetric : public ImageToIma /** Static function used as a "callback" by the MultiThreaderBase. The threading * library will call this routine for each thread, which will delegate the - * control to ThreadedGetValue(). */ + * control to ThreadedGetValue. + * + * Calls the ThreadedGenerateData method after setting the correct region for this thread. + */ static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback(void * arg); diff --git a/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.hxx b/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.hxx index 7db4396d8c6..57e292041cc 100644 --- a/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkMatchCardinalityImageToImageMetric.hxx @@ -23,18 +23,13 @@ namespace itk { -/** - * Constructor - */ + template MatchCardinalityImageToImageMetric::MatchCardinalityImageToImageMetric() { this->SetComputeGradient(false); // don't use the default gradients } -/* - * Get the match Measure - */ template typename MatchCardinalityImageToImageMetric::MeasureType MatchCardinalityImageToImageMetric::GetValue( @@ -43,9 +38,6 @@ MatchCardinalityImageToImageMetric::GetValue( return const_cast(this)->GetNonconstValue(parameters); } -/** - * Get the match Measure (non const version. spawns threads). - */ template typename MatchCardinalityImageToImageMetric::MeasureType MatchCardinalityImageToImageMetric::GetNonconstValue( @@ -183,7 +175,6 @@ MatchCardinalityImageToImageMetric::ThreadedGetValue( m_ThreadCounts[threadId] = threadNumberOfPixelsCounted; } -//---------------------------------------------------------------------------- template ThreadIdType MatchCardinalityImageToImageMetric::SplitFixedRegion(ThreadIdType i, @@ -241,9 +232,6 @@ MatchCardinalityImageToImageMetric::SplitFixedRegion( return maxThreadIdUsed + 1; } -// Callback routine used by the threading library. This routine just calls -// the ThreadedGenerateData method after setting the correct region for this -// thread. template ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION MatchCardinalityImageToImageMetric::ThreaderCallback(void * arg) @@ -275,9 +263,6 @@ MatchCardinalityImageToImageMetric::ThreaderCallback( return ITK_THREAD_RETURN_DEFAULT_VALUE; } -/** - * PrintSelf - */ template void MatchCardinalityImageToImageMetric::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.h b/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.h index 601e21357bd..d86fa55ae34 100644 --- a/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.h +++ b/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.h @@ -282,7 +282,7 @@ class ITK_TEMPLATE_EXPORT MattesMutualInformationImageToImageMetric void CommonGetValueProcessing() const; - /** Precompute fixed image parzen window indices. */ + /** Compute the Parzen window index locations from the pre-computed samples. */ void ComputeFixedImageParzenWindowIndices(FixedImageSampleContainer & samples); diff --git a/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.hxx b/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.hxx index 2e19dfdc05d..60e1d7a9533 100644 --- a/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkMattesMutualInformationImageToImageMetric.hxx @@ -29,9 +29,7 @@ namespace itk { -/** - * Constructor - */ + template MattesMutualInformationImageToImageMetric::MattesMutualInformationImageToImageMetric() : m_PRatioArray(0, 0) @@ -320,10 +318,6 @@ MattesMutualInformationImageToImageMetric::Initialize this->ComputeFixedImageParzenWindowIndices(this->m_FixedImageSamples); } -/** - * From the pre-computed samples, now - * fill in the parzen window index locations - */ template void MattesMutualInformationImageToImageMetric::ComputeFixedImageParzenWindowIndices( @@ -697,9 +691,6 @@ MattesMutualInformationImageToImageMetric::GetValueAn } } -/** - * Get the both Value and Derivative Measure - */ template void MattesMutualInformationImageToImageMetric::GetValueAndDerivative( @@ -878,9 +869,6 @@ MattesMutualInformationImageToImageMetric::CommonGetV } } -/** - * Get the match measure derivative - */ template void MattesMutualInformationImageToImageMetric::GetDerivative(const ParametersType & parameters, @@ -892,9 +880,6 @@ MattesMutualInformationImageToImageMetric::GetDerivat this->GetValueAndDerivative(parameters, value, derivative); } -/** - * Compute PDF derivatives contribution for each parameter - */ template void MattesMutualInformationImageToImageMetric::ComputePDFDerivatives( diff --git a/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferenceImageToImageMetric.hxx b/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferenceImageToImageMetric.hxx index 37526046aa5..b1485351344 100644 --- a/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferenceImageToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferenceImageToImageMetric.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template MeanReciprocalSquareDifferenceImageToImageMetric::MeanReciprocalSquareDifferenceImageToImageMetric() @@ -33,9 +31,6 @@ MeanReciprocalSquareDifferenceImageToImageMetric void MeanReciprocalSquareDifferenceImageToImageMetric::PrintSelf(std::ostream & os, @@ -46,9 +41,6 @@ MeanReciprocalSquareDifferenceImageToImageMetric::Pri os << indent << "Delta value = " << m_Delta << std::endl; } -/* - * Get the match Measure - */ template typename MeanReciprocalSquareDifferenceImageToImageMetric::MeasureType MeanReciprocalSquareDifferenceImageToImageMetric::GetValue( @@ -113,9 +105,6 @@ MeanReciprocalSquareDifferenceImageToImageMetric::Get return measure; } -/** - * Get the Derivative Measure - */ template void MeanReciprocalSquareDifferenceImageToImageMetric::GetDerivative( @@ -140,9 +129,6 @@ MeanReciprocalSquareDifferenceImageToImageMetric::Get } } -/** - * Get both the match Measure and theDerivative Measure - */ template void MeanReciprocalSquareDifferenceImageToImageMetric::GetValueAndDerivative( diff --git a/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferencePointSetToImageMetric.hxx b/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferencePointSetToImageMetric.hxx index e3d2fa5d537..fc5718051ca 100644 --- a/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferencePointSetToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkMeanReciprocalSquareDifferencePointSetToImageMetric.hxx @@ -22,9 +22,7 @@ namespace itk { -/* - * Constructor - */ + template MeanReciprocalSquareDifferencePointSetToImageMetric::MeanReciprocalSquareDifferencePointSetToImageMetric() @@ -32,9 +30,6 @@ MeanReciprocalSquareDifferencePointSetToImageMetric typename MeanReciprocalSquareDifferencePointSetToImageMetric::MeasureType MeanReciprocalSquareDifferencePointSetToImageMetric::GetValue( @@ -92,9 +87,6 @@ MeanReciprocalSquareDifferencePointSetToImageMetric void MeanReciprocalSquareDifferencePointSetToImageMetric::GetDerivative( @@ -192,9 +184,6 @@ MeanReciprocalSquareDifferencePointSetToImageMetric void MeanReciprocalSquareDifferencePointSetToImageMetric::GetValueAndDerivative( @@ -295,9 +284,6 @@ MeanReciprocalSquareDifferencePointSetToImageMetric void MeanReciprocalSquareDifferencePointSetToImageMetric::PrintSelf(std::ostream & os, diff --git a/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.h b/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.h index f2596d831d6..c16788e57b4 100644 --- a/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.h +++ b/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.h @@ -150,8 +150,10 @@ class ITK_TEMPLATE_EXPORT MeanSquareRegistrationFunction 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 & neighborhood, void * globalData, diff --git a/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.hxx b/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.hxx index 4692747fea1..7323ed2a0dd 100644 --- a/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.hxx +++ b/Modules/Registration/Common/include/itkMeanSquareRegistrationFunction.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Default constructor - */ + template MeanSquareRegistrationFunction::MeanSquareRegistrationFunction() { @@ -51,9 +49,6 @@ MeanSquareRegistrationFunction::M m_MovingImageInterpolator = itkDynamicCastInDebugMode(interp.GetPointer()); } -/* - * Standard "PrintSelf" method. - */ template void MeanSquareRegistrationFunction::PrintSelf(std::ostream & os, @@ -72,9 +67,6 @@ MeanSquareRegistrationFunction::P */ } -/* - * Set the function state values before each iteration - */ template void MeanSquareRegistrationFunction::InitializeIteration() @@ -96,9 +88,6 @@ MeanSquareRegistrationFunction::I this->SetEnergy(0.0); } -/** - * Compute update at a non boundary neighbourhood - */ template typename MeanSquareRegistrationFunction::PixelType MeanSquareRegistrationFunction::ComputeUpdate( diff --git a/Modules/Registration/Common/include/itkMeanSquaresImageToImageMetric.hxx b/Modules/Registration/Common/include/itkMeanSquaresImageToImageMetric.hxx index b5d1bf414d5..ed5510e3a4f 100644 --- a/Modules/Registration/Common/include/itkMeanSquaresImageToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkMeanSquaresImageToImageMetric.hxx @@ -26,9 +26,7 @@ namespace itk { -/** - * Constructor - */ + template MeanSquaresImageToImageMetric::MeanSquaresImageToImageMetric() { @@ -43,9 +41,6 @@ MeanSquaresImageToImageMetric::MeanSquaresImageToImag this->SetUseAllPixels(true); } -/** - * Print out internal information about this class - */ template void MeanSquaresImageToImageMetric::PrintSelf(std::ostream & os, Indent indent) const @@ -53,9 +48,6 @@ MeanSquaresImageToImageMetric::PrintSelf(std::ostream Superclass::PrintSelf(os, indent); } -/** - * Initialize - */ template void MeanSquaresImageToImageMetric::Initialize() @@ -177,9 +169,6 @@ MeanSquaresImageToImageMetric::GetValueAndDerivativeT return true; } -/** - * Get the both Value and Derivative Measure - */ template void MeanSquaresImageToImageMetric::GetValueAndDerivative(const ParametersType & parameters, @@ -241,9 +230,6 @@ MeanSquaresImageToImageMetric::GetValueAndDerivative( } } -/** - * Get the match measure derivative - */ template void MeanSquaresImageToImageMetric::GetDerivative(const ParametersType & parameters, diff --git a/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.h b/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.h index 8be27a4e90a..60861892503 100644 --- a/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.h +++ b/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.h @@ -134,7 +134,7 @@ class ITK_TEMPLATE_EXPORT MultiResolutionImageRegistrationMethod : public Proces /** Smart Pointer type to a DataObject. */ using DataObjectPointer = typename DataObject::Pointer; - /** Method to stop the registration. */ + /** Stop the registration. */ void StopRegistration(); @@ -174,7 +174,7 @@ class ITK_TEMPLATE_EXPORT MultiResolutionImageRegistrationMethod : public Proces itkSetObjectMacro(MovingImagePyramid, MovingImagePyramidType); itkGetModifiableObjectMacro(MovingImagePyramid, MovingImagePyramidType); - /** Set/Get the schedules . */ + /** Set/Get the schedules for the fixed and moving image pyramid. */ void SetSchedules(const ScheduleType & fixedImagePyramidSchedule, const ScheduleType & movingImagePyramidSchedule); diff --git a/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.hxx b/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.hxx index 9f6fa157746..e6641b8bbee 100644 --- a/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.hxx +++ b/Modules/Registration/Common/include/itkMultiResolutionImageRegistrationMethod.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template MultiResolutionImageRegistrationMethod::MultiResolutionImageRegistrationMethod() { @@ -64,9 +62,6 @@ MultiResolutionImageRegistrationMethod::MultiResoluti this->ProcessObject::SetNthOutput(0, transformDecorator.GetPointer()); } -/* - * Initialize by setting the interconnects between components. - */ template void MultiResolutionImageRegistrationMethod::Initialize() @@ -112,9 +107,6 @@ MultiResolutionImageRegistrationMethod::Initialize() transformOutput->Set(m_Transform); } -/* - * Stop the Registration Process - */ template void MultiResolutionImageRegistrationMethod::StopRegistration() @@ -122,9 +114,6 @@ MultiResolutionImageRegistrationMethod::StopRegistrat m_Stop = true; } -/** - * Set the schedules for the fixed and moving image pyramid - */ template void MultiResolutionImageRegistrationMethod::SetSchedules( @@ -153,9 +142,6 @@ MultiResolutionImageRegistrationMethod::SetSchedules( this->Modified(); } -/** - * Set the number of levels - */ template void MultiResolutionImageRegistrationMethod::SetNumberOfLevels(SizeValueType numberOfLevels) @@ -171,9 +157,6 @@ MultiResolutionImageRegistrationMethod::SetNumberOfLe this->Modified(); } -/** - * Stop the Registration Process - */ template void MultiResolutionImageRegistrationMethod::PreparePyramids() @@ -277,9 +260,6 @@ MultiResolutionImageRegistrationMethod::PreparePyrami } } -/* - * PrintSelf - */ template void MultiResolutionImageRegistrationMethod::PrintSelf(std::ostream & os, Indent indent) const @@ -321,9 +301,6 @@ MultiResolutionImageRegistrationMethod::PrintSelf(std os << m_MovingImagePyramidSchedule << std::endl; } -/* - * Generate Data - */ template void MultiResolutionImageRegistrationMethod::GenerateData() @@ -435,9 +412,6 @@ MultiResolutionImageRegistrationMethod::GetMTime() co return mtime; } -/* - * Get Output - */ template auto MultiResolutionImageRegistrationMethod::GetOutput() const -> const TransformOutputType * diff --git a/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.h b/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.h index 0d76158f524..a269d1faaae 100644 --- a/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.h +++ b/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.h @@ -226,7 +226,7 @@ class ITK_TEMPLATE_EXPORT MultiResolutionPyramidImageFilter : public ImageToImag void PrintSelf(std::ostream & os, Indent indent) const override; - /** Generate the output data. */ + /** Generate the output data for non-downward divisible schedules. */ void GenerateData() override; diff --git a/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.hxx b/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.hxx index 000001a0af9..a35eb0aef3e 100644 --- a/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.hxx +++ b/Modules/Registration/Common/include/itkMultiResolutionPyramidImageFilter.hxx @@ -30,9 +30,7 @@ namespace itk { -/** - * Constructor - */ + template MultiResolutionPyramidImageFilter::MultiResolutionPyramidImageFilter() { @@ -42,9 +40,6 @@ MultiResolutionPyramidImageFilter::MultiResolutionPyr m_UseShrinkImageFilter = false; } -/** - * Set the number of computation levels - */ template void MultiResolutionPyramidImageFilter::SetNumberOfLevels(unsigned int num) @@ -99,9 +94,6 @@ MultiResolutionPyramidImageFilter::SetNumberOfLevels( } } -/* - * Set the starting shrink factors - */ template void MultiResolutionPyramidImageFilter::SetStartingShrinkFactors(unsigned int factor) @@ -110,9 +102,6 @@ MultiResolutionPyramidImageFilter::SetStartingShrinkF this->SetStartingShrinkFactors(fixedArray.GetDataPointer()); } -/** - * Set the starting shrink factors - */ template void MultiResolutionPyramidImageFilter::SetStartingShrinkFactors(const unsigned int * factors) @@ -141,9 +130,6 @@ MultiResolutionPyramidImageFilter::SetStartingShrinkF this->Modified(); } -/* - * Get the starting shrink factors - */ template const unsigned int * MultiResolutionPyramidImageFilter::GetStartingShrinkFactors() const @@ -151,9 +137,6 @@ MultiResolutionPyramidImageFilter::GetStartingShrinkF return (m_Schedule.data_block()); } -/* - * Set the multi-resolution schedule - */ template void MultiResolutionPyramidImageFilter::SetSchedule(const ScheduleType & schedule) @@ -192,9 +175,6 @@ MultiResolutionPyramidImageFilter::SetSchedule(const } } -/* - * Is the schedule downward divisible ? - */ template bool MultiResolutionPyramidImageFilter::IsScheduleDownwardDivisible(const ScheduleType & schedule) @@ -219,9 +199,6 @@ MultiResolutionPyramidImageFilter::IsScheduleDownward return true; } -/* - * GenerateData for non downward divisible schedules - */ template void MultiResolutionPyramidImageFilter::GenerateData() @@ -313,9 +290,6 @@ MultiResolutionPyramidImageFilter::GenerateData() } } -/** - * PrintSelf method - */ template void MultiResolutionPyramidImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -329,9 +303,6 @@ MultiResolutionPyramidImageFilter::PrintSelf(std::ost os << indent << "Use ShrinkImageFilter= " << m_UseShrinkImageFilter << std::endl; } -/* - * GenerateOutputInformation - */ template void MultiResolutionPyramidImageFilter::GenerateOutputInformation() @@ -404,9 +375,6 @@ MultiResolutionPyramidImageFilter::GenerateOutputInfo } } -/* - * GenerateOutputRequestedRegion - */ template void MultiResolutionPyramidImageFilter::GenerateOutputRequestedRegion(DataObject * refOutput) @@ -500,9 +468,6 @@ MultiResolutionPyramidImageFilter::GenerateOutputRequ } } -/** - * GenerateInputRequestedRegion - */ template void MultiResolutionPyramidImageFilter::GenerateInputRequestedRegion() diff --git a/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.h b/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.h index 0892c823904..0186a23ef47 100644 --- a/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.h +++ b/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.h @@ -137,11 +137,11 @@ class ITK_TEMPLATE_EXPORT MutualInformationImageToImageMetric : public ImageToIm void GetDerivative(const ParametersType & parameters, DerivativeType & derivative) const override; - /** Get the value. */ + /** Get the value. */ MeasureType GetValue(const ParametersType & parameters) const override; - /** Get the value and derivatives for single valued optimizers. */ + /** Get the value and derivatives for single valued optimizers. */ void GetValueAndDerivative(const ParametersType & parameters, MeasureType & value, @@ -227,15 +227,27 @@ class ITK_TEMPLATE_EXPORT MutualInformationImageToImageMetric : public ImageToIm typename KernelFunctionType::Pointer m_KernelFunction{}; /** Uniformly select samples from the fixed image buffer. + * + * Each sample consists of: + * - the fixed image value + * - the corresponding moving image value + * * \warning Note that this method has a different signature than the one in * the base OptImageToImageMetric and therefore they are not intended to * provide polymorphism. That is, this function is not overriding the one in - * the base class. */ + * the base class. + */ virtual void SampleFixedImageDomain(SpatialSampleContainer & samples) const; - /** - * Calculate the intensity derivatives at a point + /* + * Calculate derivatives of the image intensity at the specified point with respect to the transform parmeters. + * + * \todo This should really be done by the mapper. + * + * \todo This is a temporary solution until this feature is implemented + * in the mapper. This solution only works for any transform + * that support ComputeJacobianWithRespectToParameters() */ void CalculateDerivatives(const FixedImagePointType &, DerivativeType &, TransformJacobianType &) const; diff --git a/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.hxx b/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.hxx index 6ab4f1f5219..9802f2cf783 100644 --- a/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkMutualInformationImageToImageMetric.hxx @@ -25,9 +25,7 @@ namespace itk { -/** - * Constructor - */ + template MutualInformationImageToImageMetric::MutualInformationImageToImageMetric() { @@ -64,9 +62,6 @@ MutualInformationImageToImageMetric::PrintSelf(std::o os << m_KernelFunction.GetPointer() << std::endl; } -/* - * Set the number of spatial samples - */ template void MutualInformationImageToImageMetric::SetNumberOfSpatialSamples(unsigned int num) @@ -86,17 +81,6 @@ MutualInformationImageToImageMetric::SetNumberOfSpati m_SampleB.resize(m_NumberOfSpatialSamples); } -/* - * Uniformly sample the fixed image domain. Each sample consists of: - * - the fixed image value - * - the corresponding moving image value - * - * \warning Note that this method has a different signature than the one in - * the base OptImageToImageMetric and therefore they are not intended to - * provide polymorphism. That is, this function is not overriding the one in - * the base class. - * - */ template void MutualInformationImageToImageMetric::SampleFixedImageDomain( @@ -193,9 +177,6 @@ MutualInformationImageToImageMetric::SampleFixedImage } } -/* - * Get the match Measure - */ template auto MutualInformationImageToImageMetric::GetValue(const ParametersType & parameters) const @@ -279,9 +260,6 @@ MutualInformationImageToImageMetric::GetValue(const P return measure; } -/* - * Get the both Value and Derivative Measure - */ template void MutualInformationImageToImageMetric::GetValueAndDerivative(const ParametersType & parameters, @@ -423,9 +401,6 @@ MutualInformationImageToImageMetric::GetValueAndDeriv derivative /= itk::Math::sqr(m_MovingImageStandardDeviation); } -/* - * Get the match measure derivative - */ template void MutualInformationImageToImageMetric::GetDerivative(const ParametersType & parameters, @@ -437,16 +412,6 @@ MutualInformationImageToImageMetric::GetDerivative(co this->GetValueAndDerivative(parameters, value, derivative); } -/* - * Calculate derivatives of the image intensity with respect - * to the transform parmeters. - * - * This should really be done by the mapper. - * - * This is a temporary solution until this feature is implemented - * in the mapper. This solution only works for any transform - * that support ComputeJacobianWithRespectToParameters() - */ template void MutualInformationImageToImageMetric::CalculateDerivatives( diff --git a/Modules/Registration/Common/include/itkNormalizedCorrelationImageToImageMetric.hxx b/Modules/Registration/Common/include/itkNormalizedCorrelationImageToImageMetric.hxx index 2e5eb5b4d5d..2f1be44129d 100644 --- a/Modules/Registration/Common/include/itkNormalizedCorrelationImageToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkNormalizedCorrelationImageToImageMetric.hxx @@ -22,18 +22,13 @@ namespace itk { -/** - * Constructor - */ + template NormalizedCorrelationImageToImageMetric::NormalizedCorrelationImageToImageMetric() { m_SubtractMean = false; } -/** - * Get the match Measure - */ template typename NormalizedCorrelationImageToImageMetric::MeasureType NormalizedCorrelationImageToImageMetric::GetValue( @@ -126,9 +121,6 @@ NormalizedCorrelationImageToImageMetric::GetValue( return measure; } -/** - * Get the Derivative Measure - */ template void NormalizedCorrelationImageToImageMetric::GetDerivative( @@ -311,9 +303,6 @@ NormalizedCorrelationImageToImageMetric::GetDerivativ } } -/* - * Get both the match Measure and theDerivative Measure - */ template void NormalizedCorrelationImageToImageMetric::GetValueAndDerivative( diff --git a/Modules/Registration/Common/include/itkNormalizedCorrelationPointSetToImageMetric.hxx b/Modules/Registration/Common/include/itkNormalizedCorrelationPointSetToImageMetric.hxx index 2cc7a658905..8a2ded0b9c3 100644 --- a/Modules/Registration/Common/include/itkNormalizedCorrelationPointSetToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkNormalizedCorrelationPointSetToImageMetric.hxx @@ -22,18 +22,13 @@ namespace itk { -/** - * Constructor - */ + template NormalizedCorrelationPointSetToImageMetric::NormalizedCorrelationPointSetToImageMetric() { m_SubtractMean = false; } -/** - * Get the match Measure - */ template typename NormalizedCorrelationPointSetToImageMetric::MeasureType NormalizedCorrelationPointSetToImageMetric::GetValue( @@ -112,9 +107,6 @@ NormalizedCorrelationPointSetToImageMetric::GetVal return measure; } -/** - * Get the Derivative Measure - */ template void NormalizedCorrelationPointSetToImageMetric::GetDerivative( @@ -257,9 +249,6 @@ NormalizedCorrelationPointSetToImageMetric::GetDer } } -/* - * Get both the match Measure and theDerivative Measure - */ template void NormalizedCorrelationPointSetToImageMetric::GetValueAndDerivative( diff --git a/Modules/Registration/Common/include/itkPointSetToImageMetric.h b/Modules/Registration/Common/include/itkPointSetToImageMetric.h index 6ce5449ed02..86fc9c5ab88 100644 --- a/Modules/Registration/Common/include/itkPointSetToImageMetric.h +++ b/Modules/Registration/Common/include/itkPointSetToImageMetric.h @@ -151,15 +151,14 @@ class ITK_TEMPLATE_EXPORT PointSetToImageMetric : public SingleValuedCostFunctio itkSetMacro(ComputeGradient, bool); itkGetConstReferenceMacro(ComputeGradient, bool); - /** Return the number of parameters required by the Transform */ + /** Get the number of parameters required by the Transform. */ unsigned int GetNumberOfParameters() const override { return m_Transform->GetNumberOfParameters(); } - /** Initialize the Metric by making sure that all the components - * are present and plugged together correctly */ + /** Initialize the Metric by making sure that all the components are present and plugged together correctly. */ virtual void Initialize(); diff --git a/Modules/Registration/Common/include/itkPointSetToImageMetric.hxx b/Modules/Registration/Common/include/itkPointSetToImageMetric.hxx index 229cb1e24f8..ace2a2e4fe1 100644 --- a/Modules/Registration/Common/include/itkPointSetToImageMetric.hxx +++ b/Modules/Registration/Common/include/itkPointSetToImageMetric.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template PointSetToImageMetric::PointSetToImageMetric() { @@ -36,9 +34,6 @@ PointSetToImageMetric::PointSetToImageMetric() m_GradientImage = nullptr; // computed at initialization } -/** - * Set the parameters that define a unique transform - */ template void PointSetToImageMetric::SetTransformParameters(const ParametersType & parameters) const @@ -50,9 +45,6 @@ PointSetToImageMetric::SetTransformParameters(cons m_Transform->SetParameters(parameters); } -/** - * PrintSelf - */ template void PointSetToImageMetric::Initialize() @@ -109,9 +101,6 @@ PointSetToImageMetric::Initialize() } } -/** - * PrintSelf - */ template void PointSetToImageMetric::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Registration/Common/include/itkPointSetToPointSetMetric.h b/Modules/Registration/Common/include/itkPointSetToPointSetMetric.h index c1c7482fae9..f43b2efabdd 100644 --- a/Modules/Registration/Common/include/itkPointSetToPointSetMetric.h +++ b/Modules/Registration/Common/include/itkPointSetToPointSetMetric.h @@ -108,7 +108,7 @@ class ITK_TEMPLATE_EXPORT PointSetToPointSetMetric : public MultipleValuedCostFu /** Connect the Transform. */ itkSetObjectMacro(Transform, TransformType); - /** Get a pointer to the Transform. */ + /** Get a pointer to the Transform. */ itkGetModifiableObjectMacro(Transform, TransformType); /** Set the parameters defining the Transform. */ @@ -122,8 +122,7 @@ class ITK_TEMPLATE_EXPORT PointSetToPointSetMetric : public MultipleValuedCostFu return m_Transform->GetNumberOfParameters(); } - /** Initialize the Metric by making sure that all the components - * are present and plugged together correctly */ + /** Initialize the Metric by making sure that all the components are present and plugged together correctly. */ virtual void Initialize(); diff --git a/Modules/Registration/Common/include/itkPointSetToPointSetMetric.hxx b/Modules/Registration/Common/include/itkPointSetToPointSetMetric.hxx index c637ff19f22..0e1ef268130 100644 --- a/Modules/Registration/Common/include/itkPointSetToPointSetMetric.hxx +++ b/Modules/Registration/Common/include/itkPointSetToPointSetMetric.hxx @@ -21,7 +21,7 @@ namespace itk { -/** Constructor */ + template PointSetToPointSetMetric::PointSetToPointSetMetric() { @@ -30,7 +30,6 @@ PointSetToPointSetMetric::PointSetToPointSetMet m_Transform = nullptr; // has to be provided by the user. } -/** Set the parameters that define a unique transform */ template void PointSetToPointSetMetric::SetTransformParameters( @@ -43,7 +42,6 @@ PointSetToPointSetMetric::SetTransformParameter m_Transform->SetParameters(parameters); } -/** Initialize the metric */ template void PointSetToPointSetMetric::Initialize() @@ -70,7 +68,6 @@ PointSetToPointSetMetric::Initialize() m_FixedPointSet->UpdateSource(); } -/** PrintSelf */ template void PointSetToPointSetMetric::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Registration/Common/include/itkPointSetToSpatialObjectDemonsRegistration.hxx b/Modules/Registration/Common/include/itkPointSetToSpatialObjectDemonsRegistration.hxx index d20f5e695b2..c5ea467c7c2 100644 --- a/Modules/Registration/Common/include/itkPointSetToSpatialObjectDemonsRegistration.hxx +++ b/Modules/Registration/Common/include/itkPointSetToSpatialObjectDemonsRegistration.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template PointSetToSpatialObjectDemonsRegistration::PointSetToSpatialObjectDemonsRegistration() @@ -32,9 +30,6 @@ PointSetToSpatialObjectDemonsRegistration void PointSetToSpatialObjectDemonsRegistration::PrintSelf(std::ostream & os, diff --git a/Modules/Registration/Common/include/itkRecursiveMultiResolutionPyramidImageFilter.hxx b/Modules/Registration/Common/include/itkRecursiveMultiResolutionPyramidImageFilter.hxx index e6e28fea1eb..4bdc4de1aa7 100644 --- a/Modules/Registration/Common/include/itkRecursiveMultiResolutionPyramidImageFilter.hxx +++ b/Modules/Registration/Common/include/itkRecursiveMultiResolutionPyramidImageFilter.hxx @@ -30,18 +30,13 @@ namespace itk { -/** - * Constructor - */ + template RecursiveMultiResolutionPyramidImageFilter::RecursiveMultiResolutionPyramidImageFilter() { this->Superclass::m_UseShrinkImageFilter = true; } -/** - * GenerateData - */ template void RecursiveMultiResolutionPyramidImageFilter::GenerateData() @@ -216,9 +211,6 @@ RecursiveMultiResolutionPyramidImageFilter::GenerateD } } -/* - * GenerateOutputRequestedRegion - */ template void RecursiveMultiResolutionPyramidImageFilter::GenerateOutputRequestedRegion(DataObject * ptr) @@ -341,9 +333,6 @@ RecursiveMultiResolutionPyramidImageFilter::GenerateO delete oper; } -/** - * GenerateInputRequestedRegion - */ template void RecursiveMultiResolutionPyramidImageFilter::GenerateInputRequestedRegion() diff --git a/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFilter.hxx b/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFilter.hxx index e21cfecfc94..e0262e78f82 100644 --- a/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFilter.hxx +++ b/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFilter.hxx @@ -20,9 +20,7 @@ namespace itk { -/** - * Default constructor - */ + template GPUDemonsRegistrationFilter:: GPUDemonsRegistrationFilter() @@ -48,9 +46,6 @@ GPUDemonsRegistrationFilterGetIntensityDifferenceThreshold() << std::endl; } -/* - * Set the function state values before each iteration - */ template void GPUDemonsRegistrationFilter::InitializeIteration() @@ -75,9 +70,6 @@ GPUDemonsRegistrationFilter double GPUDemonsRegistrationFilter::GetMetric() const @@ -92,9 +84,6 @@ GPUDemonsRegistrationFilterGetMetric(); } -/** - * - */ template double GPUDemonsRegistrationFilter:: @@ -110,9 +99,6 @@ GPUDemonsRegistrationFilterGetIntensityDifferenceThreshold(); } -/** - * - */ template void GPUDemonsRegistrationFilter:: @@ -128,9 +114,6 @@ GPUDemonsRegistrationFilterSetIntensityDifferenceThreshold(threshold); } -/** - * Get the metric value from the difference function - */ template void GPUDemonsRegistrationFilter::ApplyUpdate( diff --git a/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.h b/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.h index 72eb09a0a10..5893d418dc1 100644 --- a/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.h +++ b/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.h @@ -155,7 +155,10 @@ class ITK_TEMPLATE_EXPORT GPUDemonsRegistrationFunction return global; } - /** Release memory for global data structure. */ + /** Release memory for global data structure. + * + * Updates the metric and releases the per-thread-global data. + */ void ReleaseGlobalDataPointer(void * GlobalData) const override; @@ -164,8 +167,7 @@ class ITK_TEMPLATE_EXPORT GPUDemonsRegistrationFunction void GPUAllocateMetricData(unsigned int numPixels) override; - /** Release GPU buffers for computing metric statistics - * */ + /** Release GPU buffers for computing metric statistics. */ void GPUReleaseMetricData() override; @@ -173,19 +175,24 @@ class ITK_TEMPLATE_EXPORT GPUDemonsRegistrationFunction 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 the specified 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 & neighborhood, void * globalData, const FloatOffsetType & offset = FloatOffsetType(0.0)) override; + /** Compute update at the specified neighbourhood. */ void GPUComputeUpdate(const DisplacementFieldTypePointer output, DisplacementFieldTypePointer update, void * gd) override; - /** Get the metric value. The metric value is the mean square difference - * in intensity between the fixed image and transforming moving image - * computed over the the overlapping region between the two images. */ + /** Get the metric value. + * + * The metric value is the mean square difference in intensity between the fixed image and transforming moving image + * computed over the the overlapping region between the two images. + */ virtual double GetMetric() const { diff --git a/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.hxx b/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.hxx index 83f3f4a7f1f..51fbedef530 100644 --- a/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.hxx +++ b/Modules/Registration/GPUPDEDeformable/include/itkGPUDemonsRegistrationFunction.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Default constructor - */ + template GPUDemonsRegistrationFunction::GPUDemonsRegistrationFunction() { @@ -93,9 +91,6 @@ GPUDemonsRegistrationFunction::GP m_ComputeUpdateGPUKernelHandle = this->m_GPUKernelManager->CreateKernel("ComputeUpdate"); } -/** - * Standard "PrintSelf" method. - */ template void GPUDemonsRegistrationFunction::PrintSelf(std::ostream & os, @@ -127,9 +122,6 @@ GPUDemonsRegistrationFunction::Pr os << m_SumOfSquaredChange << std::endl; } -/** - * - */ template void GPUDemonsRegistrationFunction::SetIntensityDifferenceThreshold( @@ -138,9 +130,6 @@ GPUDemonsRegistrationFunction::Se m_IntensityDifferenceThreshold = threshold; } -/** - * - */ template double GPUDemonsRegistrationFunction::GetIntensityDifferenceThreshold() const @@ -148,9 +137,6 @@ GPUDemonsRegistrationFunction::Ge return m_IntensityDifferenceThreshold; } -/** - * Set the function state values before each iteration - */ template void GPUDemonsRegistrationFunction::InitializeIteration() @@ -185,9 +171,6 @@ GPUDemonsRegistrationFunction::In m_SumOfSquaredChange = 0.0; } -/** - * Allocate GPU buffers for computing metric statistics - */ template void GPUDemonsRegistrationFunction::GPUAllocateMetricData( @@ -218,10 +201,6 @@ GPUDemonsRegistrationFunction::GP m_GPUSquaredDifference->ReleaseGPUInputBuffer(); } -/** - * Compute update at a specify neighbourhood - */ - template void GPUDemonsRegistrationFunction::GPUComputeUpdate( @@ -298,9 +277,6 @@ GPUDemonsRegistrationFunction::GP } } -/** - * Compute update at a specify neighbourhood - */ template typename GPUDemonsRegistrationFunction::PixelType GPUDemonsRegistrationFunction::ComputeUpdate( @@ -390,9 +366,6 @@ GPUDemonsRegistrationFunction::Co return update; } -/** - * Update the metric and release the per-thread-global data. - */ template void GPUDemonsRegistrationFunction::ReleaseGlobalDataPointer(void * gd) const diff --git a/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.h b/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.h index 70b08d11854..360665784ac 100644 --- a/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.h +++ b/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.h @@ -144,10 +144,8 @@ class ITK_TEMPLATE_EXPORT GPUPDEDeformableRegistrationFilter GPUPDEDeformableRegistrationFilter(); ~GPUPDEDeformableRegistrationFilter() override = default; - void - PrintSelf(std::ostream & os, Indent indent) const override; - - /** A simple method to copy the data from the input to the output. + /** Copy the data from the input to the output. + * * If the input does not exist, a zero field is written to the output. */ void CopyInputToOutput() override; @@ -158,13 +156,15 @@ class ITK_TEMPLATE_EXPORT GPUPDEDeformableRegistrationFilter InitializeIteration() override; /** Utility to smooth the deformation field (represented in the Output) - * using a Gaussian operator. The amount of smoothing can be specified + * using a separable Gaussian kernel. The amount of smoothing can be specified * by setting the StandardDeviations. */ void SmoothDisplacementField() override; - /** Smooth a vector field, which may be m_DisplacementField or - * m_UpdateBuffer. */ + /** Smooth a vector field using a separable Gaussian kernel. + * + * The smoothed field may be m_DisplacementField or m_UpdateBuffer. + */ virtual void GPUSmoothVectorField(DisplacementFieldPointer field, typename GPUDataManager::Pointer GPUSmoothingKernels[], @@ -173,18 +173,23 @@ class ITK_TEMPLATE_EXPORT GPUPDEDeformableRegistrationFilter virtual void AllocateSmoothingBuffer(); - /** Utility to smooth the UpdateBuffer using a Gaussian operator. + /** Smooth the UpdateBuffer using a separable Gaussian kernel. * The amount of smoothing can be specified by setting the * UpdateFieldStandardDeviations. */ void SmoothUpdateField() override; - /** This method is called after the solution has been generated. In this case, - * the filter release the memory of the internal buffers. */ + /** Release the memory of the internal buffers. + * + * Called after the solution has been generated. + */ void PostProcessOutput() override; - /** This method is called before iterating the solution. */ + /** Initialize flags. + * + * Called before iterating the solution. + */ void Initialize() override; diff --git a/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.hxx b/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.hxx index 8151090d9e7..042d897b175 100644 --- a/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.hxx +++ b/Modules/Registration/GPUPDEDeformable/include/itkGPUPDEDeformableRegistrationFilter.hxx @@ -32,9 +32,7 @@ namespace itk { -/** - * Default constructor - */ + template GPUPDEDeformableRegistrationFilter:: GPUPDEDeformableRegistrationFilter() @@ -87,9 +85,6 @@ GPUPDEDeformableRegistrationFilter void GPUPDEDeformableRegistrationFilter:: @@ -117,12 +112,6 @@ GPUPDEDeformableRegistrationFilterGPUSuperclass::InitializeIteration(); } -/* - * Override the default implementation for the case when the - * initial deformation is not set. - * If the initial deformation is not set, the output is - * fill with zero vectors. - */ template void GPUPDEDeformableRegistrationFilter:: @@ -219,9 +208,6 @@ GPUPDEDeformableRegistrationFilter void GPUPDEDeformableRegistrationFilter:: @@ -258,9 +244,6 @@ GPUPDEDeformableRegistrationFilterGetOutput()->GetBufferPointer(); } -/* - * Initialize flags - */ template void GPUPDEDeformableRegistrationFilter::Initialize() @@ -276,9 +259,6 @@ GPUPDEDeformableRegistrationFilterGPUAllocateMetricData(numPixels); } -/* - * Smooth deformation using a separable Gaussian kernel - */ template void GPUPDEDeformableRegistrationFilter:: @@ -406,9 +386,6 @@ GPUPDEDeformableRegistrationFilter void GPUPDEDeformableRegistrationFilter:: @@ -419,9 +396,6 @@ GPUPDEDeformableRegistrationFilterm_SmoothFieldTime.Stop(); } -/* - * Smooth deformation using a separable Gaussian kernel - */ template void GPUPDEDeformableRegistrationFilter:: @@ -433,9 +407,6 @@ GPUPDEDeformableRegistrationFilterm_SmoothFieldTime.Stop(); } -/* - * Smooth deformation using a separable Gaussian kernel - */ template void GPUPDEDeformableRegistrationFilter:: diff --git a/Modules/Registration/Metricsv4/include/itkEuclideanDistancePointSetToPointSetMetricv4.hxx b/Modules/Registration/Metricsv4/include/itkEuclideanDistancePointSetToPointSetMetricv4.hxx index 2b464036898..6d3be753d58 100644 --- a/Modules/Registration/Metricsv4/include/itkEuclideanDistancePointSetToPointSetMetricv4.hxx +++ b/Modules/Registration/Metricsv4/include/itkEuclideanDistancePointSetToPointSetMetricv4.hxx @@ -75,7 +75,6 @@ EuclideanDistancePointSetToPointSetMetricv4 void EuclideanDistancePointSetToPointSetMetricv4::PrintSelf( diff --git a/Modules/Registration/Metricsv4/include/itkExpectationBasedPointSetToPointSetMetricv4.hxx b/Modules/Registration/Metricsv4/include/itkExpectationBasedPointSetToPointSetMetricv4.hxx index 98ffd874752..b75da3a36de 100644 --- a/Modules/Registration/Metricsv4/include/itkExpectationBasedPointSetToPointSetMetricv4.hxx +++ b/Modules/Registration/Metricsv4/include/itkExpectationBasedPointSetToPointSetMetricv4.hxx @@ -24,7 +24,6 @@ namespace itk { -/** Constructor */ template ExpectationBasedPointSetToPointSetMetricv4:: ExpectationBasedPointSetToPointSetMetricv4() diff --git a/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h b/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h index 883387eed87..899b4d09bb4 100644 --- a/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h +++ b/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h @@ -118,8 +118,7 @@ class ITK_TEMPLATE_EXPORT JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 using GaussianType = typename DensityFunctionType::GaussianType; using DensityFunctionPointer = typename DensityFunctionType::Pointer; - /** Initialize the Metric by making sure that all the components - * are present and plugged together correctly */ + /** Initialize the Metric by making sure that all the components are present and plugged together correctly. */ void Initialize() override; @@ -208,6 +207,7 @@ class ITK_TEMPLATE_EXPORT JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 MeasureType GetLocalNeighborhoodValue(const PointType & point, const PixelType & pixel = 0) const override; + /** Get the local measure and the derivative values. */ void GetLocalNeighborhoodValueAndDerivative(const PointType &, MeasureType &, diff --git a/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.hxx b/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.hxx index 7d8e59d3a6b..166d4a8b713 100644 --- a/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.hxx +++ b/Modules/Registration/Metricsv4/include/itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.hxx @@ -23,7 +23,6 @@ namespace itk { -/** Constructor */ template JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4:: JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4() @@ -37,7 +36,6 @@ JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 void JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4::Initialize() @@ -76,7 +74,6 @@ JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 void JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4:: diff --git a/Modules/Registration/Metricsv4/include/itkLabeledPointSetToPointSetMetricv4.hxx b/Modules/Registration/Metricsv4/include/itkLabeledPointSetToPointSetMetricv4.hxx index 46d28e3c1f2..b25ff614cea 100644 --- a/Modules/Registration/Metricsv4/include/itkLabeledPointSetToPointSetMetricv4.hxx +++ b/Modules/Registration/Metricsv4/include/itkLabeledPointSetToPointSetMetricv4.hxx @@ -26,7 +26,6 @@ namespace itk { -/** Constructor */ template LabeledPointSetToPointSetMetricv4:: LabeledPointSetToPointSetMetricv4() @@ -236,7 +235,6 @@ LabeledPointSetToPointSetMetricv4 void LabeledPointSetToPointSetMetricv4::PrintSelf( diff --git a/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.h b/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.h index 6e73db69e20..d7c5c230d8a 100644 --- a/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.h +++ b/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.h @@ -138,15 +138,15 @@ class ITK_TEMPLATE_EXPORT ObjectToObjectMultiMetricv4 itkSetMacro(MetricWeights, WeightsArrayType); itkGetMacro(MetricWeights, WeightsArrayType); - /** Add a metric to the queue */ + /** Add a metric to the queue. */ void AddMetric(MetricType * metric); - /** Clear the metric queue */ + /** Clear the metric queue. */ void ClearMetricQueue(); - /** Get the number of metrics */ + /** Get the number of metrics. */ SizeValueType GetNumberOfMetrics() const; diff --git a/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.hxx b/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.hxx index e7539f1fcd9..91e3912b30a 100644 --- a/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.hxx +++ b/Modules/Registration/Metricsv4/include/itkObjectToObjectMultiMetricv4.hxx @@ -23,7 +23,6 @@ namespace itk { -/** Constructor */ template m_MovingTransform = nullptr; } -/** Add a metric to the queue. */ template m_MetricQueue.push_back(metric); } -/** Clear the queue */ template m_MetricQueue.clear(); } -/** Get the number of metrics */ template PointSetToPointSetMetricWithIndexv4:: PointSetToPointSetMetricWithIndexv4() @@ -57,7 +56,6 @@ PointSetToPointSetMetricWithIndexv4m_CalculateValueAndDerivativeInTangentSpace = false; } -/** Initialize the metric */ template void PointSetToPointSetMetricWithIndexv4::Initialize() @@ -651,8 +649,6 @@ const typename PointSetToPointSetMetricWithIndexv4 void PointSetToPointSetMetricWithIndexv4::PrintSelf( diff --git a/Modules/Registration/PDEDeformable/include/itkCurvatureRegistrationFilter.hxx b/Modules/Registration/PDEDeformable/include/itkCurvatureRegistrationFilter.hxx index d4cfe109b9a..53c66f5d246 100644 --- a/Modules/Registration/PDEDeformable/include/itkCurvatureRegistrationFilter.hxx +++ b/Modules/Registration/PDEDeformable/include/itkCurvatureRegistrationFilter.hxx @@ -28,9 +28,7 @@ namespace itk { -/** - * Default constructor - */ + template CurvatureRegistrationFilter:: CurvatureRegistrationFilter() @@ -52,9 +50,6 @@ CurvatureRegistrationFilter CurvatureRegistrationFilter:: ~CurvatureRegistrationFilter() @@ -83,9 +78,6 @@ CurvatureRegistrationFilter void CurvatureRegistrationFilter::Initialize() @@ -190,9 +182,6 @@ CurvatureRegistrationFilter double CurvatureRegistrationFilter::GetMetric() const @@ -207,9 +196,6 @@ CurvatureRegistrationFilterGetMetric(); } -/* - * Get the metric value from the difference function - */ template void CurvatureRegistrationFilter::ApplyUpdate( diff --git a/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFilter.hxx b/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFilter.hxx index cb5aa0500d8..6a57fec47fa 100644 --- a/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFilter.hxx +++ b/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFilter.hxx @@ -20,9 +20,7 @@ namespace itk { -/** - * Default constructor - */ + template DemonsRegistrationFilter::DemonsRegistrationFilter() { @@ -45,9 +43,6 @@ DemonsRegistrationFilter::PrintSe os << indent << "Intensity difference threshold: " << this->GetIntensityDifferenceThreshold() << std::endl; } -/* - * Set the function state values before each iteration - */ template void DemonsRegistrationFilter::InitializeIteration() @@ -72,9 +67,6 @@ DemonsRegistrationFilter::Initial } } -/** - * Get the metric value from the difference function - */ template double DemonsRegistrationFilter::GetMetric() const @@ -89,9 +81,6 @@ DemonsRegistrationFilter::GetMetr return drfp->GetMetric(); } -/** - * - */ template double DemonsRegistrationFilter::GetIntensityDifferenceThreshold() const @@ -106,9 +95,6 @@ DemonsRegistrationFilter::GetInte return drfp->GetIntensityDifferenceThreshold(); } -/** - * - */ template void DemonsRegistrationFilter::SetIntensityDifferenceThreshold( @@ -124,9 +110,6 @@ DemonsRegistrationFilter::SetInte drfp->SetIntensityDifferenceThreshold(threshold); } -/** - * Get the metric value from the difference function - */ template void DemonsRegistrationFilter::ApplyUpdate(const TimeStepType & dt) diff --git a/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFunction.h b/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFunction.h index 603a1db8073..cfd3f52a4ed 100644 --- a/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFunction.h +++ b/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFunction.h @@ -146,7 +146,10 @@ class ITK_TEMPLATE_EXPORT DemonsRegistrationFunction return global; } - /** Release memory for global data structure. */ + /** Release memory for global data structure. + * + * Updates the metric and release the per-thread-global data. + */ void ReleaseGlobalDataPointer(void * gd) const override; @@ -154,8 +157,10 @@ class ITK_TEMPLATE_EXPORT DemonsRegistrationFunction 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 the specified neighbourhood. + * + * Called by a finite difference solver image filter a 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/itkDemonsRegistrationFunction.hxx b/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFunction.hxx index 5e67ef5fcb3..caec232d1df 100644 --- a/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFunction.hxx +++ b/Modules/Registration/PDEDeformable/include/itkDemonsRegistrationFunction.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Default constructor - */ + template DemonsRegistrationFunction::DemonsRegistrationFunction() { @@ -62,9 +60,6 @@ DemonsRegistrationFunction::Demon m_UseMovingImageGradient = false; } -/** - * Standard "PrintSelf" method. - */ template void DemonsRegistrationFunction::PrintSelf(std::ostream & os, @@ -96,9 +91,6 @@ DemonsRegistrationFunction::Print os << m_SumOfSquaredChange << std::endl; } -/** - * - */ template void DemonsRegistrationFunction::SetIntensityDifferenceThreshold( @@ -107,9 +99,6 @@ DemonsRegistrationFunction::SetIn m_IntensityDifferenceThreshold = threshold; } -/** - * - */ template double DemonsRegistrationFunction::GetIntensityDifferenceThreshold() const @@ -117,9 +106,6 @@ DemonsRegistrationFunction::GetIn return m_IntensityDifferenceThreshold; } -/** - * Set the function state values before each iteration - */ template void DemonsRegistrationFunction::InitializeIteration() @@ -154,9 +140,6 @@ DemonsRegistrationFunction::Initi m_SumOfSquaredChange = 0.0; } -/** - * Compute update at a specify neighbourhood - */ template typename DemonsRegistrationFunction::PixelType DemonsRegistrationFunction::ComputeUpdate( @@ -248,9 +231,6 @@ DemonsRegistrationFunction::Compu return update; } -/** - * Update the metric and release the per-thread-global data. - */ template void DemonsRegistrationFunction::ReleaseGlobalDataPointer(void * gd) const diff --git a/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.h b/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.h index 1c1f5b18659..4e3b6b75dda 100644 --- a/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.h +++ b/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.h @@ -179,8 +179,11 @@ class ITK_TEMPLATE_EXPORT DiffeomorphicDemonsRegistrationFilter ApplyUpdate(const TimeStepType & dt) override; private: - /** Downcast the DifferenceFunction using a dynamic_cast to ensure that it is of the correct type. - * this method will throw an exception if the function is not of the expected type. */ + /** Downcast the DifferenceFunction using a dynamic_cast to ensure that it is of the correct type (i.e. + * a DemonsRegistrationFunction). + * + * Throws an exception if the function is not of the expected type. + */ DemonsRegistrationFunctionType * DownCastDifferenceFunctionType(); diff --git a/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.hxx b/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.hxx index fd88b5e636a..aee133e24f9 100644 --- a/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.hxx +++ b/Modules/Registration/PDEDeformable/include/itkDiffeomorphicDemonsRegistrationFilter.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Default constructor - */ + template DiffeomorphicDemonsRegistrationFilter:: DiffeomorphicDemonsRegistrationFilter() @@ -48,10 +46,6 @@ DiffeomorphicDemonsRegistrationFilterInPlaceOn(); } -/** - * Checks whether the DifferenceFunction is of type DemonsRegistrationFunction. - * It throws and exception, if it is not. - */ template typename DiffeomorphicDemonsRegistrationFilter:: DemonsRegistrationFunctionType * @@ -67,10 +61,6 @@ typename DiffeomorphicDemonsRegistrationFilter const typename DiffeomorphicDemonsRegistrationFilter:: DemonsRegistrationFunctionType * @@ -87,9 +77,6 @@ const typename DiffeomorphicDemonsRegistrationFilter void DiffeomorphicDemonsRegistrationFilter::InitializeIteration() @@ -103,9 +90,6 @@ DiffeomorphicDemonsRegistrationFilter double DiffeomorphicDemonsRegistrationFilter::GetMetric() const @@ -115,9 +99,6 @@ DiffeomorphicDemonsRegistrationFilterGetMetric(); } -/** - * Get Intensity Difference Threshold - */ template double DiffeomorphicDemonsRegistrationFilter::GetIntensityDifferenceThreshold() @@ -128,9 +109,6 @@ DiffeomorphicDemonsRegistrationFilterGetIntensityDifferenceThreshold(); } -/** - * Set Intensity Difference Threshold - */ template void DiffeomorphicDemonsRegistrationFilter::SetIntensityDifferenceThreshold( @@ -141,9 +119,6 @@ DiffeomorphicDemonsRegistrationFilterSetIntensityDifferenceThreshold(threshold); } -/** - * Get Maximum Update Step Length - */ template double DiffeomorphicDemonsRegistrationFilter::GetMaximumUpdateStepLength() const @@ -153,9 +128,6 @@ DiffeomorphicDemonsRegistrationFilterGetMaximumUpdateStepLength(); } -/** - * Set Maximum Update Step Length - */ template void DiffeomorphicDemonsRegistrationFilter::SetMaximumUpdateStepLength( @@ -166,9 +138,6 @@ DiffeomorphicDemonsRegistrationFilterSetMaximumUpdateStepLength(threshold); } -/** - * Get the metric value from the difference function - */ template const double & DiffeomorphicDemonsRegistrationFilter::GetRMSChange() const @@ -178,9 +147,6 @@ DiffeomorphicDemonsRegistrationFilterGetRMSChange(); } -/** - * - */ template auto DiffeomorphicDemonsRegistrationFilter::GetUseGradientType() const @@ -191,9 +157,6 @@ DiffeomorphicDemonsRegistrationFilterGetUseGradientType(); } -/** - * - */ template void DiffeomorphicDemonsRegistrationFilter::SetUseGradientType( @@ -204,9 +167,6 @@ DiffeomorphicDemonsRegistrationFilterSetUseGradientType(gtype); } -/** - * - */ template void DiffeomorphicDemonsRegistrationFilter::AllocateUpdateBuffer() @@ -224,9 +184,6 @@ DiffeomorphicDemonsRegistrationFilterAllocate(); } -/** - * Get the metric value from the difference function - */ template void DiffeomorphicDemonsRegistrationFilter::ApplyUpdate( diff --git a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.h b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.h index 8863b0dc0cd..674e53703a3 100644 --- a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.h +++ b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.h @@ -137,6 +137,7 @@ class ITK_TEMPLATE_EXPORT FastSymmetricForcesDemonsRegistrationFilter virtual double GetIntensityDifferenceThreshold() const; + /** Set/Get the maximum update step length. */ virtual void SetMaximumUpdateStepLength(double); @@ -178,8 +179,11 @@ class ITK_TEMPLATE_EXPORT FastSymmetricForcesDemonsRegistrationFilter using AdderPointer = typename AdderType::Pointer; private: - /** Downcast the DifferenceFunction using a dynamic_cast to ensure that it is of the correct type. - * this method will throw an exception if the function is not of the expected type. */ + /** Downcast the DifferenceFunction using a dynamic_cast to ensure that it is of the correct type (i.e. + * a DemonsRegistrationFunction). + * + * Throws an exception if the function is not of the expected type. + */ DemonsRegistrationFunctionType * DownCastDifferenceFunctionType(); diff --git a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.hxx b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.hxx index 7f8b846a894..66bf3f4465e 100644 --- a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.hxx +++ b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFilter.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Default constructor - */ + template FastSymmetricForcesDemonsRegistrationFilter:: FastSymmetricForcesDemonsRegistrationFilter() @@ -40,9 +38,6 @@ FastSymmetricForcesDemonsRegistrationFilterInPlaceOn(); } -/* - * Set the function state values before each iteration - */ template void FastSymmetricForcesDemonsRegistrationFilter::InitializeIteration() @@ -56,9 +51,6 @@ FastSymmetricForcesDemonsRegistrationFilter double FastSymmetricForcesDemonsRegistrationFilter::GetMetric() const @@ -68,9 +60,6 @@ FastSymmetricForcesDemonsRegistrationFilterGetMetric(); } -/** - * Return intensity difference threshold - */ template double FastSymmetricForcesDemonsRegistrationFilter:: @@ -81,9 +70,6 @@ FastSymmetricForcesDemonsRegistrationFilterGetIntensityDifferenceThreshold(); } -/** - * Sets the intensity difference threshold - */ template void FastSymmetricForcesDemonsRegistrationFilter:: @@ -94,9 +80,6 @@ FastSymmetricForcesDemonsRegistrationFilterSetIntensityDifferenceThreshold(threshold); } -/** - * Get the maximum update step length - */ template double FastSymmetricForcesDemonsRegistrationFilter::GetMaximumUpdateStepLength() @@ -107,9 +90,6 @@ FastSymmetricForcesDemonsRegistrationFilterGetMaximumUpdateStepLength(); } -/** - * Set the maximum update step length - */ template void FastSymmetricForcesDemonsRegistrationFilter::SetMaximumUpdateStepLength( @@ -120,9 +100,6 @@ FastSymmetricForcesDemonsRegistrationFilterSetMaximumUpdateStepLength(threshold); } -/** - * Get the metric value from the difference function - */ template const double & FastSymmetricForcesDemonsRegistrationFilter::GetRMSChange() const @@ -132,9 +109,6 @@ FastSymmetricForcesDemonsRegistrationFilterGetRMSChange(); } -/** - * - */ template auto FastSymmetricForcesDemonsRegistrationFilter::GetUseGradientType() const @@ -145,9 +119,6 @@ FastSymmetricForcesDemonsRegistrationFilterGetUseGradientType(); } -/** - * - */ template void FastSymmetricForcesDemonsRegistrationFilter::SetUseGradientType( @@ -158,10 +129,6 @@ FastSymmetricForcesDemonsRegistrationFilterSetUseGradientType(gtype); } -/** - * Checks whether the DifferenceFunction is of type DemonsRegistrationFunction. - * It throws and exception, if it is not. - */ template typename FastSymmetricForcesDemonsRegistrationFilter:: DemonsRegistrationFunctionType * @@ -178,10 +145,6 @@ typename FastSymmetricForcesDemonsRegistrationFilter const typename FastSymmetricForcesDemonsRegistrationFilter:: DemonsRegistrationFunctionType * @@ -215,9 +178,6 @@ FastSymmetricForcesDemonsRegistrationFilterAllocate(); } -/** - * Get the metric value from the difference function - */ template void FastSymmetricForcesDemonsRegistrationFilter::ApplyUpdate( diff --git a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.h b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.h index ea294afea84..ec4c91bad26 100644 --- a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.h +++ b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.h @@ -143,7 +143,10 @@ class ITK_TEMPLATE_EXPORT FastSymmetricForcesDemonsRegistrationFunction return global; } - /** Release memory for global data structure. */ + /** Release memory for global data structure. + * + * Updates the metric and releases the per-thread-global data. + */ void ReleaseGlobalDataPointer(void * GlobalData) const override; @@ -151,8 +154,10 @@ class ITK_TEMPLATE_EXPORT FastSymmetricForcesDemonsRegistrationFunction 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 & neighborhood, void * globalData, diff --git a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.hxx b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.hxx index d7b21afe3bb..5d63651a528 100644 --- a/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.hxx +++ b/Modules/Registration/PDEDeformable/include/itkFastSymmetricForcesDemonsRegistrationFunction.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Default constructor - */ + template FastSymmetricForcesDemonsRegistrationFunction:: FastSymmetricForcesDemonsRegistrationFunction() @@ -62,9 +60,6 @@ FastSymmetricForcesDemonsRegistrationFunction void FastSymmetricForcesDemonsRegistrationFunction::PrintSelf( @@ -94,9 +89,6 @@ FastSymmetricForcesDemonsRegistrationFunction void FastSymmetricForcesDemonsRegistrationFunction:: @@ -105,9 +97,6 @@ FastSymmetricForcesDemonsRegistrationFunction double FastSymmetricForcesDemonsRegistrationFunction:: @@ -116,9 +105,6 @@ FastSymmetricForcesDemonsRegistrationFunction void FastSymmetricForcesDemonsRegistrationFunction::InitializeIteration() @@ -159,9 +145,6 @@ FastSymmetricForcesDemonsRegistrationFunction typename FastSymmetricForcesDemonsRegistrationFunction::PixelType FastSymmetricForcesDemonsRegistrationFunction::ComputeUpdate( @@ -273,9 +256,6 @@ FastSymmetricForcesDemonsRegistrationFunction void FastSymmetricForcesDemonsRegistrationFunction::ReleaseGlobalDataPointer( diff --git a/Modules/Registration/PDEDeformable/include/itkLevelSetMotionRegistrationFunction.h b/Modules/Registration/PDEDeformable/include/itkLevelSetMotionRegistrationFunction.h index 60b874a09da..e18f140f2d5 100644 --- a/Modules/Registration/PDEDeformable/include/itkLevelSetMotionRegistrationFunction.h +++ b/Modules/Registration/PDEDeformable/include/itkLevelSetMotionRegistrationFunction.h @@ -126,8 +126,10 @@ class ITK_TEMPLATE_EXPORT LevelSetMotionRegistrationFunction return m_MovingImageInterpolator; } - /** Compute the time step that can taken for this iterations. In - * this context, the timestep is a function of the maximum gradients. */ + /** Compute the time global step that for this iteration. + * + * In this context, the timestep is a function of the maximum gradients. + */ TimeStepType ComputeGlobalTimeStep(void * GlobalData) const override; @@ -145,7 +147,10 @@ class ITK_TEMPLATE_EXPORT LevelSetMotionRegistrationFunction return global; } - /** Release memory for global data structure. */ + /** Release memory for global data structure. + * + * Updates the metric and releases the per-thread-global data. + */ void ReleaseGlobalDataPointer(void * gd) const override; @@ -153,8 +158,10 @@ class ITK_TEMPLATE_EXPORT LevelSetMotionRegistrationFunction 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 the specified 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/itkLevelSetMotionRegistrationFunction.hxx b/Modules/Registration/PDEDeformable/include/itkLevelSetMotionRegistrationFunction.hxx index 93bb6246f13..f5ed6d5ef7d 100644 --- a/Modules/Registration/PDEDeformable/include/itkLevelSetMotionRegistrationFunction.hxx +++ b/Modules/Registration/PDEDeformable/include/itkLevelSetMotionRegistrationFunction.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Default constructor - */ + template LevelSetMotionRegistrationFunction::LevelSetMotionRegistrationFunction() { @@ -63,9 +61,6 @@ LevelSetMotionRegistrationFunction(DefaultInterpolatorType::New().GetPointer()); } -/* - * Standard "PrintSelf" method. - */ template void LevelSetMotionRegistrationFunction::PrintSelf(std::ostream & os, @@ -94,9 +89,6 @@ LevelSetMotionRegistrationFunction void LevelSetMotionRegistrationFunction::SetAlpha(double alpha) @@ -104,9 +96,6 @@ LevelSetMotionRegistrationFunction double LevelSetMotionRegistrationFunction::GetAlpha() const @@ -114,9 +103,6 @@ LevelSetMotionRegistrationFunction void LevelSetMotionRegistrationFunction::SetIntensityDifferenceThreshold( @@ -125,9 +111,6 @@ LevelSetMotionRegistrationFunction double LevelSetMotionRegistrationFunction::GetIntensityDifferenceThreshold() @@ -136,9 +119,6 @@ LevelSetMotionRegistrationFunction void LevelSetMotionRegistrationFunction::SetGradientMagnitudeThreshold( @@ -147,9 +127,6 @@ LevelSetMotionRegistrationFunction double LevelSetMotionRegistrationFunction::GetGradientMagnitudeThreshold() const @@ -157,9 +134,6 @@ LevelSetMotionRegistrationFunction void LevelSetMotionRegistrationFunction:: @@ -168,9 +142,6 @@ LevelSetMotionRegistrationFunction double LevelSetMotionRegistrationFunction:: @@ -179,10 +150,6 @@ LevelSetMotionRegistrationFunction bool LevelSetMotionRegistrationFunction::GetUseImageSpacing() const @@ -190,10 +157,6 @@ LevelSetMotionRegistrationFunctionm_UseImageSpacing; } -/** - * Set the flag that defines whether the image spacing should be taken into - * account in computations. - */ template void LevelSetMotionRegistrationFunction::SetUseImageSpacing( @@ -202,9 +165,6 @@ LevelSetMotionRegistrationFunctionm_UseImageSpacing = useImageSpacing; } -/** - * Set the function state values before each iteration - */ template void LevelSetMotionRegistrationFunction::InitializeIteration() @@ -233,9 +193,6 @@ LevelSetMotionRegistrationFunction typename LevelSetMotionRegistrationFunction::PixelType LevelSetMotionRegistrationFunction::ComputeUpdate( @@ -391,9 +348,6 @@ LevelSetMotionRegistrationFunction typename LevelSetMotionRegistrationFunction::TimeStepType LevelSetMotionRegistrationFunction::ComputeGlobalTimeStep( @@ -416,9 +370,6 @@ LevelSetMotionRegistrationFunction void LevelSetMotionRegistrationFunction::ReleaseGlobalDataPointer( diff --git a/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.h b/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.h index a873cd9b4f0..21374c11c81 100644 --- a/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.h +++ b/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.h @@ -237,8 +237,17 @@ class ITK_TEMPLATE_EXPORT MultiResolutionPDEDeformableRegistration void PrintSelf(std::ostream & os, Indent indent) const override; - /** Generate output data by performing the registration - * at each resolution level. */ + /** Generate output data by performing the registration at each resolution level. + * + * Performs a the deformable registration using a multiresolution scheme using an internal mini-pipeline + * + * ref_pyramid -> registrator -> field_expander --|| tempField + * test_pyramid -> | | + * | | + * -------------------------------- + * + * A tempField image is used to break the cycle between the registrator and field_expander. + */ void GenerateData() override; diff --git a/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.hxx b/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.hxx index a8942a64e54..884988131b4 100644 --- a/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.hxx +++ b/Modules/Registration/PDEDeformable/include/itkMultiResolutionPDEDeformableRegistration.hxx @@ -25,9 +25,7 @@ namespace itk { -/** - * Default constructor - */ + template ProcessObject::SetNthInput(2, const_cast(ptr)); } -/* - * Get the moving image image. - */ template (this->ProcessObject::GetInput(2)); } -/* - * Set the fixed image. - */ template ProcessObject::SetNthInput(1, const_cast(ptr)); } -/* - * Get the fixed image. - */ template (this->ProcessObject::GetInput(1)); } -/* - * - */ template registrator -> field_expander --|| tempField - * test_pyramid -> | | - * | | - * -------------------------------- - * - * A tempField image is used to break the cycle between the - * registrator and field_expander. - * - */ template Superclass::Halt(); } - /** A simple method to copy the data from the input to the output. - * If the input does not exist, a zero field is written to the output. */ + /** Copy the data from the input to the output. + * + * When the input is not set, the output is filled with zero values. */ void CopyInputToOutput() override; @@ -236,23 +237,28 @@ class ITK_TEMPLATE_EXPORT PDEDeformableRegistrationFilter InitializeIteration() override; /** Utility to smooth the displacement field (represented in the Output) - * using a Gaussian operator. The amount of smoothing can be specified + * using a separable Gaussian kernel. The amount of smoothing can be specified * by setting the StandardDeviations. */ virtual void SmoothDisplacementField(); - /** Utility to smooth the UpdateBuffer using a Gaussian operator. + /** Utility to smooth the UpdateBuffer using a separable Gaussian kernel. * The amount of smoothing can be specified by setting the * UpdateFieldStandardDeviations. */ virtual void SmoothUpdateField(); - /** This method is called after the solution has been generated. In this case, - * the filter release the memory of the internal buffers. */ + /** Release the memory of the internal buffers. + * + * Called after the solution has been generated. + */ void PostProcessOutput() override; - /** This method is called before iterating the solution. */ + /** Initialize flags. + * + * Called before iterating the solution. + */ void Initialize() override; diff --git a/Modules/Registration/PDEDeformable/include/itkPDEDeformableRegistrationFilter.hxx b/Modules/Registration/PDEDeformable/include/itkPDEDeformableRegistrationFilter.hxx index 977932b203d..3f99e4e47fb 100644 --- a/Modules/Registration/PDEDeformable/include/itkPDEDeformableRegistrationFilter.hxx +++ b/Modules/Registration/PDEDeformable/include/itkPDEDeformableRegistrationFilter.hxx @@ -30,9 +30,7 @@ namespace itk { -/** - * Default constructor - */ + template PDEDeformableRegistrationFilter::PDEDeformableRegistrationFilter() { @@ -65,9 +63,6 @@ PDEDeformableRegistrationFilter:: m_SmoothUpdateField = false; } -/* - * - */ template std::vector>::size_type PDEDeformableRegistrationFilter::GetNumberOfValidRequiredInputs() const @@ -87,9 +82,6 @@ PDEDeformableRegistrationFilter:: return num; } -/** - * Set the standard deviations. - */ template void PDEDeformableRegistrationFilter::SetStandardDeviations(double value) @@ -140,9 +132,6 @@ PDEDeformableRegistrationFilter:: } } -/* - * Standard PrintSelf method. - */ template void PDEDeformableRegistrationFilter::PrintSelf(std::ostream & os, @@ -173,9 +162,6 @@ PDEDeformableRegistrationFilter:: os << m_MaximumKernelWidth << std::endl; } -/* - * Set the function state values before each iteration - */ template void PDEDeformableRegistrationFilter::InitializeIteration() @@ -202,12 +188,6 @@ PDEDeformableRegistrationFilter:: this->Superclass::InitializeIteration(); } -/* - * Override the default implementation for the case when the - * initial deformation is not set. - * If the initial deformation is not set, the output is - * fill with zero vectors. - */ template void PDEDeformableRegistrationFilter::CopyInputToOutput() @@ -296,9 +276,6 @@ PDEDeformableRegistrationFilter:: } } -/* - * Release memory of internal buffers - */ template void PDEDeformableRegistrationFilter::PostProcessOutput() @@ -307,9 +284,6 @@ PDEDeformableRegistrationFilter:: m_TempField->Initialize(); } -/* - * Initialize flags - */ template void PDEDeformableRegistrationFilter::Initialize() @@ -318,9 +292,6 @@ PDEDeformableRegistrationFilter:: m_StopRegistrationFlag = false; } -/* - * Smooth deformation using a separable Gaussian kernel - */ template void PDEDeformableRegistrationFilter::SmoothDisplacementField() @@ -382,9 +353,6 @@ PDEDeformableRegistrationFilter:: delete oper; } -/* - * Smooth deformation using a separable Gaussian kernel - */ template void PDEDeformableRegistrationFilter::SmoothUpdateField() diff --git a/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFilter.hxx b/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFilter.hxx index f87f6083508..99b937ff1ad 100644 --- a/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFilter.hxx +++ b/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFilter.hxx @@ -20,9 +20,7 @@ namespace itk { -/** - * Default constructor - */ + template SymmetricForcesDemonsRegistrationFilter:: SymmetricForcesDemonsRegistrationFilter() @@ -33,9 +31,6 @@ SymmetricForcesDemonsRegistrationFilterSetDifferenceFunction(static_cast(drfp.GetPointer())); } -/* - * Set the function state values before each iteration - */ template void SymmetricForcesDemonsRegistrationFilter::InitializeIteration() @@ -60,9 +55,6 @@ SymmetricForcesDemonsRegistrationFilter double SymmetricForcesDemonsRegistrationFilter::GetMetric() const @@ -77,9 +69,6 @@ SymmetricForcesDemonsRegistrationFilterGetMetric(); } -/* - * - */ template double SymmetricForcesDemonsRegistrationFilter:: @@ -95,9 +84,6 @@ SymmetricForcesDemonsRegistrationFilterGetIntensityDifferenceThreshold(); } -/* - * - */ template void SymmetricForcesDemonsRegistrationFilter::SetIntensityDifferenceThreshold( @@ -113,9 +99,6 @@ SymmetricForcesDemonsRegistrationFilterSetIntensityDifferenceThreshold(threshold); } -/* - * Get the metric value from the difference function - */ template const double & SymmetricForcesDemonsRegistrationFilter::GetRMSChange() const @@ -130,9 +113,6 @@ SymmetricForcesDemonsRegistrationFilterGetRMSChange(); } -/* - * Get the metric value from the difference function - */ template void SymmetricForcesDemonsRegistrationFilter::ApplyUpdate( diff --git a/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFunction.h b/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFunction.h index 9b93cbdccc9..6ac8977f1bb 100644 --- a/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFunction.h +++ b/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFunction.h @@ -150,7 +150,10 @@ class ITK_TEMPLATE_EXPORT SymmetricForcesDemonsRegistrationFunction return global; } - /** Release memory for global data structure. */ + /** Release memory for global data structure. + * + * Updates the metric and releases the per-thread-global data. + */ void ReleaseGlobalDataPointer(void * gd) const override; @@ -158,8 +161,10 @@ class ITK_TEMPLATE_EXPORT SymmetricForcesDemonsRegistrationFunction 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/itkSymmetricForcesDemonsRegistrationFunction.hxx b/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFunction.hxx index af49971d897..493fe87bbcd 100644 --- a/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFunction.hxx +++ b/Modules/Registration/PDEDeformable/include/itkSymmetricForcesDemonsRegistrationFunction.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Default constructor - */ + template SymmetricForcesDemonsRegistrationFunction:: SymmetricForcesDemonsRegistrationFunction() @@ -55,9 +53,6 @@ SymmetricForcesDemonsRegistrationFunction void SymmetricForcesDemonsRegistrationFunction::PrintSelf(std::ostream & os, @@ -86,9 +81,6 @@ SymmetricForcesDemonsRegistrationFunction void SymmetricForcesDemonsRegistrationFunction:: @@ -97,9 +89,6 @@ SymmetricForcesDemonsRegistrationFunction double SymmetricForcesDemonsRegistrationFunction:: @@ -108,9 +97,6 @@ SymmetricForcesDemonsRegistrationFunction void SymmetricForcesDemonsRegistrationFunction::InitializeIteration() @@ -143,9 +129,6 @@ SymmetricForcesDemonsRegistrationFunction typename SymmetricForcesDemonsRegistrationFunction::PixelType SymmetricForcesDemonsRegistrationFunction::ComputeUpdate( @@ -295,9 +278,6 @@ SymmetricForcesDemonsRegistrationFunction void SymmetricForcesDemonsRegistrationFunction::ReleaseGlobalDataPointer( diff --git a/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.h b/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.h index ec44510d45f..3c66ed827e7 100644 --- a/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.h +++ b/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.h @@ -313,7 +313,7 @@ class ITK_TEMPLATE_EXPORT ImageRegistrationMethodv4 : public ProcessObject * By initializing the random number generator seed to a value the * same deterministic sampling will be used each Update * execution. On the other hand, calling the method - * ReinitializeSeed() without arguments will use the wall clock in + * MetricSamplingReinitializeSeed() without arguments will use the wall clock in * order to have psuedo-random initialization of the seeds. This * will indeed increase the non-deterministic behavior of the * metric. @@ -438,7 +438,7 @@ class ITK_TEMPLATE_EXPORT ImageRegistrationMethodv4 : public ProcessObject using Superclass::MakeOutput; DataObjectPointer MakeOutput(DataObjectPointerArraySizeType) override; - /** Returns the transform resulting from the registration process */ + /** Return the transform resulting from the registration process. */ virtual DecoratedOutputTransformType * GetOutput(); virtual const DecoratedOutputTransformType * @@ -527,7 +527,7 @@ class ITK_TEMPLATE_EXPORT ImageRegistrationMethodv4 : public ProcessObject virtual VirtualImageBaseConstPointer GetCurrentLevelVirtualDomainImage(); - /** Get metric samples. */ + /** Set the metric sample points. */ virtual void SetMetricSamplePoints(); diff --git a/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.hxx b/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.hxx index 353e6d5b243..2c0ef53f2e6 100644 --- a/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.hxx +++ b/Modules/Registration/RegistrationMethodsv4/include/itkImageRegistrationMethodv4.hxx @@ -31,9 +31,7 @@ namespace itk { -/** - * Constructor - */ + template ImageRegistrationMethodv4::ImageRegistrationMethodv4() { @@ -244,9 +242,6 @@ const typename ImageRegistrationMethodv4(this->ProcessObject::GetInput(2 * index + 1)); } -/* - * Set optimizer weights and do checking for identity. - */ template void ImageRegistrationMethodv4::SetOptimizerWeights( @@ -282,9 +277,6 @@ ImageRegistrationMethodv4 void ImageRegistrationMethodv4:: @@ -816,9 +808,6 @@ ImageRegistrationMethodv4m_OutputTransform = this->GetModifiableTransform(); } -/* - * Start the registration - */ template void ImageRegistrationMethodv4::GenerateData() @@ -838,9 +827,6 @@ ImageRegistrationMethodv4 void ImageRegistrationMethodv4:: @@ -858,9 +844,6 @@ ImageRegistrationMethodv4 const typename ImageRegistrationMethodv4:: TransformParametersAdaptorsContainerType & @@ -870,9 +853,6 @@ const typename ImageRegistrationMethodv4m_TransformParametersAdaptorsPerLevel; } -/** - * Set the number of levels - */ template void ImageRegistrationMethodv4::SetNumberOfLevels( @@ -909,9 +889,6 @@ ImageRegistrationMethodv4 void ImageRegistrationMethodv4::SetMetricSamplePoints() @@ -1157,9 +1134,6 @@ typename ImageRegistrationMethodv4 void ImageRegistrationMethodv4::PrintSelf( @@ -1211,9 +1185,6 @@ ImageRegistrationMethodv4 typename ImageRegistrationMethodv4:: DecoratedOutputTransformType * diff --git a/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.h b/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.h index ff0d0666b59..e1866118874 100644 --- a/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.h +++ b/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.h @@ -215,7 +215,10 @@ class ITK_TEMPLATE_EXPORT TimeVaryingBSplineVelocityFieldImageRegistrationMethod void GenerateData() override; - /** Handle optimization internally */ + /** Start the optimization at each level. + * + * Performs a basic gradient descent operation. + */ virtual void StartOptimization(); diff --git a/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.hxx b/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.hxx index 3920ff527ff..93ef1f8fcbf 100644 --- a/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.hxx +++ b/Modules/Registration/RegistrationMethodsv4/include/itkTimeVaryingBSplineVelocityFieldImageRegistrationMethod.hxx @@ -34,9 +34,7 @@ namespace itk { -/** - * Constructor - */ + template TimeVaryingBSplineVelocityFieldImageRegistrationMethod< TFixedImage, @@ -54,9 +52,6 @@ TimeVaryingBSplineVelocityFieldImageRegistrationMethod< this->m_NumberOfIterationsPerLevel[2] = 40; } -/* - * Start the optimization at each level. We just do a basic gradient descent operation. - */ template void TimeVaryingBSplineVelocityFieldImageRegistrationMethod void TimeVaryingBSplineVelocityFieldImageRegistrationMethodGetTransformOutput()->Set(this->m_OutputTransform); } -/* - * PrintSelf - */ template void TimeVaryingBSplineVelocityFieldImageRegistrationMethodm_NumberOfIterationsPerLevel[2] = 40; } -/* - * Start the optimization at each level. We just do a basic gradient descent operation. - */ template GetTransformOutput()->Set(this->m_OutputTransform); } -/* - * PrintSelf - */ template void ImageClassifierBase::PrintSelf(std::ostream & os, Indent indent) const @@ -34,21 +32,15 @@ ImageClassifierBase::PrintSelf(std::ostream & os, os << m_ClassifiedImage.GetPointer() << std::endl; os << indent << "InputImage: "; os << m_InputImage.GetPointer() << std::endl; -} // end PrintSelf +} -/** - * Generate data (start the classification process) - */ template void ImageClassifierBase::GenerateData() { this->Classify(); -} // end Generate data +} -//------------------------------------------------------------------ -// The core function where classification is carried out -//------------------------------------------------------------------ template void ImageClassifierBase::Classify() @@ -114,11 +106,8 @@ ImageClassifierBase::Classify() outputClassifiedLabel = ClassifiedImagePixelType(classLabel); classifiedIt.Set(outputClassifiedLabel); } -} // end Classify +} -/** - * Allocate - */ template void ImageClassifierBase::Allocate() diff --git a/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.h b/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.h index 2ad44867a78..4e316671453 100644 --- a/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.h +++ b/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.h @@ -125,7 +125,10 @@ class ITK_TEMPLATE_EXPORT ImageModelEstimatorBase : public LightProcessObject m_MembershipFunctions.resize(0); } - /** Stores a MembershipCalculator of a class in its internal vector */ + /** Add a membership function corresponding to the class index. + * + * Stores a MembershipCalculator of a class in its internal vector. + */ unsigned int AddMembershipFunction(MembershipFunctionPointer function); diff --git a/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.hxx b/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.hxx index 5a506601ac7..734e3f98ca8 100644 --- a/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.hxx +++ b/Modules/Segmentation/Classifiers/include/itkImageModelEstimatorBase.hxx @@ -41,9 +41,6 @@ ImageModelEstimatorBase::GenerateData() this->EstimateModels(); } -/** - * PrintSelf - */ template void ImageModelEstimatorBase::PrintSelf(std::ostream & os, Indent indent) const @@ -67,11 +64,7 @@ ImageModelEstimatorBase::PrintSelf(std::ostrea os << indent << "InputImage: "; os << m_InputImage.GetPointer() << std::endl; -} // end PrintSelf - -//------------------------------------------------------------------ -// Add a membership function corresponding to the class index -//------------------------------------------------------------------ +} template unsigned int diff --git a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.h b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.h index 91be8d2baa0..78bc854f80b 100644 --- a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.h +++ b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.h @@ -87,6 +87,7 @@ class ITK_TEMPLATE_EXPORT DeformableSimplexMesh3DBalloonForceFilter using GradientIntensityImageType = Image; using GradientIntensityImagePointer = typename GradientIntensityImageType::Pointer; + /** Set/Get the scalar for balloon force. */ itkSetMacro(Kappa, double); itkGetConstMacro(Kappa, double); @@ -102,17 +103,13 @@ class ITK_TEMPLATE_EXPORT DeformableSimplexMesh3DBalloonForceFilter void PrintSelf(std::ostream & os, Indent indent) const override; - /** - * Compute the external force component + /** Compute the external force component. + * + * Computes the model Displacement according to image gradient forces. */ void ComputeExternalForce(SimplexMeshGeometry * data, const GradientImageType * gradientImage) override; - /** Parameters definitions. */ - - /** - * scalar for balloon force - */ double m_Kappa{}; }; // end of class } // end namespace itk diff --git a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.hxx b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.hxx index d31ec075f3c..afec2e01fd8 100644 --- a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.hxx +++ b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DBalloonForceFilter.hxx @@ -34,7 +34,7 @@ namespace itk { -/* Constructor. */ + template DeformableSimplexMesh3DBalloonForceFilter::DeformableSimplexMesh3DBalloonForceFilter() @@ -42,16 +42,14 @@ DeformableSimplexMesh3DBalloonForceFilter::DeformableSi m_Kappa = 0.1; } -/* PrintSelf. */ template void DeformableSimplexMesh3DBalloonForceFilter::PrintSelf(std::ostream & os, Indent indent) const { Superclass::PrintSelf(os, indent); os << indent << "Kappa = " << m_Kappa << std::endl; -} /* End PrintSelf. */ +} -/** Compute model Displacement according to image gradient forces */ template void DeformableSimplexMesh3DBalloonForceFilter::ComputeExternalForce( diff --git a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DFilter.hxx b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DFilter.hxx index c7837a56f7d..5697b4c1aa5 100644 --- a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DFilter.hxx +++ b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DFilter.hxx @@ -220,7 +220,6 @@ DeformableSimplexMesh3DFilter::SetGradient(const Gradie this->SetNthInput(1, const_cast(gradientImage)); } -/* Get the gradient image as an input */ template auto DeformableSimplexMesh3DFilter::GetGradient() const -> const GradientImageType * diff --git a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DGradientConstraintForceFilter.hxx b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DGradientConstraintForceFilter.hxx index 5e83feb7b62..5f62d4b1d8c 100644 --- a/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DGradientConstraintForceFilter.hxx +++ b/Modules/Segmentation/DeformableMesh/include/itkDeformableSimplexMesh3DGradientConstraintForceFilter.hxx @@ -25,7 +25,7 @@ namespace itk { -/* Constructore */ + template DeformableSimplexMesh3DGradientConstraintForceFilter:: DeformableSimplexMesh3DGradientConstraintForceFilter() diff --git a/Modules/Segmentation/KLMRegionGrowing/include/itkKLMRegionGrowImageFilter.hxx b/Modules/Segmentation/KLMRegionGrowing/include/itkKLMRegionGrowImageFilter.hxx index 951fd1200f0..717727d0063 100644 --- a/Modules/Segmentation/KLMRegionGrowing/include/itkKLMRegionGrowImageFilter.hxx +++ b/Modules/Segmentation/KLMRegionGrowing/include/itkKLMRegionGrowImageFilter.hxx @@ -29,9 +29,6 @@ KLMRegionGrowImageFilter::KLMRegionGrowImageFilter() this->SetMaximumNumberOfRegions(2); } -/** - * PrintSelf - */ template void KLMRegionGrowImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -44,11 +41,8 @@ KLMRegionGrowImageFilter::PrintSelf(std::ostream & os os << indent << "Current internal value of lambda parameter: " << m_InternalLambda << std::endl; os << indent << "Initial number of regions: " << m_InitialNumberOfRegions << std::endl; os << indent << "Current number of regions: " << m_NumberOfRegions << std::endl; -} // end PrintSelf +} -/* - * GenerateInputRequestedRegion method. - */ template void KLMRegionGrowImageFilter::GenerateInputRequestedRegion() @@ -62,9 +56,6 @@ KLMRegionGrowImageFilter::GenerateInputRequestedRegio } } -/** - * EnlargeOutputRequestedRegion method. - */ template void KLMRegionGrowImageFilter::EnlargeOutputRequestedRegion(DataObject * output) @@ -91,7 +82,7 @@ KLMRegionGrowImageFilter::GenerateData() outputPtr->Allocate(); GenerateOutputImage(); -} // end GenerateData +} template void @@ -164,7 +155,7 @@ KLMRegionGrowImageFilter::GenerateOutputImage() tmpIndex[idim] = 0; } } -} // end GenerateOutputImage() +} template auto @@ -183,7 +174,7 @@ KLMRegionGrowImageFilter::GetLabelledImage() -> Label labelImagePtr = GenerateLabelledImage(labelImagePtr); return labelImagePtr; -} // end GetLabelledImage() +} template auto @@ -244,14 +235,14 @@ KLMRegionGrowImageFilter::GenerateLabelledImage(Label // Return the reference to the labelled image return labelImagePtr; -} // end GenerateLabelledImage() +} template void KLMRegionGrowImageFilter::ApplyRegionGrowImageFilter() { this->ApplyKLM(); -} // end ApplyRegionGrowImageFilter() +} template void @@ -272,7 +263,7 @@ KLMRegionGrowImageFilter::ApplyKLM() } this->ResolveRegions(); -} // end ApplyKLM() +} template void @@ -549,7 +540,7 @@ KLMRegionGrowImageFilter::InitializeKLM() { itkExceptionMacro(<< "KLM initialization is incorrect"); } -} // end InitializeKLM() +} template void @@ -590,7 +581,7 @@ KLMRegionGrowImageFilter::InitializeRegionParameters( m_InitialRegionArea *= gridSize[idim] * spacing[idim]; } m_InitialRegionMean /= m_InitialRegionArea; -} // end InitializeRegionParameters +} template void @@ -691,7 +682,7 @@ KLMRegionGrowImageFilter::MergeRegions() m_BorderCandidate = &(m_BordersDynamicPointer.back()); m_InternalLambda = m_BorderCandidate->m_Pointer->GetLambda(); } -} // end MergeRegions +} template void @@ -777,7 +768,7 @@ KLMRegionGrowImageFilter::ResolveRegions() m_RegionsPointer[iregion]->SetRegionParameters(newMeanValue, newAreaValue, newLabelValue); } -} // end ResolveRegions() +} template void @@ -793,7 +784,7 @@ KLMRegionGrowImageFilter::PrintAlgorithmRegionStats() m_RegionsPointer[k]->PrintRegionInfo(); } } -} // end PrintAlgorithmRegionStats +} template void @@ -805,7 +796,7 @@ KLMRegionGrowImageFilter::PrintAlgorithmBorderStats() std::cout << "Stats for Border No: " << (k + 1) << std::endl; m_BordersDynamicPointer[k].m_Pointer->PrintBorderInfo(); } -} // end PrintAlgorithmBorderStats +} } // namespace itk #endif diff --git a/Modules/Segmentation/KLMRegionGrowing/include/itkRegionGrowImageFilter.hxx b/Modules/Segmentation/KLMRegionGrowing/include/itkRegionGrowImageFilter.hxx index a22f67b76d2..6c0f8be416d 100644 --- a/Modules/Segmentation/KLMRegionGrowing/include/itkRegionGrowImageFilter.hxx +++ b/Modules/Segmentation/KLMRegionGrowing/include/itkRegionGrowImageFilter.hxx @@ -28,9 +28,6 @@ RegionGrowImageFilter::RegionGrowImageFilter() m_MaximumNumberOfRegions = 0; } -/** - * PrintSelf - */ template void RegionGrowImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -39,7 +36,7 @@ RegionGrowImageFilter::PrintSelf(std::ostream & os, I os << indent << "Region grow image filter object" << std::endl; os << indent << "Maximum number of regions: " << m_MaximumNumberOfRegions << std::endl; os << indent << "Maximum grid size : " << m_GridSize << std::endl; -} // end PrintSelf +} } // namespace itk #endif diff --git a/Modules/Segmentation/KLMRegionGrowing/src/itkKLMSegmentationBorder.cxx b/Modules/Segmentation/KLMRegionGrowing/src/itkKLMSegmentationBorder.cxx index 1cac79e46da..edc94774034 100644 --- a/Modules/Segmentation/KLMRegionGrowing/src/itkKLMSegmentationBorder.cxx +++ b/Modules/Segmentation/KLMRegionGrowing/src/itkKLMSegmentationBorder.cxx @@ -28,9 +28,6 @@ KLMSegmentationBorder::KLMSegmentationBorder() KLMSegmentationBorder::~KLMSegmentationBorder() = default; -/** - * PrintSelf - */ void KLMSegmentationBorder::PrintSelf(std::ostream & os, Indent indent) const { @@ -38,37 +35,37 @@ KLMSegmentationBorder::PrintSelf(std::ostream & os, Indent indent) const os << indent << "Lambda = " << m_Lambda << std::endl; os << indent << "Region1 = " << m_Region1 << std::endl; os << indent << "Region2 = " << m_Region2 << std::endl; -} // end PrintSelf +} void KLMSegmentationBorder::SetRegion1(KLMSegmentationRegion * Region1) { m_Region1 = Region1; -} // end SetRegion1 +} KLMSegmentationRegion * KLMSegmentationBorder::GetRegion1() { return m_Region1; -} // end GetRegion2 +} void KLMSegmentationBorder::SetRegion2(KLMSegmentationRegion * Region2) { m_Region2 = Region2; -} // end SetRegion2 +} KLMSegmentationRegion * KLMSegmentationBorder::GetRegion2() { return m_Region2; -} // end GetRegion2 +} void KLMSegmentationBorder::EvaluateLambda() { m_Lambda = m_Region1->EnergyFunctional(m_Region2) / this->GetBorderLength(); -} // end EvaluateLambda() +} void KLMSegmentationBorder::PrintBorderInfo() diff --git a/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.h b/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.h index 532f4958e08..b0e792719bd 100644 --- a/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.h +++ b/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.h @@ -110,7 +110,7 @@ class ITK_TEMPLATE_EXPORT ReinitializeLevelSetImageFilter : public ImageToImageF this->SetOutputNarrowBandwidth(value); } - /** Set/Get the input narrowband. */ + /** Set/Get the input narrowband container. */ void SetInputNarrowBand(NodeContainer * ptr); diff --git a/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.hxx b/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.hxx index 3b8be33b69d..a2c8fb1d5b9 100644 --- a/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.hxx +++ b/Modules/Segmentation/LevelSets/include/itkReinitializeLevelSetImageFilter.hxx @@ -23,9 +23,7 @@ namespace itk { -/** - * Default constructor. - */ + template ReinitializeLevelSetImageFilter::ReinitializeLevelSetImageFilter() { @@ -41,9 +39,6 @@ ReinitializeLevelSetImageFilter::ReinitializeLevelSetImageFilter() m_OutputNarrowBand = nullptr; } -/* - * Set the input narrowband container. - */ template void ReinitializeLevelSetImageFilter::SetInputNarrowBand(NodeContainer * ptr) @@ -55,9 +50,6 @@ ReinitializeLevelSetImageFilter::SetInputNarrowBand(NodeContainer * p } } -/** - * PrintSelf method. - */ template void ReinitializeLevelSetImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -75,9 +67,6 @@ ReinitializeLevelSetImageFilter::PrintSelf(std::ostream & os, Indent os << std::endl; } -/* - * GenerateInputRequestedRegion method. - */ template void ReinitializeLevelSetImageFilter::GenerateInputRequestedRegion() @@ -86,9 +75,6 @@ ReinitializeLevelSetImageFilter::GenerateInputRequestedRegion() this->Superclass::GenerateInputRequestedRegion(); } -/* - * EnlargeOutputRequestedRegion method. - */ template void ReinitializeLevelSetImageFilter::EnlargeOutputRequestedRegion(DataObject * output) @@ -111,9 +97,6 @@ ReinitializeLevelSetImageFilter::EnlargeOutputRequestedRegion(DataObj } } -/* - * Allocate/initialize memory. - */ template void ReinitializeLevelSetImageFilter::AllocateOutput() @@ -131,9 +114,6 @@ ReinitializeLevelSetImageFilter::AllocateOutput() this->m_Marcher->SetOutputDirection(this->GetInput()->GetDirection()); } -/* - * Generate the output data. - */ template void ReinitializeLevelSetImageFilter::GenerateData() @@ -150,9 +130,6 @@ ReinitializeLevelSetImageFilter::GenerateData() } } -/* - * Generate the output data - full set version. - */ template void ReinitializeLevelSetImageFilter::GenerateDataFull() @@ -225,9 +202,6 @@ ReinitializeLevelSetImageFilter::GenerateDataFull() } } -/* - * Generate output data - narrowband version. - */ template void ReinitializeLevelSetImageFilter::GenerateDataNarrowBand() diff --git a/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunction.hxx b/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunction.hxx index 2c8953c216b..42fea6e2cb5 100644 --- a/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunction.hxx +++ b/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunction.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template ShapePriorMAPCostFunction::ShapePriorMAPCostFunction() { @@ -35,9 +33,6 @@ ShapePriorMAPCostFunction::ShapePriorMAPCostFunctio m_Weights.Fill(1.0); } -/** - * PrintSelf - */ template void ShapePriorMAPCostFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -49,9 +44,6 @@ ShapePriorMAPCostFunction::PrintSelf(std::ostream & os << indent << "Weights: " << m_Weights << std::endl; } -/** - * - */ template auto ShapePriorMAPCostFunction::ComputeLogInsideTerm(const ParametersType & parameters) const @@ -93,9 +85,6 @@ ShapePriorMAPCostFunction::ComputeLogInsideTerm(con return output; } -/** - * - */ template typename ShapePriorMAPCostFunction::MeasureType ShapePriorMAPCostFunction::ComputeLogShapePriorTerm( @@ -112,9 +101,6 @@ ShapePriorMAPCostFunction::ComputeLogShapePriorTerm return measure; } -/** - * - */ template auto ShapePriorMAPCostFunction::ComputeLogGradientTerm(const ParametersType & parameters) const @@ -148,9 +134,6 @@ ShapePriorMAPCostFunction::ComputeLogGradientTerm(c return sum; } -/** - * - */ template typename ShapePriorMAPCostFunction::MeasureType ShapePriorMAPCostFunction::ComputeLogPosePriorTerm( @@ -159,9 +142,6 @@ ShapePriorMAPCostFunction::ComputeLogPosePriorTerm( return 0.0; } -/** - * - */ template void ShapePriorMAPCostFunction::Initialize() diff --git a/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunctionBase.hxx b/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunctionBase.hxx index e802c5f9dc2..df60bae3910 100644 --- a/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunctionBase.hxx +++ b/Modules/Segmentation/LevelSets/include/itkShapePriorMAPCostFunctionBase.hxx @@ -21,9 +21,7 @@ namespace itk { -/** - * Constructor - */ + template ShapePriorMAPCostFunctionBase::ShapePriorMAPCostFunctionBase() { @@ -32,9 +30,6 @@ ShapePriorMAPCostFunctionBase::ShapePriorMAPCostFun m_FeatureImage = nullptr; } -/** - * PrintSelf - */ template void ShapePriorMAPCostFunctionBase::PrintSelf(std::ostream & os, Indent indent) const @@ -45,9 +40,6 @@ ShapePriorMAPCostFunctionBase::PrintSelf(std::ostre os << indent << "FeatureImage: " << m_FeatureImage.GetPointer() << std::endl; } -/** - * - */ template auto ShapePriorMAPCostFunctionBase::GetValue(const ParametersType & parameters) const @@ -57,9 +49,6 @@ ShapePriorMAPCostFunctionBase::GetValue(const Param this->ComputeLogShapePriorTerm(parameters) + this->ComputeLogPosePriorTerm(parameters)); } -/** - * - */ template void ShapePriorMAPCostFunctionBase::Initialize() diff --git a/Modules/Segmentation/LevelSets/include/itkShapePriorSegmentationLevelSetFunction.hxx b/Modules/Segmentation/LevelSets/include/itkShapePriorSegmentationLevelSetFunction.hxx index 1478f315396..8dda87dd0c0 100644 --- a/Modules/Segmentation/LevelSets/include/itkShapePriorSegmentationLevelSetFunction.hxx +++ b/Modules/Segmentation/LevelSets/include/itkShapePriorSegmentationLevelSetFunction.hxx @@ -22,9 +22,7 @@ namespace itk { -/** - * Constructor - */ + template ShapePriorSegmentationLevelSetFunction::ShapePriorSegmentationLevelSetFunction() { @@ -32,9 +30,6 @@ ShapePriorSegmentationLevelSetFunction::ShapePrio m_ShapePriorWeight = NumericTraits::ZeroValue(); } -/** - * PrintSelf - */ template void ShapePriorSegmentationLevelSetFunction::PrintSelf(std::ostream & os, Indent indent) const @@ -44,9 +39,6 @@ ShapePriorSegmentationLevelSetFunction::PrintSelf os << indent << "ShapePriorWeight: " << m_ShapePriorWeight << std::endl; } -/** - * Compute the equation value. - */ template typename ShapePriorSegmentationLevelSetFunction::PixelType ShapePriorSegmentationLevelSetFunction::ComputeUpdate( @@ -82,9 +74,6 @@ ShapePriorSegmentationLevelSetFunction::ComputeUp return value; } -/** - * Compute the global time step. - */ template auto ShapePriorSegmentationLevelSetFunction::ComputeGlobalTimeStep(void * gd) const diff --git a/Modules/Segmentation/MarkovRandomFieldsClassifiers/include/itkMRFImageFilter.h b/Modules/Segmentation/MarkovRandomFieldsClassifiers/include/itkMRFImageFilter.h index 939ad4dda9a..b910c179def 100644 --- a/Modules/Segmentation/MarkovRandomFieldsClassifiers/include/itkMRFImageFilter.h +++ b/Modules/Segmentation/MarkovRandomFieldsClassifiers/include/itkMRFImageFilter.h @@ -267,13 +267,14 @@ class ITK_TEMPLATE_EXPORT MRFImageFilter : public ImageToImageFilter; - // Function implementing the neighborhood operation + /** Perform the MRF operation with each neighborhood. */ virtual void DoNeighborhoodOperation(const InputImageNeighborhoodIterator & imageIter, LabelledImageNeighborhoodIterator & labelledIter, @@ -428,7 +429,7 @@ class ITK_TEMPLATE_EXPORT MRFImageFilter : public ImageToImageFilter::PrintSelf(std::ostream & os, Inde os << indent << " Number of iterations: " << m_NumberOfIterations << std::endl; } // end PrintSelf -/* - * GenerateInputRequestedRegion method. - */ template void MRFImageFilter::GenerateInputRequestedRegion() @@ -89,9 +86,6 @@ MRFImageFilter::GenerateInputRequestedRegion() } } -/** - * EnlargeOutputRequestedRegion method. - */ template void MRFImageFilter::EnlargeOutputRequestedRegion(DataObject * output) @@ -104,9 +98,6 @@ MRFImageFilter::EnlargeOutputRequestedRegion(Data imgData->SetRequestedRegionToLargestPossibleRegion(); } -/** - * GenerateOutputInformation method. - */ template void MRFImageFilter::GenerateOutputInformation() @@ -159,7 +150,7 @@ MRFImageFilter::GenerateData() ++labelledImageIt; ++outImageIt; } -} // end GenerateData +} template void @@ -171,11 +162,7 @@ MRFImageFilter::SetClassifier(typename Classifier } m_ClassifierPtr = ptrToClassifier; m_ClassifierPtr->SetNumberOfClasses(m_NumberOfClasses); -} // end SetPtrToClassifier - -//------------------------------------------------------- -// Set the neighborhood radius -//------------------------------------------------------- +} template void @@ -189,7 +176,7 @@ MRFImageFilter::SetNeighborhoodRadius(const SizeV radius[i] = radiusValue; } this->SetNeighborhoodRadius(radius); -} // end SetNeighborhoodRadius +} template void @@ -203,9 +190,8 @@ MRFImageFilter::SetNeighborhoodRadius(const SizeV } // Set up the neighborhood this->SetNeighborhoodRadius(radius); -} // end SetNeighborhoodRadius +} -// Set the neighborhood radius template void MRFImageFilter::SetNeighborhoodRadius(const NeighborhoodRadiusType & radius) @@ -217,13 +203,7 @@ MRFImageFilter::SetNeighborhoodRadius(const Neigh m_LabelledImageNeighborhoodRadius[i] = radius[i]; m_LabelStatusImageNeighborhoodRadius[i] = radius[i]; } -} // end SetNeighborhoodRadius - -//------------------------------------------------------- - -//------------------------------------------------------- -// Set the neighborhood weights -//------------------------------------------------------- +} template void @@ -324,12 +304,8 @@ MRFImageFilter::SetMRFNeighborhoodWeight(std::vec m_MRFNeighborhoodWeight[i] = (betaMatrix[i] * m_SmoothingFactor); } } -} // end SetDefaultMRFNeighborhoodWeight +} -//------------------------------------------------------- -//------------------------------------------------------- -// Allocate algorithm specific resources -//------------------------------------------------------- template void MRFImageFilter::Allocate() @@ -368,12 +344,7 @@ MRFImageFilter::Allocate() rIter.Set(1); ++rIter; } -} // Allocate - -//------------------------------------------------------- -//------------------------------------------------------- -// Apply the MRF image filter -//------------------------------------------------------- +} template void @@ -421,12 +392,7 @@ MRFImageFilter::ApplyMRFImageFilter() { m_StopCondition = MRFStopEnum::ErrorTolerance; } -} // ApplyMRFImageFilter - -//------------------------------------------------------- -//------------------------------------------------------- -// Minimize the functional -//------------------------------------------------------- +} template void @@ -436,10 +402,6 @@ MRFImageFilter::MinimizeFunctional() ApplyICMLabeller(); } -//------------------------------------------------------- -//------------------------------------------------------- -// Core of the ICM algorithm -//------------------------------------------------------- template void MRFImageFilter::ApplyICMLabeller() @@ -504,12 +466,7 @@ MRFImageFilter::ApplyICMLabeller() ++nLabelledImageNeighborhoodIter; ++nLabelStatusImageNeighborhoodIter; } -} // ApplyICMlabeller - -//------------------------------------------------------- -//------------------------------------------------------- -// Function that performs the MRF operation with each neighborhood -//------------------------------------------------------- +} template void @@ -574,13 +531,13 @@ MRFImageFilter::DoNeighborhoodOperation( for (int i = 0; i < m_NeighborhoodSize; ++i) { labelStatusIter.SetPixel(i, 1); - } // End neighborhood processing - } // end if + } + } else { labelStatusIter.SetCenterPixel(0); } -} // end DoNeighborhoodOperation +} } // namespace itk #endif diff --git a/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.h b/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.h index 86258af00b3..9d8f28c0645 100644 --- a/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.h +++ b/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.h @@ -137,7 +137,7 @@ class ITK_TEMPLATE_EXPORT ConfidenceConnectedImageFilter : public ImageToImageFi * executed using the Update() method. */ itkGetConstReferenceMacro(Variance, InputRealType); - /** Method to access seed container */ + /** Method to access seed container. */ virtual const SeedsContainerType & GetSeeds() const; diff --git a/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.hxx b/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.hxx index b8d94d58afc..0cdabd3f4d7 100644 --- a/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.hxx +++ b/Modules/Segmentation/RegionGrowing/include/itkConfidenceConnectedImageFilter.hxx @@ -29,9 +29,7 @@ namespace itk { -/** - * Constructor - */ + template ConfidenceConnectedImageFilter::ConfidenceConnectedImageFilter() { @@ -71,7 +69,6 @@ ConfidenceConnectedImageFilter::AddSeed(const IndexTy this->Modified(); } -/** Method to access seed container */ template auto ConfidenceConnectedImageFilter::GetSeeds() const -> const SeedsContainerType & @@ -80,9 +77,6 @@ ConfidenceConnectedImageFilter::GetSeeds() const -> c return this->m_Seeds; } -/** - * Standard PrintSelf method. - */ template void ConfidenceConnectedImageFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.h b/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.h index 823bee99f03..52c6a9d6faf 100644 --- a/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.h +++ b/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.h @@ -114,6 +114,8 @@ class ITK_TEMPLATE_EXPORT IsolatedConnectedImageFilter : public ImageToImageFilt * * This seed will be isolated from Seed2 (if possible). All pixels * connected to this seed will be replaced with ReplaceValue. + * + * \deprecated Please use AddSeed1. */ void SetSeed1(const IndexType & seed); @@ -129,6 +131,8 @@ class ITK_TEMPLATE_EXPORT IsolatedConnectedImageFilter : public ImageToImageFilt /** Set a single seed point 2. * * This seed will be isolated from Seed1 (if possible). + * + * \deprecated Please use AddSeed2. */ void SetSeed2(const IndexType & seed); diff --git a/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.hxx b/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.hxx index 9743b6e6fc7..1efb8a8240f 100644 --- a/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.hxx +++ b/Modules/Segmentation/RegionGrowing/include/itkIsolatedConnectedImageFilter.hxx @@ -28,9 +28,7 @@ namespace itk { -/** - * Constructor - */ + template IsolatedConnectedImageFilter::IsolatedConnectedImageFilter() { @@ -45,9 +43,6 @@ IsolatedConnectedImageFilter::IsolatedConnectedImageF m_ThresholdingFailed = false; } -/** - * Standard PrintSelf method. - */ template void IsolatedConnectedImageFilter::PrintSelf(std::ostream & os, Indent indent) const @@ -91,7 +86,6 @@ IsolatedConnectedImageFilter::EnlargeOutputRequestedR output->SetRequestedRegionToLargestPossibleRegion(); } -/** Add seed point 1. This seed will be isolated from Seed2 (if possible). */ template void IsolatedConnectedImageFilter::AddSeed1(const IndexType & seed) @@ -100,9 +94,6 @@ IsolatedConnectedImageFilter::AddSeed1(const IndexTyp this->Modified(); } -/** \deprecated - * Set seed point 1. This seed will be isolated from Seed2 (if possible). - * This method is deprecated, please use AddSeed1() */ template void IsolatedConnectedImageFilter::SetSeed1(const IndexType & seed) @@ -111,7 +102,6 @@ IsolatedConnectedImageFilter::SetSeed1(const IndexTyp this->AddSeed1(seed); } -/** Clear all the seeds1. */ template void IsolatedConnectedImageFilter::ClearSeeds1() @@ -123,7 +113,6 @@ IsolatedConnectedImageFilter::ClearSeeds1() } } -/** Add seed point 2. This seed will be isolated from Seed1 (if possible). */ template void IsolatedConnectedImageFilter::AddSeed2(const IndexType & seed) @@ -132,9 +121,6 @@ IsolatedConnectedImageFilter::AddSeed2(const IndexTyp this->Modified(); } - -/** Set seed point 2. This seed will be isolated from Seed1 (if - * possible). This method is deprecated, please use AddSeed2() */ template void IsolatedConnectedImageFilter::SetSeed2(const IndexType & seed) @@ -143,7 +129,6 @@ IsolatedConnectedImageFilter::SetSeed2(const IndexTyp this->AddSeed2(seed); } -/** Clear all the seeds2. */ template void IsolatedConnectedImageFilter::ClearSeeds2() diff --git a/Modules/Segmentation/RegionGrowing/include/itkNeighborhoodConnectedImageFilter.hxx b/Modules/Segmentation/RegionGrowing/include/itkNeighborhoodConnectedImageFilter.hxx index 0ce5e7de1dc..82af161d2e0 100644 --- a/Modules/Segmentation/RegionGrowing/include/itkNeighborhoodConnectedImageFilter.hxx +++ b/Modules/Segmentation/RegionGrowing/include/itkNeighborhoodConnectedImageFilter.hxx @@ -24,9 +24,7 @@ namespace itk { -/** - * Constructor - */ + template NeighborhoodConnectedImageFilter::NeighborhoodConnectedImageFilter() { @@ -63,9 +61,6 @@ NeighborhoodConnectedImageFilter::AddSeed(const Index this->Modified(); } -/** - * Standard PrintSelf method. - */ template void NeighborhoodConnectedImageFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Segmentation/RegionGrowing/include/itkVectorConfidenceConnectedImageFilter.hxx b/Modules/Segmentation/RegionGrowing/include/itkVectorConfidenceConnectedImageFilter.hxx index eadc2be2afd..2939751b08c 100644 --- a/Modules/Segmentation/RegionGrowing/include/itkVectorConfidenceConnectedImageFilter.hxx +++ b/Modules/Segmentation/RegionGrowing/include/itkVectorConfidenceConnectedImageFilter.hxx @@ -29,9 +29,7 @@ namespace itk { -/** - * Constructor - */ + template VectorConfidenceConnectedImageFilter::VectorConfidenceConnectedImageFilter() { @@ -43,9 +41,6 @@ VectorConfidenceConnectedImageFilter::VectorConfidenc m_ThresholdFunction = DistanceThresholdFunctionType::New(); } -/** - * Standard PrintSelf method. - */ template void VectorConfidenceConnectedImageFilter::PrintSelf(std::ostream & os, Indent indent) const diff --git a/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationImageFilterBase.hxx b/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationImageFilterBase.hxx index e907cd4c8ea..29da38bbc70 100644 --- a/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationImageFilterBase.hxx +++ b/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationImageFilterBase.hxx @@ -25,7 +25,7 @@ namespace itk { -/* Constructor: setting the default parameter values. */ + template VoronoiSegmentationImageFilterBase::VoronoiSegmentationImageFilterBase() : m_WorkingVD(VoronoiDiagram::New()) diff --git a/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationRGBImageFilter.hxx b/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationRGBImageFilter.hxx index 598b3a5aa5c..2f1bd2d6b44 100644 --- a/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationRGBImageFilter.hxx +++ b/Modules/Segmentation/Voronoi/include/itkVoronoiSegmentationRGBImageFilter.hxx @@ -23,7 +23,7 @@ namespace itk { -/* Constructor: setting of the default values for the parameters. */ + template VoronoiSegmentationRGBImageFilter::VoronoiSegmentationRGBImageFilter() { @@ -70,7 +70,6 @@ VoronoiSegmentationRGBImageFilter::SetSTDPercentError } } -/* Initialization for the segmentation. */ template void VoronoiSegmentationRGBImageFilter::SetInput(unsigned int inputNumber, @@ -79,7 +78,6 @@ VoronoiSegmentationRGBImageFilter::SetInput(unsigned this->Superclass::SetInput(inputNumber, input); } -/* Initialization for the segmentation. */ template void VoronoiSegmentationRGBImageFilter::SetInput(const InputImageType * input) diff --git a/Modules/Video/Core/include/itkRingBuffer.hxx b/Modules/Video/Core/include/itkRingBuffer.hxx index 62948a7cbd8..36cde8e9b08 100644 --- a/Modules/Video/Core/include/itkRingBuffer.hxx +++ b/Modules/Video/Core/include/itkRingBuffer.hxx @@ -23,11 +23,6 @@ namespace itk { -//-CONSTRUCTOR DESTRUCTOR PRINT------------------------------------------------ - -// -// Constructor -// template RingBuffer::RingBuffer() : m_PointerVector() @@ -36,9 +31,6 @@ RingBuffer::RingBuffer() this->SetNumberOfBuffers(3); } -// -// PrintSelf -// template void RingBuffer::PrintSelf(std::ostream & os, Indent indent) const @@ -48,13 +40,6 @@ RingBuffer::PrintSelf(std::ostream & os, Indent indent) const os << indent << "NumberOfBuffers: " << this->m_PointerVector.size() << std::endl; } - -//-PUBLIC METHODS-------------------------------------------------------------- - - -// -// MoveHead -// template void RingBuffer::MoveHead(OffsetValueType offset) @@ -66,10 +51,6 @@ RingBuffer::MoveHead(OffsetValueType offset) this->Modified(); } - -// -// MoveHeadForward -// template void RingBuffer::MoveHeadForward() @@ -77,10 +58,6 @@ RingBuffer::MoveHeadForward() this->MoveHead(1); } - -// -// MoveHeadBackward -// template void RingBuffer::MoveHeadBackward() @@ -88,10 +65,6 @@ RingBuffer::MoveHeadBackward() this->MoveHead(-1); } - -// -// BufferIsFull -// template bool RingBuffer::BufferIsFull(OffsetValueType offset) @@ -101,9 +74,6 @@ RingBuffer::BufferIsFull(OffsetValueType offset) return !(this->m_PointerVector[bufferIndex].IsNull()); } -// -// GetBufferContents -// template typename TElement::Pointer RingBuffer::GetBufferContents(OffsetValueType offset) @@ -115,10 +85,6 @@ RingBuffer::GetBufferContents(OffsetValueType offset) return this->m_PointerVector[bufferIndex]; } - -// -// SetBufferContents -// template void RingBuffer::SetBufferContents(OffsetValueType offset, ElementPointer element) @@ -133,10 +99,6 @@ RingBuffer::SetBufferContents(OffsetValueType offset, ElementPointer e this->Modified(); } - -// -// GetNumberOfBuffers -// template auto RingBuffer::GetNumberOfBuffers() -> SizeValueType @@ -144,10 +106,6 @@ RingBuffer::GetNumberOfBuffers() -> SizeValueType return static_cast::SizeValueType>(this->m_PointerVector.size()); } - -// -// SetNumberOfBuffers -// template void RingBuffer::SetNumberOfBuffers(SizeValueType n) @@ -189,12 +147,6 @@ RingBuffer::SetNumberOfBuffers(SizeValueType n) this->Modified(); } - -//-PROTECTED METHODS----------------------------------------------------------- - -// -// GetOffsetBufferIndex -// template auto RingBuffer::GetOffsetBufferIndex(OffsetValueType offset) -> OffsetValueType diff --git a/Modules/Video/Filtering/include/itkImageFilterToVideoFilterWrapper.hxx b/Modules/Video/Filtering/include/itkImageFilterToVideoFilterWrapper.hxx index 62b1b2b0c34..c269dc78b21 100644 --- a/Modules/Video/Filtering/include/itkImageFilterToVideoFilterWrapper.hxx +++ b/Modules/Video/Filtering/include/itkImageFilterToVideoFilterWrapper.hxx @@ -22,9 +22,6 @@ namespace itk { -// -// Constructor -// template ImageFilterToVideoFilterWrapper::ImageFilterToVideoFilterWrapper() { @@ -38,9 +35,6 @@ ImageFilterToVideoFilterWrapper::ImageFilterToVideoFilterWr m_ImageFilter = nullptr; } -// -// PrintSelf -// template void ImageFilterToVideoFilterWrapper::PrintSelf(std::ostream & os, Indent indent) const @@ -57,9 +51,6 @@ ImageFilterToVideoFilterWrapper::PrintSelf(std::ostream & o } } -// -// TemporalStreamingGenerateData -// template void ImageFilterToVideoFilterWrapper::TemporalStreamingGenerateData()