vtkDescriptiveStatistics.h

Go to the documentation of this file.

/*=========================================================================

Program:   Visualization Toolkit
Module:    vtkDescriptiveStatistics.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 2010 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
  -------------------------------------------------------------------------*/
#ifndef vtkDescriptiveStatistics_h
#define vtkDescriptiveStatistics_h

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

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();


  vtkSetMacro(UnbiasedVariance,vtkTypeBool);
  vtkGetMacro(UnbiasedVariance,vtkTypeBool);
  vtkBooleanMacro(UnbiasedVariance,vtkTypeBool);


  vtkSetMacro(G1Skewness,vtkTypeBool);
  vtkGetMacro(G1Skewness,vtkTypeBool);
  vtkBooleanMacro(G1Skewness,vtkTypeBool);


  vtkSetMacro(G2Kurtosis,vtkTypeBool);
  vtkGetMacro(G2Kurtosis,vtkTypeBool);
  vtkBooleanMacro(G2Kurtosis,vtkTypeBool);


  vtkSetMacro(SignedDeviations,vtkTypeBool);
  vtkGetMacro(SignedDeviations,vtkTypeBool);
  vtkBooleanMacro(SignedDeviations,vtkTypeBool);

  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;

  vtkTypeBool UnbiasedVariance;
  vtkTypeBool G1Skewness;
  vtkTypeBool G2Kurtosis;
  vtkTypeBool SignedDeviations;

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

#endif