diff options
Diffstat (limited to 'source/blender/freestyle/intern/view_map/SteerableViewMap.h')
-rw-r--r-- | source/blender/freestyle/intern/view_map/SteerableViewMap.h | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/source/blender/freestyle/intern/view_map/SteerableViewMap.h b/source/blender/freestyle/intern/view_map/SteerableViewMap.h index e03400dbbc0..d007a08c3fd 100644 --- a/source/blender/freestyle/intern/view_map/SteerableViewMap.h +++ b/source/blender/freestyle/intern/view_map/SteerableViewMap.h @@ -42,7 +42,7 @@ class FEdge; class ImagePyramid; class GrayImage; -/*! This class checks for every FEdge in which steerable it belongs and stores the mapping +/** This class checks for every FEdge in which steerable it belongs and stores the mapping * allowing to retrieve this information from the FEdge Id. */ class SteerableViewMap { @@ -62,31 +62,31 @@ class SteerableViewMap { SteerableViewMap(const SteerableViewMap &iBrother); virtual ~SteerableViewMap(); - /*! Resets everything */ + /** Resets everything */ virtual void Reset(); - /*! Adds a FEdge to steerable VM. + /** Adds a FEdge to steerable VM. * Returns the nbOrientations weights corresponding to the FEdge contributions to the * nbOrientations directional maps. */ double *AddFEdge(FEdge *iFEdge); - /*! Compute the weight of direction dir for orientation iNOrientation */ + /** Compute the weight of direction dir for orientation iNOrientation */ double ComputeWeight(const Vec2d &dir, unsigned iNOrientation); - /*! Returns the number of the SVM to which a direction belongs to. + /** Returns the number of the SVM to which a direction belongs to. * \param dir: * The direction */ unsigned getSVMNumber(Vec2f dir); - /*! Returns the number of the SVM to which a FEdge belongs most. + /** Returns the number of the SVM to which a FEdge belongs most. * \param id: * The First element of the Id struct of the FEdge we're interested in. */ unsigned getSVMNumber(unsigned id); - /*! Builds _nbOrientations+1 pyramids of images from the _nbOrientations+1 base images of the + /** Builds _nbOrientations+1 pyramids of images from the _nbOrientations+1 base images of the * steerable viewmap. * \param steerableBases: * The _nbOrientations+1 images constituting the basis for the steerable pyramid. @@ -105,7 +105,7 @@ class SteerableViewMap { unsigned iNbLevels = 4, float iSigma = 1.0f); - /*! Reads a pixel value in one of the VewMap density steerable pyramids. + /** Reads a pixel value in one of the VewMap density steerable pyramids. * Returns a value between 0 and 1. * \param iOrientation: * the number telling which orientation we need to check. @@ -126,23 +126,23 @@ class SteerableViewMap { */ float readSteerableViewMapPixel(unsigned iOrientation, int iLevel, int x, int y); - /*! Reads a pixel in the one of the level of the pyramid containing the images + /** Reads a pixel in the one of the level of the pyramid containing the images * of the complete ViewMap. * Returns a value between 0 and 1. * Equivalent to : readSteerableViewMapPixel(nbOrientations, x, y) */ float readCompleteViewMapPixel(int iLevel, int x, int y); - /*! Returns the number of levels in the pyramids */ + /** Returns the number of levels in the pyramids */ unsigned int getNumberOfPyramidLevels() const; - /*! Returns the number of orientations */ + /** Returns the number of orientations */ unsigned int getNumberOfOrientations() const { return _nbOrientations; } - /*! for debug purposes */ + /** for debug purposes */ void saveSteerableViewMap() const; protected: |