vtkOrderStatistics.h

Go to the documentation of this file.

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

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

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

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

  int GetMaximumNumberOfColumnsPerRequest() const override { return 1; }

  enum QuantileDefinitionType
  {
    InverseCDF = 0,              // Identical to method 1 of R
    InverseCDFAveragedSteps = 1, // Identical to method 2 of R, ignored for non-numeric types
    NearestObservation = 2       // Identical to method 3 of R
  };


  vtkSetMacro(NumberOfIntervals, vtkIdType);
  vtkGetMacro(NumberOfIntervals, vtkIdType);


  vtkSetMacro(QuantileDefinition, QuantileDefinitionType);
  void SetQuantileDefinition(int);


  vtkSetMacro(Quantize, bool);
  vtkGetMacro(Quantize, bool);


  vtkSetMacro(MaximumHistogramSize, vtkIdType);
  vtkGetMacro(MaximumHistogramSize, vtkIdType);

  vtkIdType GetQuantileDefinition() { return static_cast<vtkIdType>(this->QuantileDefinition); }

  bool SetParameter(const char* parameter, int index, vtkVariant value) override;

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

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

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

protected:
  vtkOrderStatistics();
  ~vtkOrderStatistics() override;

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

  void Derive(vtkStatisticalModel*) override;

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

  void Assess(vtkTable* inData, vtkStatisticalModel* inMeta, vtkTable* outData) override
  {
    this->Superclass::Assess(inData, inMeta, outData, 1);
  }

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

  vtkIdType NumberOfIntervals;
  QuantileDefinitionType QuantileDefinition;
  bool Quantize;
  vtkIdType MaximumHistogramSize;

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

VTK_ABI_NAMESPACE_END
#endif