vtkVisualStatistics.h

Go to the documentation of this file.

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

#include "vtkDescriptiveStatistics.h"
#include "vtkFiltersStatisticsModule.h" // For export macro

VTK_ABI_NAMESPACE_BEGIN
class vtkStatisticalModel;
class vtkStringArray;
class vtkTable;
class vtkVariant;
class vtkDoubleArray;

class VTKFILTERSSTATISTICS_EXPORT vtkVisualStatistics : public vtkDescriptiveStatistics
{
public:
  vtkTypeMacro(vtkVisualStatistics, vtkDescriptiveStatistics);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkVisualStatistics* New();

  virtual void SetFieldRange(const char* field, double lo, double hi);
  virtual void SetFieldRange(const std::string& field, double lo, double hi);

  virtual void ResetFieldRanges() { this->FieldRanges.clear(); }

  vtkSetClampMacro(NumberOfBins, int, 1, VTK_INT_MAX - 3);
  vtkGetMacro(NumberOfBins, int);

  vtkDataArray* GetHistogramForField(const std::string& fieldName);

  void AppendAlgorithmParameters(std::string& algorithmParameters) const override;

  std::size_t ConsumeNextAlgorithmParameter(
    vtkStringToken parameterName, const std::string& algorithmParameters) override;

protected:
  vtkVisualStatistics();
  ~vtkVisualStatistics() override;

  void Learn(vtkTable*, vtkTable*, vtkStatisticalModel*) override;

  void Derive(vtkStatisticalModel*) override;

  bool Aggregate(vtkDataObjectCollection*, vtkStatisticalModel*) override;

private:
  std::map<std::string, std::pair<double, double>> FieldRanges;
  int NumberOfBins{ 512 };

  vtkVisualStatistics(const vtkVisualStatistics&) = delete;
  void operator=(const vtkVisualStatistics&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif