vtkStatisticsAlgorithm.h

Go to the documentation of this file.

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

Program:   Visualization Toolkit
Module:    vtkStatisticsAlgorithm.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 vtkStatisticsAlgorithm_h
#define vtkStatisticsAlgorithm_h

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

class vtkDataObjectCollection;
class vtkMultiBlockDataSet;
class vtkStdString;
class vtkStringArray;
class vtkVariant;
class vtkVariantArray;
class vtkDoubleArray;
class vtkStatisticsAlgorithmPrivate;

class VTKFILTERSSTATISTICS_EXPORT vtkStatisticsAlgorithm : public vtkTableAlgorithm
{
public:
  vtkTypeMacro(vtkStatisticsAlgorithm, vtkTableAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum InputPorts
  {
    INPUT_DATA = 0,         
    LEARN_PARAMETERS = 1,   
    INPUT_MODEL = 2         
  };

  enum OutputIndices
  {
    OUTPUT_DATA  = 0,       
    OUTPUT_MODEL = 1,       
    OUTPUT_TEST  = 2        
  };

  virtual void SetLearnOptionParameterConnection( vtkAlgorithmOutput* params )
    { this->SetInputConnection( vtkStatisticsAlgorithm::LEARN_PARAMETERS, params ); }

  virtual void SetLearnOptionParameters( vtkDataObject* params )
    { this->SetInputData( vtkStatisticsAlgorithm::LEARN_PARAMETERS, params ); }

  virtual void SetInputModelConnection( vtkAlgorithmOutput* model )
    { this->SetInputConnection( vtkStatisticsAlgorithm::INPUT_MODEL, model ); }

  virtual void SetInputModel( vtkDataObject* model )
    { this->SetInputData( vtkStatisticsAlgorithm::INPUT_MODEL, model ); }


  vtkSetMacro( LearnOption, bool );
  vtkGetMacro( LearnOption, bool );


  vtkSetMacro( DeriveOption, bool );
  vtkGetMacro( DeriveOption, bool );


  vtkSetMacro( AssessOption, bool );
  vtkGetMacro( AssessOption, bool );


  vtkSetMacro( TestOption, bool );
  vtkGetMacro( TestOption, bool );


  vtkSetMacro( NumberOfPrimaryTables, vtkIdType );
  vtkGetMacro( NumberOfPrimaryTables, vtkIdType );


  virtual void SetAssessNames( vtkStringArray* );
  vtkGetObjectMacro(AssessNames,vtkStringArray);


  class AssessFunctor {
  public:
    virtual void operator() ( vtkDoubleArray*,
                              vtkIdType ) = 0;
    virtual ~AssessFunctor() { }
  };

  virtual void SetColumnStatus( const char* namCol, int status );

  virtual void ResetAllColumnStates();

  virtual int RequestSelectedColumns();

  virtual void ResetRequests();

  virtual vtkIdType GetNumberOfRequests();

  virtual vtkIdType GetNumberOfColumnsForRequest( vtkIdType request );

  virtual const char* GetColumnForRequest( vtkIdType r, vtkIdType c );

  virtual int GetColumnForRequest( vtkIdType r, vtkIdType c, vtkStdString& columnName );

  void AddColumn( const char* namCol );

  void AddColumnPair( const char* namColX, const char* namColY );

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

  virtual void Aggregate( vtkDataObjectCollection*,
                          vtkMultiBlockDataSet* ) = 0;

protected:
  vtkStatisticsAlgorithm();
  ~vtkStatisticsAlgorithm() override;

  int FillInputPortInformation( int port, vtkInformation* info ) override;
  int FillOutputPortInformation( int port, vtkInformation* info ) override;

  int RequestData(
    vtkInformation*,
    vtkInformationVector**,
    vtkInformationVector* ) override;

  virtual void Learn( vtkTable*,
                      vtkTable*,
                      vtkMultiBlockDataSet* ) = 0;

  virtual void Derive( vtkMultiBlockDataSet* ) = 0;

  virtual void Assess( vtkTable*,
                       vtkMultiBlockDataSet*,
                       vtkTable* ) = 0;

  void Assess( vtkTable*,
               vtkMultiBlockDataSet*,
               vtkTable*,
               int );

  virtual void Test( vtkTable*,
                     vtkMultiBlockDataSet*,
                     vtkTable* ) = 0;

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

  vtkIdType NumberOfPrimaryTables;
  bool LearnOption;
  bool DeriveOption;
  bool AssessOption;
  bool TestOption;
  vtkStringArray* AssessNames;
  vtkStatisticsAlgorithmPrivate* Internals;

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

#endif