vtkProbeFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkProbeFilter_h
#define vtkProbeFilter_h

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

#include <vector> // For std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractCellLocator;
class vtkCharArray;
class vtkGenericCell;
class vtkIdTypeArray;
class vtkImageData;
class vtkPointData;
class vtkFindCellStrategy;

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


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

  void SetSourceConnection(vtkAlgorithmOutput* algOutput);


  vtkSetMacro(CategoricalData, vtkTypeBool);
  vtkGetMacro(CategoricalData, vtkTypeBool);
  vtkBooleanMacro(CategoricalData, vtkTypeBool);


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


  vtkIdTypeArray* GetValidPoints();


  vtkSetStringMacro(ValidPointMaskArrayName);
  vtkGetStringMacro(ValidPointMaskArrayName);


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


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


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


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


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


  vtkSetMacro(SnappingRadius, double);
  vtkGetMacro(SnappingRadius, double);


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


  VTK_DEPRECATED_IN_9_7_0("Use SetCellLocator() instead.")
  virtual void SetFindCellStrategy(vtkFindCellStrategy*);
  VTK_DEPRECATED_IN_9_7_0(
    "GetFindCellStrategy() always returns nullptr. Use GetCellLocator() instead.")
  vtkFindCellStrategy* GetFindCellStrategy() { return nullptr; }


  virtual void SetCellLocator(vtkAbstractCellLocator*);
  vtkGetObjectMacro(CellLocator, vtkAbstractCellLocator);


  VTK_DEPRECATED_IN_9_7_0("Use SetCellLocator() instead.")
  virtual void SetCellLocatorPrototype(vtkAbstractCellLocator* cellLocator)
  {
    this->SetCellLocator(cellLocator);
  }
  VTK_DEPRECATED_IN_9_7_0("Use GetCellLocator() instead.")
  virtual vtkAbstractCellLocator* GetCellLocatorPrototype() { return this->GetCellLocator(); }

protected:
  vtkProbeFilter();
  ~vtkProbeFilter() override;

  void ReportReferences(vtkGarbageCollector*) override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) 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);
  virtual void InitializeSourceArrays(vtkDataSet* source);
  virtual void InitializeOutputArrays(vtkPointData* outPD, vtkIdType numPts);

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

  vtkTypeBool CategoricalData;

  vtkTypeBool PassCellArrays;
  vtkTypeBool PassPointArrays;
  vtkTypeBool PassFieldArrays;

  vtkTypeBool SpatialMatch;

  double Tolerance;
  bool ComputeTolerance;

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

  // support the FindCell() operation for vtkPointSet
  vtkAbstractCellLocator* CellLocator;

  vtkDataSetAttributes::FieldList* CellList;
  vtkDataSetAttributes::FieldList* PointList;

private:
  vtkProbeFilter(const vtkProbeFilter&) = delete;
  void operator=(const vtkProbeFilter&) = delete;

  // 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);
  void ProbeImagePointsInCell(vtkGenericCell* cell, vtkIdType cellId, vtkDataSet* source,
    int srcBlockId, vtkImageData* input, vtkPointData* outPD, char* maskArray, double* wtsBuff);

  class ProbeImageDataWorklet;

  // A faster implementation for vtkImageData source.
  void ProbeImageDataPoints(
    vtkDataSet* input, int srcIdx, vtkImageData* sourceImage, vtkDataSet* output);
  void ProbeImageDataPointsSMP(vtkDataSet* input, vtkImageData* source, int srcIdx,
    vtkPointData* outPD, char* maskArray, vtkIdList* pointIds, vtkIdType startId, vtkIdType endId,
    bool baseThread);

  class ProbeImageDataPointsWorklet;

  class ProbeEmptyPointsWorklet;

  std::vector<vtkDataArray*> InputCellArrays;
  std::vector<vtkDataArray*> SourceCellArrays;

  bool SnapToCellWithClosestPoint;
  double SnappingRadius;
};

VTK_ABI_NAMESPACE_END
#endif