vtkOrderStatistics.h

Go to the documentation of this file.

/*=========================================================================
 
Program:   Visualization Toolkit
Module:    vtkOrderStatistics.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.
 
=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2011 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
  -------------------------------------------------------------------------*/
#ifndef vtkOrderStatistics_h
#define vtkOrderStatistics_h
 
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkStatisticsAlgorithm.h"
 
class vtkMultiBlockDataSet;
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();
 
  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;
 
  void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override { return; }
 
protected:
  vtkOrderStatistics();
  ~vtkOrderStatistics() override;
 
  void Learn(vtkTable*, vtkTable*, vtkMultiBlockDataSet*) override;
 
  void Derive(vtkMultiBlockDataSet*) override;
 
  void Test(vtkTable*, vtkMultiBlockDataSet*, vtkTable*) override;
 
  void Assess(vtkTable* inData, vtkMultiBlockDataSet* 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;
};
 
#endif