Commit 88b5f9da authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum

[DOC] - module doc fixed

parent 78db8a1d
......@@ -223,6 +223,8 @@ public:
* Allocate shared memory and construct and run threads, construct output datasets.
*
* \tparam T The integral type of values in the valueset.
*
* \return result value
*/
template< typename T >
result_type operator() ( WValueSet< T > const* /* vs */ ) const;
......
......@@ -174,6 +174,8 @@ public:
/**
* Returns the average error of the thread.
*
* \return error measure
*/
double getError() const;
......
......@@ -131,7 +131,7 @@ private:
* \param grid The grid, which is not used in this function.
*/
void copyData( boost::shared_ptr< std::vector< double > >& smoothed, // NOLINT non-const ref
boost::shared_ptr< WGridRegular3D > const& /* grid */ );
boost::shared_ptr< WGridRegular3D > const& grid );
/**
* Calculates an array containing the derivations in x, y and z directions of the image
......
......@@ -118,6 +118,8 @@ private:
/**
* helper function to load and parse a tree file, the tree is stored in the member variable m_tree
* \param fileName
*
* \return true if successful.
*/
bool loadTreeAscii( std::string fileName );
......
......@@ -173,6 +173,8 @@ private:
/**
* handles mouse clicks into the dendrogram
*
* \return true if handled
*/
bool widgetClicked();
......
......@@ -118,11 +118,15 @@ class WMCoordinateHUD: public WModule, public osg::Referenced
/**
* build the geometry of the cube
*
* \return the cube vertices
*/
virtual osg::Vec3Array* buildCubeVertices();
/**
* build the geometry of the axis
*
* \return the axis vertices
*/
virtual osg::Vec3Array* buildAxisVertices();
......
......@@ -74,6 +74,8 @@ public:
/**
* Transforms world coordinates.
* \param point The point which will be transformed.
*
* \return the transformed world coordinate
*/
WVector3d worldCoordTransformed( WPosition point );
......
......@@ -93,6 +93,8 @@ private:
* \param dataArray data to copy
* \param countVoxels number of voxels stored in dataArray
* \param vDim number of values per voxel
*
* \return the copy
*/
template < typename T > boost::shared_ptr< std::vector< T > > copyArray( const T* dataArray, const size_t countVoxels, const size_t vDim );
......@@ -100,6 +102,8 @@ private:
* This function converts a 4x4 matrix from the NIfTI libs into the format
* used by OpenWalnut.
* \param in this matrix will be converted.
*
* \return the new matrix
*/
WMatrix< double > convertMatrix( const mat44& in );
......
......@@ -124,12 +124,11 @@ private:
/**
* Types of local illumination supported.
*/
enum
enum LOCALILLUMINATION_ALGORITHMS
{
None = 0,
Phong
}
LOCALILLUMINATION_ALGORITHMS;
};
/**
* The available shading algorithms.
......
......@@ -122,13 +122,18 @@ private:
* Take from FiberNavigator.
* \param dataSet the data set that is used to compute the distance field.
* The distance is computed to the boundary between foreground an background
*
* \return the distance map values
*/
boost::shared_ptr< WValueSet< float > > createOffset( boost::shared_ptr< const WDataSetScalar > dataSet );
/**
* Gauss function.
*
* \param x position of evaluation
* \param sigma standard deviation
*
* \return Gauss value for given parameters
*/
double xxgauss( double x, double sigma );
};
......
......@@ -130,6 +130,8 @@ private:
* \param y index for x direction
* \param z index for x direction
* \param offset the offset to add to the index (useful for addressing vector/tensor elements)
*
* \return the filtered value for a given position
*/
template< typename T > double filterAtPosition( boost::shared_ptr< WValueSet< T > > vals,
size_t nX, size_t nY, size_t nZ, size_t x, size_t y, size_t z, size_t offset );
......
......@@ -126,6 +126,8 @@ private:
/**
* Initial creation function for the slice geometry
*
* \return the geometry
*/
osg::ref_ptr< osg::Geometry > createGeometry();
......
......@@ -77,6 +77,8 @@ public:
/**
* Get the icon for this module in XPM format.
*
* \return xpm pointer
*/
virtual const char** getXPMIcon() const;
......
......@@ -81,6 +81,8 @@ public:
/**
* Get the icon for this module in XPM format.
*
* \return icon pointer
*/
virtual const char** getXPMIcon() const;
......
......@@ -221,6 +221,8 @@ private:
/**
* Get the geode of the computed glyphs.
*
* \return geode
*/
osg::ref_ptr< osg::Geode > getGraphics();
private:
......
......@@ -130,7 +130,7 @@ private:
double getMedian( double x, double y, double z ) const;
/**
* Calculates the center point of an given interval. This simply is $$x_{min} + \frac{x_{max} - x_{min}}{2}$$.
* Calculates the center point of an given interval. This simply is \f$x_{min} + \frac{x_{max} - x_{min}}{2}\f$.
*
* \param min interval min
* \param max interval max
......
......@@ -113,6 +113,8 @@ protected:
private:
/**
* creates a vector plot on the currently selected slices
*
* \return geometry containing the slices
*/
osg::ref_ptr<osg::Geometry> buildPlotSlices();
......
......@@ -110,15 +110,18 @@ protected:
private:
/**
* Store the mesh in legacy vtk file format.
*
* \return true if successful.
*/
bool saveVTKASCII() const;
/**
* Store the mesh in a json (javascript object notation) file
* Store the mesh in a json (javascript object notation) file.
*
* \return true if successful.
*/
bool saveJson() const;
boost::shared_ptr< WModuleInputData< WTriangleMesh > > m_meshInput; //!< Input connector for a mesh
boost::shared_ptr< WTriangleMesh > m_triMesh; //!< A pointer to the currently processed tri mesh
......@@ -137,6 +140,9 @@ private:
*/
WPropSelection m_fileTypeSelection;
/**
* If true, colors get exported too.
*/
WPropBool m_writeColors;
};
......
......@@ -99,17 +99,23 @@ protected:
private:
/**
* Store the mesh in a json (javascript object notation) file
*
* \return true if successful
*/
bool saveJson() const;
/**
* Store the mesh in a json (javascript object notation) file
* using only every other vertex
*
* \return true if successful
*/
bool saveJson2() const;
/**
* Store the mesh in a json (javascript object notation) file
*
* \return true if successful
*/
bool saveJsonTriangles() const;
......
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