Commit 6a7e5148 authored by David E. DeMarle's avatar David E. DeMarle

replace VTK's nonstandard Doxygen with standard markup

generated via:
cd $VTKSRC
perl Utilities/Doxygen/doc_header2doxygen.pl --to ~/tmp/vtkheaders .
cp -r ~/tmp/vtkheaders/* .
parent fbbd73c0

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.

......@@ -12,14 +12,17 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkDataSetToPiston - converts a DataSet to a PistonDataObject
// .SECTION Description
// Converts vtkDataSets that reside on the CPU into piston data that
// resides on the GPU. Afterward vtkPistonAlgorithms will processed
// it there.
//
// .SECTION See Also
// vtkPistonToDataSet
/**
* @class vtkDataSetToPiston
* @brief converts a DataSet to a PistonDataObject
*
* Converts vtkDataSets that reside on the CPU into piston data that
* resides on the GPU. Afterward vtkPistonAlgorithms will processed
* it there.
*
* @sa
* vtkPistonToDataSet
*/
#ifndef vtkDataSetToPiston_h
#define vtkDataSetToPiston_h
......@@ -39,14 +42,16 @@ protected:
vtkDataSetToPiston();
~vtkDataSetToPiston();
// Description:
// Method that does the actual calculation. Funnels down to ExecuteData.
/**
* Method that does the actual calculation. Funnels down to ExecuteData.
*/
virtual int RequestData(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Overridden to say that we require vtkDataSet inputs
/**
* Overridden to say that we require vtkDataSet inputs
*/
virtual int FillInputPortInformation(int, vtkInformation*);
private:
......
......@@ -12,23 +12,26 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonAlgorithm - Superclass for algorithms that produce only
// PistonDataObjects
// .SECTION Description
// vtkPistonAlgorithm is a convenience class to make writing algorithms
// that operate in piston space easer. Basically one does that by subclassing
// this class and overriding Execute() to call into a method that calls into
// an external function compiled with the cuda compiler.
//
// There are some assumptions and defaults made by this
// class you should be aware of. This class defaults such that your filter
// will have one input port and one output port. If that is not the case
// simply change it with SetNumberOfInputPorts etc. See this class
// constructor for the default. This class also provides a FillInputPortInfo
// method that by default says that all inputs will be PistonDataObject. If that
// isn't the case then please override this method in your subclass. This
// class breaks out the downstream requests into separate functions such as
// ExecuteData and ExecuteInformation.
/**
* @class vtkPistonAlgorithm
* @brief Superclass for algorithms that produce only
* PistonDataObjects
*
* vtkPistonAlgorithm is a convenience class to make writing algorithms
* that operate in piston space easer. Basically one does that by subclassing
* this class and overriding Execute() to call into a method that calls into
* an external function compiled with the cuda compiler.
*
* There are some assumptions and defaults made by this
* class you should be aware of. This class defaults such that your filter
* will have one input port and one output port. If that is not the case
* simply change it with SetNumberOfInputPorts etc. See this class
* constructor for the default. This class also provides a FillInputPortInfo
* method that by default says that all inputs will be PistonDataObject. If that
* isn't the case then please override this method in your subclass. This
* class breaks out the downstream requests into separate functions such as
* ExecuteData and ExecuteInformation.
*/
#ifndef vtkPistonAlgorithm_h
#define vtkPistonAlgorithm_h
......@@ -45,62 +48,75 @@ public:
vtkTypeMacro(vtkPistonAlgorithm,vtkAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Interface the algorithm to the Pipeline's passes.
/**
* Interface the algorithm to the Pipeline's passes.
*/
virtual int ProcessRequest(vtkInformation*,
vtkInformationVector**,
vtkInformationVector*);
// Description:
// A convenience method to reduce code duplication that gets
// the output as the expected type or NULL.
/**
* A convenience method to reduce code duplication that gets
* the output as the expected type or NULL.
*/
vtkPistonDataObject *GetPistonDataObjectOutput(int port);
// Description:
// Assign a data object as input. Note that this method does not
// establish a pipeline connection. Use SetInputConnection() to
// setup a pipeline connection.
//@{
/**
* Assign a data object as input. Note that this method does not
* establish a pipeline connection. Use SetInputConnection() to
* setup a pipeline connection.
*/
void SetInputData(int num, vtkDataObject *input);
void SetInputData(vtkDataObject *input) { this->SetInputData(0, input); };
//@}
protected:
vtkPistonAlgorithm();
~vtkPistonAlgorithm();
// Description:
// Overridden to say that we take in and produce vtkPistonDataObjects
//@{
/**
* Overridden to say that we take in and produce vtkPistonDataObjects
*/
virtual int FillInputPortInformation(int port, vtkInformation* info);
virtual int FillOutputPortInformation(int port, vtkInformation* info);
//@}
// Description:
// Produce empty output of the proper type for RequestData to fill in.
/**
* Produce empty output of the proper type for RequestData to fill in.
*/
virtual int RequestDataObject(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Produce meta-data about what RequestData will produce.
/**
* Produce meta-data about what RequestData will produce.
*/
virtual int RequestInformation(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Participate in pipeline's sub extent determination.
/**
* Participate in pipeline's sub extent determination.
*/
virtual int RequestUpdateExtent(vtkInformation*,
vtkInformationVector**,
vtkInformationVector*);
// Description:
// Method that does the actual calculation.
/**
* Method that does the actual calculation.
*/
virtual int RequestData(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Typically Execute uses this to copy input bounds to output.
// Algorithms for which this heuristic is poor, should override and
// do it exactly, perhaps by asking the GPU to calculate it,
/**
* Typically Execute uses this to copy input bounds to output.
* Algorithms for which this heuristic is poor, should override and
* do it exactly, perhaps by asking the GPU to calculate it,
*/
virtual void PassBoundsForward(vtkPistonDataObject *id,
vtkPistonDataObject *od);
......
......@@ -12,9 +12,12 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonContour - A filter that contours on the GPU
// .SECTION Description
// This filter uses LANL's Piston library to isocontour on the GPU.
/**
* @class vtkPistonContour
* @brief A filter that contours on the GPU
*
* This filter uses LANL's Piston library to isocontour on the GPU.
*/
#ifndef vtkPistonContour_h
#define vtkPistonContour_h
......@@ -28,16 +31,20 @@ public:
static vtkPistonContour *New();
void PrintSelf(ostream &os, vtkIndent indent);
//Description:
//Choose the isovalue to contour on.
//@{
/**
* Choose the isovalue to contour on.
*/
vtkSetMacro(IsoValue, float);
vtkGetMacro(IsoValue, float);
protected:
vtkPistonContour();
~vtkPistonContour();
//@}
// Description:
// Method that does the actual calculation. Funnels down to ExecuteData.
/**
* Method that does the actual calculation. Funnels down to ExecuteData.
*/
virtual int RequestData(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
......
......@@ -12,18 +12,21 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonDataObject - A GPU resident data set.
//
// .SECTION Description
// vtkPistonDataObject is a basic data structure for storing datasets on
// GPU. This class provides the infrastructure for the VTK pipeline to
// work with the data as it does the rest of the vtkDataObjects.
// The GPU side structures are managed through the internal
// vtkPistonReference instance to keep the GPU/CPU code conceptually
// distinct.
//
// .SECTION See Also
// vtkPistonReference
/**
* @class vtkPistonDataObject
* @brief A GPU resident data set.
*
*
* vtkPistonDataObject is a basic data structure for storing datasets on
* GPU. This class provides the infrastructure for the VTK pipeline to
* work with the data as it does the rest of the vtkDataObjects.
* The GPU side structures are managed through the internal
* vtkPistonReference instance to keep the GPU/CPU code conceptually
* distinct.
*
* @sa