Add documentation.

smtk/extension/vtk/operators/ElevateMesh.h

@@ -18,7 +18,16 @@ namespace smtk
 namespace mesh
 {
 
-/**\brief
+/**\brief A class for modifying the z-coordinates of a mesh's nodes according
+   to a VTK data set.
+
+   Given a VTK-compatible data set of either structured or unstructured data and
+   an input mesh, the z-coordinate of each point in the input mesh is set to the
+   average of the values in the external data set whose spatial coordinates lie
+   within a user-defined radius of the projection of the mesh point onto the
+   dataset. The resulting mesh deformation can be undone by subsequently
+   applying the "Undo Warp" filter, returning the mesh nodes to their original
+   position.
   */
 class VTKSMTKOPERATORSEXT_EXPORT ElevateMesh : public smtk::model::Operator
 {

smtk/mesh/interpolation/InverseDistanceWeighting.h

@@ -25,6 +25,14 @@ namespace mesh
 class PointCloud;
 class StructuredGrid;
 
+/**\brief A functor that converts an external data set into a continuous field
+   via inverse distance weighting.
+
+   Given an external data set of either structured or unstructured data, this
+   functor is a continuous function from R^3->R whose values are computed as the
+   inverse distance weights of the data set. Shepard's method is used to perform
+   the computation.
+  */
 class SMTKCORE_EXPORT InverseDistanceWeighting
 {
 public:

smtk/mesh/interpolation/PointCloud.h

@@ -23,6 +23,16 @@ namespace smtk
 namespace mesh
 {
 
+/**\brief A wrapper for point cloud data.
+
+   This class is a facade for describing external data sets that consist of
+   unstructured points and associated scalar values. While there is convenience
+   API for converting arrays of coordinates and data into this format, the
+   general use of this class is to pass it a size <nPoints> and two functors
+   <coordinates> and <data>. <coordinates> is an I->R^3 function for accessing
+   the ith coordinate of the data set, and <data> is an I->R function for
+   accessing the scalar value associated with the ith point.
+  */
 class SMTKCORE_EXPORT PointCloud
 {
 public:

smtk/mesh/interpolation/RadialAverage.h

@@ -25,6 +25,14 @@ namespace mesh
 class PointCloud;
 class StructuredGrid;
 
+/**\brief A functor that converts an external data set into a continuous field
+   via radial averaging.
+
+   Given an external data set of either structured or unstructured data, this
+   functor is a continuous function from R^3->R whose values are computed as the
+   average of the points in the data set within a sphere of radius <radius>
+   centered at the input point.
+  */
 class SMTKCORE_EXPORT RadialAverage
 {
 public:

smtk/mesh/interpolation/StructuredGrid.h

@@ -24,6 +24,15 @@ namespace smtk
 namespace mesh
 {
 
+/**\brief A wrapper for structured data.
+
+   This class is a facade for describing external two-dimensional data sets that
+   consist of a structured grid of points and associated scalar values. The user
+   must assign an index extent, origin and spacing, as well as an I^2->R
+   function describing the scalar value associated with index (i,j).
+   Additionally, an I^2->bool function can be passed to the class to denote cell
+   validity, facilitating blanking.
+  */
 class StructuredGrid
 {
 public:

smtk/mesh/operators/UndoWarpMesh.h

@@ -17,7 +17,11 @@ namespace smtk
 namespace mesh
 {
 
-/**\brief A class for generating a mesh data set from interpolation points.
+/**\brief A class for reversing the results of operators that warp a mesh.
+
+   Operators that use the methods defined in ApplyToMesh to deform a mesh's
+   coordinates can optionally cache the original unwarped coordinate values.
+   This operator then reverts the deformation performed by these operators.
   */
 class SMTKCORE_EXPORT UndoWarpMesh : public smtk::model::Operator
 {

smtk/mesh/operators/WarpMesh.h

@@ -17,7 +17,14 @@ namespace smtk
 namespace mesh
 {
 
-/**\brief A class for generating a mesh data set from interpolation points.
+/**\brief A class for modifying the z-coordinates of a mesh's nodes according
+   to an external data set.
+
+   Given an external data set of either structured or unstructured data and an
+   input mesh, the z-coordinate of each point in the input mesh is set to the
+   inverse distance weighted average of the values in the external data. The
+   resulting mesh deformation can be undone by subsequently applying the "Undo
+   Warp" filter, returning the mesh nodes to their original position.
   */
 class SMTKCORE_EXPORT WarpMesh : public smtk::model::Operator
 {