Skip to content

Commit

Permalink
DOC: Clean up itk::ConformalFlatteningMeshFilter Doxygen documentation
Browse files Browse the repository at this point in the history
Clean up method Doxygen documentation for
`itk::ConformalFlatteningMeshFilter`:
- Consolidate documentation so that methods are documented in the header
  files.
- Remove empty method documentation blocks from implementation file.

Take advantage of the commit to make the modified method documentation
blocks have a consistent line length.

Follow-up to d58bf56.
  • Loading branch information
jhlegarreta authored and hjmjohnson committed Jun 28, 2023
1 parent 3ed7524 commit 3a542d0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 27 deletions.
Expand Up @@ -89,11 +89,11 @@ class ITK_TEMPLATE_EXPORT ConformalFlatteningMeshFilter : public MeshToMeshFilte
using PointIdIterator = typename CellType::PointIdIterator;
using CellAutoPointer = typename CellType::CellAutoPointer;

/** Select the cell that will be used as reference for the flattening.
* This value must be the identifier of a cell existing in the input Mesh.
* A point of this cell will be mapped to infinity on the plane, or it
* will be mapped to the north-pole on the sphere. It is recommended to
* select a cell whose curvature is relatively flat. */
/** Select the cell that will be used to define the boundary/used as reference for the flattening.
* This value must be the identifier of a cell existing in the input Mesh. A point of this cell will be mapped to
* infinity on the plane, or it will be mapped to the north-pole on the sphere. It is recommended to select a cell
* whose curvature is relatively flat.
*/
void
SetPolarCellIdentifier(CellIdentifier cellId);

Expand Down
Expand Up @@ -26,9 +26,7 @@

namespace itk
{
/**
*
*/

template <typename TInputMesh, typename TOutputMesh>
ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::ConformalFlatteningMeshFilter()
{
Expand All @@ -43,60 +41,41 @@ ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::ConformalFlatteningMeshF
// same number of vertices.
}

/**
* Set the triangle used to define the boundary of the flattened region.
*/
template <typename TInputMesh, typename TOutputMesh>
void
ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::SetPolarCellIdentifier(CellIdentifier cellId)
{
this->m_PolarCellIdentifier = cellId;
}

/**
* Define the scale of the mapping. The largest coordinates of the
* furthest point in the plane is m_MapScale.
*/
template <typename TInputMesh, typename TOutputMesh>
void
ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::SetScale(double scale)
{
this->m_MapScale = scale;
}

/**
* Define that the input surface will be mapped to a sphere
*/
template <typename TInputMesh, typename TOutputMesh>
void
ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::MapToSphere()
{
this->m_MapToSphere = true;
}

/** Define that the input surface will be mapped to a plane.
* This skips the steps of the stereographic projection.
*/
template <typename TInputMesh, typename TOutputMesh>
void
ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::MapToPlane()
{
this->m_MapToSphere = false;
}

/**
*
*/
template <typename TInputMesh, typename TOutputMesh>
void
ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::PrintSelf(std::ostream & os, Indent indent) const
{
Superclass::PrintSelf(os, indent);
}

/**
* This method causes the filter to generate its output.
*/
template <typename TInputMesh, typename TOutputMesh>
void
ConformalFlatteningMeshFilter<TInputMesh, TOutputMesh>::GenerateData()
Expand Down

0 comments on commit 3a542d0

Please sign in to comment.