Commit 8f4aa488 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC] spelling fixed

parent eb22a0b1
......@@ -37,7 +37,7 @@
#include "../../kernel/WModuleOutputData.h"
/**
* Spherical harmonics glyphs usingf teem (http://teem.sourceforge.net/).
* Spherical harmonics glyphs using teem (http://teem.sourceforge.net/).
* According to http://www.ci.uchicago.edu/~schultz/sphinx/home-glyph.htm
* Thanks to Thomas Schultz.
*
......@@ -103,7 +103,7 @@ protected:
private:
/**
* An input connector that accepts sperical harmonics datasets.
* An input connector that accepts spherical harmonics datasets.
*/
boost::shared_ptr< WModuleInputData< WDataSetSphericalHarmonics > > m_input;
......@@ -193,7 +193,7 @@ private:
/**
* Makes the radii of the glyph be distributed between [0,1]
* \param glyph The glyph that will be normalized given as teem's limnPolyData.
* \param nbVertCoords Number of coords per vertex for the glyph polydata
* \param nbVertCoords Number of coordinates per vertex for the glyph poly-data
*/
void minMaxNormalization( limnPolyData *glyph, const size_t& nbVertCoords );
......
......@@ -355,4 +355,3 @@ private:
};
#endif // WMTEMPLATE_H
......@@ -141,17 +141,17 @@ private:
WPropBool m_coloringMode; //!< indicates a set color or direction color coding.
WPropInt m_xSlice; //!< x posistion of the slice
WPropInt m_xSlice; //!< x position of the slice
WPropInt m_ySlice; //!< y posistion of the slice
WPropInt m_ySlice; //!< y position of the slice
WPropInt m_zSlice; //!< z posistion of the slice
WPropInt m_zSlice; //!< z position of the slice
WPropBool m_showonX; //!< in dicates whether the vector should be shown on slice X
WPropBool m_showonX; //!< indicates whether the vector should be shown on slice X
WPropBool m_showonY; //!< in dicates whether the vector should be shown on slice Y
WPropBool m_showonY; //!< indicates whether the vector should be shown on slice Y
WPropBool m_showonZ; //!< in dicates whether the vector should be shown on slice Z
WPropBool m_showonZ; //!< indicates whether the vector should be shown on slice Z
WPropColor m_aColor; //!< color
......@@ -193,4 +193,3 @@ private:
};
#endif // WMVECTORPLOT_H
......@@ -37,7 +37,7 @@
#include "WRasterAlgorithm.h"
/**
* Implementes basic bresenham algorithm for rasterization.
* Implements basic Bresenham algorithm for rasterization.
*/
class WBresenham : public WRasterAlgorithm
{
......@@ -48,7 +48,7 @@ public:
*
* \param grid The grid which defines the voxels which should be marked.
* \param antialiased If true then all voxels of a line are supported with
* antialiasing voxels around
* anti-aliasing voxels around
*/
WBresenham( boost::shared_ptr< WGridRegular3D > grid, bool antialiased = true );
......@@ -67,10 +67,10 @@ public:
protected:
/**
* Scans a line segement for voxels which are hit.
* Scans a line segment for voxels which are hit.
*
* \warning Not every voxel which is hitten by the segement will be marked
* but at least so many voxels so that the segement is represented by those
* \warning Not every voxel which is hit by the segment will be marked
* but at least so many voxels so that the segment is represented by those
* voxels.
* \warning Every line starting in voxel A and ending in voxel B is
* rastered the same way as the line from the middlepoint of A to the
......@@ -79,29 +79,29 @@ protected:
* \note This algorithm is fast since using only integer operations. This
* is the real Bresenham
*
* \param start Start point of the line segement
* \param end End point of the line segement
* \param start Start point of the line segment
* \param end End point of the line segment
*/
virtual void rasterSegment( const wmath::WPosition& start, const wmath::WPosition& end );
/**
* Marks the given voxel as a hit. If antialiasing is enabled also some
* supporting voxles nearby are marked. The value for marking the voxel
* Marks the given voxel as a hit. If anti-aliasing is enabled also some
* supporting voxels nearby are marked. The value for marking the voxel
* depends on the distance from its center point to the real line.
*
* \param voxel The voxel to mark
* \param axis Along which axis the traversal takes place. Since when
* walking in e.g. X-direction there are not supporting voxels in the
* same direction.
* \param start Start point of the line segement (used to computed the
* \param start Start point of the line segment (used to computed the
* distance)
* \param end End point of the line segement (used to computed the
* \param end End point of the line segment (used to computed the
* distance)
*/
virtual void markVoxel( const wmath::WValue< int >& voxel, const int axis, const wmath::WPosition& start, const wmath::WPosition& end );
/**
* Returns the value to mark the hitten voxels with, denpending on their
* Returns the value to mark the hit voxels with, depending on their
* distance to the line.
*
* \param distance Distance of the voxel to the line.
......@@ -111,12 +111,12 @@ protected:
virtual double filter( const double distance ) const;
/**
* Computes the distances for a voxel to the real line segement and also
* Computes the distances for a voxel to the real line segment and also
* for its supporting voxels.
*
* \param voxelNum The voxel number
* \param start Start point of the line segement
* \param end End point of the line segement
* \param start Start point of the line segment
* \param end End point of the line segment
*
* \return A vector of distances where first distance is the distance of
* the voxel itself, then x+1, x-1 supporting voxel, then y+1 and y-1
......
......@@ -44,7 +44,7 @@ public:
*
* \param grid The grid which defines the voxels which should be marked.
* \param antialiased If true then all voxels of a line are supported with
* antialiasing voxels around
* anti-aliasing voxels around
*/
WBresenhamDBL( boost::shared_ptr< WGridRegular3D > grid, bool antialiased = true );
......@@ -55,15 +55,15 @@ public:
protected:
/**
* Scans a line segement for voxels which are hit.
* Scans a line segment for voxels which are hit.
*
* \warning Not every voxel which is hitten by the segement will be marked
* but at least so many voxels so that the segement is represented by those
* \warning Not every voxel which is hit by the segment will be marked
* but at least so many voxels so that the segment is represented by those
* voxels.
*
* \note This algorithm may be slow since using double operations.
* \param start Start point of the line segement
* \param stop End point of the line segement
* \param start Start point of the line segment
* \param stop End point of the line segment
*/
void rasterSegment( const wmath::WPosition& start, const wmath::WPosition& stop );
......
......@@ -58,8 +58,8 @@ public:
* \param voxelIdx the voxel index in the common grid calculated using "voxel" (this is for convenience)
* \param axis Along which axis the traversal takes place. Since when walking in e.g. X-direction there are not supporting voxels in the
* \param value the new voxel value
* \param start Start point of the line segement (used to computed the distance)
* \param end End point of the line segement (used to computed the distance)
* \param start Start point of the line segment (used to computed the distance)
* \param end End point of the line segment (used to computed the distance)
*/
virtual void parameterizeVoxel( const wmath::WValue< int >& voxel, size_t voxelIdx, const int axis, const double value,
const wmath::WPosition& start,
......@@ -128,4 +128,3 @@ private:
};
#endif // WCENTERLINEPARAMETERIZATION_H
......@@ -55,8 +55,8 @@ public:
* \param voxelIdx the voxel index in the common grid calculated using "voxel" (this is for convenience)
* \param axis Along which axis the traversal takes place. Since when walking in e.g. X-direction there are not supporting voxels in the
* \param value the new voxel value
* \param start Start point of the line segement (used to computed the distance)
* \param end End point of the line segement (used to computed the distance)
* \param start Start point of the line segment (used to computed the distance)
* \param end End point of the line segment (used to computed the distance)
*/
virtual void parameterizeVoxel( const wmath::WValue< int >& voxel, size_t voxelIdx, const int axis, const double value,
const wmath::WPosition& start,
......@@ -100,4 +100,3 @@ private:
};
#endif // WINTEGRATIONPARAMETERIZATION_H
......@@ -38,8 +38,8 @@
#include "WRasterAlgorithm.h"
/**
* Traces a given set of deterministic tracts as given by a WFiberCluster in a voxelwise manner.
* Every voxel which is hit by one or more tracts or tract-segements is marked with a scalar.
* Traces a given set of deterministic tracts as given by a WFiberCluster in a voxel-wise manner.
* Every voxel which is hit by one or more tracts or tract-segments is marked with a scalar.
* \ingroup modules
*/
class WMVoxelizer : public WModule
......@@ -140,7 +140,7 @@ protected:
/**
* Performs rasterization with the given algorithm.
*
* \param algo The algorithm which actualy rasters every fiber.
* \param algo The algorithm which actually rasters every fiber.
*/
void raster( boost::shared_ptr< WRasterAlgorithm > algo ) const;
......@@ -188,7 +188,7 @@ private:
boost::shared_ptr< WCondition > m_fullUpdate; //!< module is performing an expensive update
WPropBool m_antialiased; //!< Enable/Disable antialiased drawing of voxels
WPropBool m_antialiased; //!< Enable/Disable anti-aliased drawing of voxels
WPropBool m_drawfibers; //!< Enable/Disable drawing of the fibers of a cluster
WPropBool m_drawBoundingBox; //!< Enable/Disable drawing of a clusters BoundingBox
WPropBool m_drawCenterLine; //!< Enable/Disable drawing of the current clusters CenterLine
......@@ -197,7 +197,7 @@ private:
WPropString m_rasterAlgo; //!< Specifies the algorithm you may want to use for voxelization
WPropInt m_voxelsPerUnit; //!< The number of voxels per unit in the coordinate system
WPropDouble m_fiberTransparency; //!< Trancparency of the fibers
WPropDouble m_fiberTransparency; //!< Transparency of the fibers
WPropColor m_explicitFiberColor; //!< If set not to 0.2 0.2 0.2 all fiber having this color
/**
......
......@@ -47,7 +47,7 @@ public:
/**
* Creates new raster algorithm within the given grid. The grid may later
* also be used to generate a real DataSet, \see generateDataSet() for
* furter instructions.
* further instructions.
*
* \param grid The grid specifying the voxels.
*/
......@@ -105,7 +105,7 @@ protected:
* - First we need it when creating the final dataset
* - Second we need it to determine how many voxels are there at
* construction time
* - Thrid we need it when computing the value number out of a position
* - Third we need it when computing the value number out of a position
*/
boost::shared_ptr< WGridRegular3D > m_grid;
......@@ -123,8 +123,8 @@ protected:
* \param voxelIdx the voxel index in the common grid calculated using "voxel" (this is for convenience)
* \param axis Along which axis the traversal takes place. Since when walking in e.g. X-direction there are not supporting voxels in the
* \param value the new voxel value
* \param start Start point of the line segement (used to computed the distance)
* \param end End point of the line segement (used to computed the distance)
* \param start Start point of the line segment (used to computed the distance)
* \param end End point of the line segment (used to computed the distance)
*/
virtual void parameterizeVoxel( const wmath::WValue< int >& voxel, size_t voxelIdx, const int axis, const double value,
const wmath::WPosition& start,
......
......@@ -59,8 +59,8 @@ public:
* \param voxelIdx the voxel index in the common grid calculated using "voxel" (this is for convenience)
* \param axis Along which axis the traversal takes place. Since when walking in e.g. X-direction there are not supporting voxels in the
* \param value the new voxel value
* \param start Start point of the line segement (used to computed the distance)
* \param end End point of the line segement (used to computed the distance)
* \param start Start point of the line segment (used to computed the distance)
* \param end End point of the line segment (used to computed the distance)
*/
virtual void parameterizeVoxel( const wmath::WValue< int >& voxel, size_t voxelIdx, const int axis, const double value,
const wmath::WPosition& start,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment