vtkPairwiseExtractHistogram2D.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2009 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkPairwiseExtractHistogram2D_h
#define vtkPairwiseExtractHistogram2D_h

#include "vtkFiltersImagingModule.h" // For export macro
#include "vtkSmartPointer.h"         //needed for smart pointer ivars
#include "vtkStatisticsAlgorithm.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkCollection;
class vtkExtractHistogram2D;
class vtkImageData;
class vtkIdTypeArray;

class VTKFILTERSIMAGING_EXPORT vtkPairwiseExtractHistogram2D : public vtkStatisticsAlgorithm
{
public:
  static vtkPairwiseExtractHistogram2D* New();
  vtkTypeMacro(vtkPairwiseExtractHistogram2D, vtkStatisticsAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  int GetMaximumNumberOfColumnsPerRequest() const override { return 2; }


  vtkSetVector2Macro(NumberOfBins, int);
  vtkGetVector2Macro(NumberOfBins, int);


  vtkSetMacro(CustomColumnRangeIndex, int);
  void SetCustomColumnRangeByIndex(double, double);


  void SetCustomColumnRange(int col, double range[2]);
  void SetCustomColumnRange(int col, double rmin, double rmax);


  vtkSetMacro(ScalarType, int);
  void SetScalarTypeToUnsignedInt() { this->SetScalarType(VTK_UNSIGNED_INT); }
  void SetScalarTypeToUnsignedLong() { this->SetScalarType(VTK_UNSIGNED_LONG); }
  void SetScalarTypeToUnsignedShort() { this->SetScalarType(VTK_UNSIGNED_SHORT); }
  void SetScalarTypeToUnsignedChar() { this->SetScalarType(VTK_UNSIGNED_CHAR); }
  vtkGetMacro(ScalarType, int);

  double GetMaximumBinCount(int idx);

  double GetMaximumBinCount();

  int GetBinRange(int idx, vtkIdType binX, vtkIdType binY, double range[4]);

  int GetBinRange(int idx, vtkIdType bin, double range[4]);

  void GetBinWidth(int idx, double bw[2]);

  double* GetHistogramExtents(int idx);

  vtkImageData* GetOutputHistogramImage(int idx);

  vtkExtractHistogram2D* GetHistogramFilter(int idx);

  enum OutputIndices
  {
    HISTOGRAM_IMAGE = 3
  };

  bool Aggregate(vtkDataObjectCollection*, vtkStatisticalModel*) override { return false; }

protected:
  vtkPairwiseExtractHistogram2D();
  ~vtkPairwiseExtractHistogram2D() override;

  int NumberOfBins[2];
  int ScalarType;
  int CustomColumnRangeIndex;

  vtkSmartPointer<vtkIdTypeArray> OutputOutlierIds;
  vtkSmartPointer<vtkCollection> HistogramFilters;
  class Internals;
  Internals* Implementation;

  void Learn(vtkTable* inData, vtkTable* inParameters, vtkStatisticalModel* outMeta) override;

  void Derive(vtkStatisticalModel*) override {}

  void Assess(vtkTable*, vtkStatisticalModel*, vtkTable*) override {}

  void Test(vtkTable*, vtkStatisticalModel*, vtkTable*) override {}

  void SelectAssessFunctor(vtkTable* vtkNotUsed(outData), vtkDataObject* vtkNotUsed(inMeta),
    vtkStringArray* vtkNotUsed(rowNames), AssessFunctor*& vtkNotUsed(dfunc)) override
  {
  }

  virtual vtkExtractHistogram2D* NewHistogramFilter();

  int FillOutputPortInformation(int port, vtkInformation* info) override;

  vtkTimeStamp BuildTime;

private:
  vtkPairwiseExtractHistogram2D(const vtkPairwiseExtractHistogram2D&) = delete;
  void operator=(const vtkPairwiseExtractHistogram2D&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif