vtkPCorrelativeStatistics.h 2.82 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPCorrelativeStatistics.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.

=========================================================================*/
15 16 17 18 19
/*-------------------------------------------------------------------------
  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.
  -------------------------------------------------------------------------*/
20 21 22
// .NAME vtkPCorrelativeStatistics - A class for parallel bivariate correlative statistics
// .SECTION Description
// vtkPCorrelativeStatistics is vtkCorrelativeStatistics subclass for parallel datasets.
23
// It learns and derives the global statistical model on each node, but assesses each
24 25 26 27 28
// individual data points on the node that owns it.

// .SECTION Thanks
// Thanks to Philippe Pebay from Sandia National Laboratories for implementing this class.

29 30
#ifndef vtkPCorrelativeStatistics_h
#define vtkPCorrelativeStatistics_h
31

32
#include "vtkFiltersParallelStatisticsModule.h" // For export macro
33 34
#include "vtkCorrelativeStatistics.h"

35
class vtkMultiBlockDataSet;
36 37
class vtkMultiProcessController;

38
class VTKFILTERSPARALLELSTATISTICS_EXPORT vtkPCorrelativeStatistics : public vtkCorrelativeStatistics
39 40 41
{
public:
  static vtkPCorrelativeStatistics* New();
42
  vtkTypeMacro(vtkPCorrelativeStatistics, vtkCorrelativeStatistics);
43 44 45 46 47 48 49 50 51 52
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Get/Set the multiprocess controller. If no controller is set,
  // single process is assumed.
  virtual void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);

  // Description:
  // Execute the parallel calculations required by the Learn option.
53
  virtual void Learn( vtkTable* inData,
54 55
                      vtkTable* inParameters,
                      vtkMultiBlockDataSet* outMeta );
56

57 58 59 60 61 62 63
  // Description:
  // Execute the calculations required by the Test option.
  // NB: Not implemented for more than 1 processor
  virtual void Test( vtkTable*,
                     vtkMultiBlockDataSet*,
                     vtkTable* );

64 65 66 67 68 69 70 71 72 73 74
protected:
  vtkPCorrelativeStatistics();
  ~vtkPCorrelativeStatistics();

  vtkMultiProcessController* Controller;
private:
  vtkPCorrelativeStatistics(const vtkPCorrelativeStatistics&); // Not implemented.
  void operator=(const vtkPCorrelativeStatistics&); // Not implemented.
};

#endif