vtkVisItProbeFilter.h 3.95 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 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
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkVisItProbeFilter.h,v $

  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.

=========================================================================*/
// .NAME vtkVisItProbeFilter - sample data values at specified point locations
// .SECTION Description
// vtkVisItProbeFilter is a filter that computes point attributes (e.g., scalars,
// vectors, etc.) at specified point positions. The filter has two inputs:
// the Input and Source. The Input geometric structure is passed through the
// filter. The point attributes are computed at the Input point positions
// by interpolating into the source data. For example, we can compute data
// values on a plane (plane specified as Input) from a volume (Source).
//
// This filter can be used to resample data, or convert one dataset form into
// another. For example, an unstructured grid (vtkUnstructuredGrid) can be
// probed with a volume (three-dimensional vtkImageData), and then volume
// rendering techniques can be used to visualize the results. Another example:
// a line or curve can be used to probe data to produce x-y plots along
// that line or curve.

#ifndef __vtkVisItProbeFilter_h
#define __vtkVisItProbeFilter_h

#include <vtkDataSetAlgorithm.h>
#include <visit_vtk_exports.h>

class vtkIdTypeArray;

class VISIT_VTK_API vtkVisItProbeFilter : public vtkDataSetAlgorithm
{
public:
  static vtkVisItProbeFilter *New();
43
  vtkTypeMacro(vtkVisItProbeFilter,vtkDataSetAlgorithm);
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Specify the point locations used to probe input. Any geometry
  // can be used.
  void SetSource(vtkDataSet *source);
  vtkDataSet *GetSource();

  // Description:
  // This flag is used only when a piece is requested to update.  By default
  // the flag is off.  Because no spatial correspondence between input pieces
  // and source pieces is known, all of the source has to be requested no
  // matter what piece of the output is requested.  When there is a spatial 
  // correspondence, the user/application can set this flag.  This hint allows
  // the breakup of the probe operation to be much more efficient.  When piece
  // m of n is requested for update by the user, then only n of m needs to
  // be requested of the source. 
bonnell's avatar
bonnell committed
61 62 63
  vtkSetMacro(SpatialMatch, bool);
  vtkGetMacro(SpatialMatch, bool);
  vtkBooleanMacro(SpatialMatch, bool);
64 65 66 67 68 69 70 71 72 73

  // Description:
  // Get the list of point ids in the output that contain attribute data
  // interpolated from the source.
  vtkGetObjectMacro(ValidPoints, vtkIdTypeArray);

  // Description:
  // Added by KSB, LLNL, 03-28-2008
  // This flag is used to indicate that cell data is being probed.
  // They are handled differently than point data.
bonnell's avatar
bonnell committed
74 75 76
  vtkSetMacro(CellData, bool);
  vtkGetMacro(CellData, bool);
  vtkBooleanMacro(CellData, bool);
77 78 79 80 81
  
protected:
  vtkVisItProbeFilter();
  ~vtkVisItProbeFilter();

bonnell's avatar
bonnell committed
82 83
  bool SpatialMatch;
  bool CellData;
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102

  virtual int RequestData(vtkInformation *, 
                          vtkInformationVector **, 
                          vtkInformationVector *);
  virtual int RequestInformation(vtkInformation *, 
                                 vtkInformationVector **, 
                                 vtkInformationVector *);
  virtual int RequestUpdateExtent(vtkInformation *, 
                                  vtkInformationVector **, 
                                  vtkInformationVector *);

  vtkIdTypeArray *ValidPoints;
private:
  vtkVisItProbeFilter(const vtkVisItProbeFilter&);  // Not implemented.
  void operator=(const vtkVisItProbeFilter&);  // Not implemented.

};

#endif