vtkProbeFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkProbeFilter.h

  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.

=========================================================================*/
#ifndef vtkProbeFilter_h
#define vtkProbeFilter_h

#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkDataSetAlgorithm.h"
#include "vtkDataSetAttributes.h" // needed for vtkDataSetAttributes::FieldList

class vtkIdTypeArray;
class vtkCharArray;
class vtkMaskPoints;
class vtkImageData;

class VTKFILTERSCORE_EXPORT vtkProbeFilter : public vtkDataSetAlgorithm
{
public:
  static vtkProbeFilter *New();
  vtkTypeMacro(vtkProbeFilter,vtkDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;


  void SetSourceData(vtkDataObject *source);
  vtkDataObject *GetSource();

  void SetSourceConnection(vtkAlgorithmOutput* algOutput);


  vtkSetMacro(SpatialMatch, int);
  vtkGetMacro(SpatialMatch, int);
  vtkBooleanMacro(SpatialMatch, int);


  vtkGetObjectMacro(ValidPoints, vtkIdTypeArray);


  vtkSetStringMacro(ValidPointMaskArrayName)
  vtkGetStringMacro(ValidPointMaskArrayName)


  vtkSetMacro(PassCellArrays, int);
  vtkBooleanMacro(PassCellArrays, int);
  vtkGetMacro(PassCellArrays, int);


  vtkSetMacro(PassPointArrays, int);
  vtkBooleanMacro(PassPointArrays, int);
  vtkGetMacro(PassPointArrays, int);



  vtkSetMacro(PassFieldArrays, int);
  vtkBooleanMacro(PassFieldArrays, int);
  vtkGetMacro(PassFieldArrays, int);


  vtkSetMacro(Tolerance, double);
  vtkGetMacro(Tolerance, double);


  vtkSetMacro(ComputeTolerance, bool);
  vtkBooleanMacro(ComputeTolerance, bool);
  vtkGetMacro(ComputeTolerance, bool);

protected:
  vtkProbeFilter();
  ~vtkProbeFilter() VTK_OVERRIDE;

  int PassCellArrays;
  int PassPointArrays;
  int PassFieldArrays;

  int SpatialMatch;

  double Tolerance;
  bool ComputeTolerance;

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

  void PassAttributeData(
    vtkDataSet* input, vtkDataObject* source, vtkDataSet* output);

  void Probe(vtkDataSet *input, vtkDataSet *source, vtkDataSet *output);

  void BuildFieldList(vtkDataSet* source);

  virtual void InitializeForProbing(vtkDataSet *input, vtkDataSet *output);

  void DoProbing(vtkDataSet *input, int srcIdx, vtkDataSet *source,
                 vtkDataSet *output);

  char* ValidPointMaskArrayName;
  vtkIdTypeArray *ValidPoints;
  vtkCharArray* MaskPoints;
  int NumberOfValidPoints;

  // Agreed, this is sort of a hack to allow subclasses to override the default
  // behavior of this filter to call NullPoint() for every point that is
  // not-a-hit when probing. This makes it possible for subclasses to initialize
  // the arrays with different defaults.
  bool UseNullPoint;

  vtkDataSetAttributes::FieldList* CellList;
  vtkDataSetAttributes::FieldList* PointList;
private:
  vtkProbeFilter(const vtkProbeFilter&) VTK_DELETE_FUNCTION;
  void operator=(const vtkProbeFilter&) VTK_DELETE_FUNCTION;

  // Probe only those points that are marked as not-probed by the MaskPoints
  // array.
  void ProbeEmptyPoints(vtkDataSet *input, int srcIdx, vtkDataSet *source,
    vtkDataSet *output);
  // A faster implementation for vtkImageData input.
  void ProbePointsImageData(vtkImageData *input, int srcIdx, vtkDataSet *source,
    vtkImageData *output);

  class vtkVectorOfArrays;
  vtkVectorOfArrays* CellArrays;

};

#endif