vtkDescriptiveStatistics.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 vtkDescriptiveStatistics_h
#define vtkDescriptiveStatistics_h
 
#include "vtkDeprecation.h"             // For VTK_DEPRECATED_IN_9_2_0
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkStatisticsAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkMultiBlockDataSet;
class vtkStringArray;
class vtkTable;
class vtkVariant;
class vtkDoubleArray;
 
class VTKFILTERSSTATISTICS_EXPORT vtkDescriptiveStatistics : public vtkStatisticsAlgorithm
{
public:
  vtkTypeMacro(vtkDescriptiveStatistics, vtkStatisticsAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkDescriptiveStatistics* New();
 
 
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void SetUnbiasedVariance(vtkTypeBool);
  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
  virtual vtkTypeBool GetUnbiasedVariance();
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void UnbiasedVarianceOn();
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void UnbiasedVarianceOff();
 
 
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void SetG1Skewness(vtkTypeBool);
  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
  virtual vtkTypeBool GetG1Skewness();
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void G1SkewnessOn();
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void G1SkewnessOff();
 
 
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void SetG2Kurtosis(vtkTypeBool);
  VTK_DEPRECATED_IN_9_2_0("Please use GetSampleEstimate instead")
  virtual vtkTypeBool GetG2Kurtosis();
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void G2KurtosisOn();
  VTK_DEPRECATED_IN_9_2_0("Please use SetSampleEstimate instead")
  virtual void G2KurtosisOff();
 
 
  vtkSetMacro(SampleEstimate, bool);
  vtkGetMacro(SampleEstimate, bool);
  vtkBooleanMacro(SampleEstimate, bool);
 
 
  vtkSetMacro(SignedDeviations, vtkTypeBool);
  vtkGetMacro(SignedDeviations, vtkTypeBool);
  vtkBooleanMacro(SignedDeviations, vtkTypeBool);
 
 
  vtkSetMacro(GhostsToSkip, unsigned char);
  vtkGetMacro(GhostsToSkip, unsigned char);
 
  void Aggregate(vtkDataObjectCollection*, vtkMultiBlockDataSet*) override;
 
protected:
  vtkDescriptiveStatistics();
  ~vtkDescriptiveStatistics() 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);
  }
 
  virtual vtkDoubleArray* CalculatePValues(vtkDoubleArray*);
 
  void SelectAssessFunctor(vtkTable* outData, vtkDataObject* inMeta, vtkStringArray* rowNames,
    AssessFunctor*& dfunc) override;
 
  bool SampleEstimate;
  vtkTypeBool SignedDeviations;
  unsigned char GhostsToSkip;
 
private:
  vtkDescriptiveStatistics(const vtkDescriptiveStatistics&) = delete;
  void operator=(const vtkDescriptiveStatistics&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif