vtkVolumeContourSpectrumFilter.h 3.34 KB
Newer Older
1 2 3
/*=========================================================================

  Program:   Visualization Toolkit
4
  Module:    vtkVolumeContourSpectrumFilter.h
5 6 7 8 9 10 11 12 13 14

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/**
 * @class   vtkVolumeContourSpectrumFilter
 * @brief   compute an approximation of the
 * volume contour signature (evolution of the volume of the input tet-mesh
 * along an arc of the Reeb graph).
 *
 * The filter takes a vtkUnstructuredGrid as an input (port 0), along with a
 * vtkReebGraph (port 1).
 * The Reeb graph arc to consider can be specified with SetArcId() (default: 0).
 * The number of (evenly distributed) samples of the signature can be defined
 * with SetNumberOfSamples() (default value: 100).
 * The filter will first try to pull as a scalar field the vtkDataArray with Id
 * 'FieldId' of the vtkUnstructuredGrid, see SetFieldId (default: 0). The
 * filter will abort if this field does not exist.
 *
 * The filter outputs a vtkTable with the volume contour signature
 * approximation, each sample being evenly distributed in the function span of
 * the arc.
 *
 * This filter is a typical example for designing your own contour signature
 * filter (with customized metrics). It also shows typical vtkReebGraph
 * traversals.
 *
 * Reference:
 * C. Bajaj, V. Pascucci, D. Schikore,
 * "The contour spectrum",
 * IEEE Visualization, 167-174, 1997.
*/
43

44 45
#ifndef vtkVolumeContourSpectrumFilter_h
#define vtkVolumeContourSpectrumFilter_h
46

47
#include "vtkFiltersGeneralModule.h" // For export macro
48
#include  "vtkDataObjectAlgorithm.h"
49 50 51

class vtkReebGraph;
class vtkTable;
52

53
class VTKFILTERSGENERAL_EXPORT vtkVolumeContourSpectrumFilter :
54 55 56
  public vtkDataObjectAlgorithm
{
public:
57
  static vtkVolumeContourSpectrumFilter* New();
58
  vtkTypeMacro(vtkVolumeContourSpectrumFilter, vtkDataObjectAlgorithm);
59
  void PrintSelf(ostream& os, vtkIndent indent) override;
60

61 62 63 64 65
  //@{
  /**
   * Set the arc Id for which the contour signature has to be computed.
   * Default value: 0
   */
66 67
  vtkSetMacro(ArcId, vtkIdType);
  vtkGetMacro(ArcId, vtkIdType);
68
  //@}
69

70 71 72 73 74
  //@{
  /**
   * Set the number of samples in the output signature
   * Default value: 100
   */
75 76
  vtkSetMacro(NumberOfSamples, int);
  vtkGetMacro(NumberOfSamples, int);
77
  //@}
78

79 80 81 82 83
  //@{
  /**
   * Set the scalar field Id
   * Default value: 0
   */
84 85
  vtkSetMacro(FieldId, vtkIdType);
  vtkGetMacro(FieldId, vtkIdType);
86
  //@}
87 88 89 90

  vtkTable* GetOutput();

protected:
91
  vtkVolumeContourSpectrumFilter();
92
  ~vtkVolumeContourSpectrumFilter() override;
93 94 95 96

  vtkIdType ArcId, FieldId;
  int NumberOfSamples;

97 98
  int FillInputPortInformation(int portNumber, vtkInformation *) override;
  int FillOutputPortInformation(int portNumber, vtkInformation *info) override;
99 100

  int RequestData(vtkInformation *request,
101
    vtkInformationVector **inputVector, vtkInformationVector *outputVector) override;
102 103

private:
104 105
  vtkVolumeContourSpectrumFilter(const vtkVolumeContourSpectrumFilter&) = delete;
  void operator=(const vtkVolumeContourSpectrumFilter&) = delete;
106 107 108
};

#endif