vtkTemporalStatistics.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-NVIDIA-USGov

#ifndef vtkTemporalStatistics_h
#define vtkTemporalStatistics_h

#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkPassInputTypeAlgorithm.h"
#include "vtkTemporalAlgorithm.h" // For temporal algorithm

#ifndef __VTK_WRAP__
#define vtkPassInputTypeAlgorithm vtkTemporalAlgorithm<vtkPassInputTypeAlgorithm>
#endif

VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataSet;
class vtkDataSet;
class vtkFieldData;
class vtkGraph;
struct vtkTemporalStatisticsInternal;

class VTKFILTERSGENERAL_EXPORT vtkTemporalStatistics : public vtkPassInputTypeAlgorithm
{
public:

  vtkTypeMacro(vtkTemporalStatistics, vtkPassInputTypeAlgorithm);
#ifndef __VTK_WRAP__
#undef vtkPassInputTypeAlgorithm
#endif
  static vtkTemporalStatistics* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

#if defined(__VTK_WRAP__) || defined(__WRAP_GCCXML)
  vtkCreateWrappedTemporalAlgorithmInterface();
#endif


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


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


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


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

protected:
  vtkTemporalStatistics();
  ~vtkTemporalStatistics() override;

  vtkTypeBool ComputeAverage;
  vtkTypeBool ComputeMaximum;
  vtkTypeBool ComputeMinimum;
  vtkTypeBool ComputeStandardDeviation;

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

  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  int Initialize(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int Execute(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int Finalize(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  virtual void InitializeStatistics(
    vtkDataObject* input, vtkDataObject* output, vtkDataObject* cache);
  virtual void InitializeStatistics(vtkDataSet* input, vtkDataSet* output, vtkDataSet* cache);
  virtual void InitializeStatistics(vtkGraph* input, vtkGraph* output, vtkGraph* cache);
  virtual void InitializeStatistics(
    vtkCompositeDataSet* input, vtkCompositeDataSet* output, vtkCompositeDataSet* cache);
  virtual void InitializeArrays(vtkFieldData* inFd, vtkFieldData* outFd);
  virtual void InitializeArray(vtkDataArray* array, vtkFieldData* outFd);

  virtual void AccumulateStatistics(
    vtkDataObject* input, vtkDataObject* output, int currentTimeIndex);
  virtual void AccumulateStatistics(vtkDataSet* input, vtkDataSet* output, int currentTimeIndex);
  virtual void AccumulateStatistics(vtkGraph* input, vtkGraph* output, int currentTimeIndex);
  virtual void AccumulateStatistics(
    vtkCompositeDataSet* input, vtkCompositeDataSet* output, int currentTimeIndex);
  virtual void AccumulateArrays(vtkFieldData* inFd, vtkFieldData* outFd, int currentTimeIndex);

  virtual void PostExecute(vtkDataObject* input, vtkDataObject* output, int numSteps);
  virtual void PostExecute(vtkDataSet* input, vtkDataSet* output, int numSteps);
  virtual void PostExecute(vtkGraph* input, vtkGraph* output, int numSteps);
  virtual void PostExecute(vtkCompositeDataSet* input, vtkCompositeDataSet* output, int numSteps);
  virtual void FinishArrays(vtkFieldData* inFd, vtkFieldData* outFd, int numSteps);

  virtual vtkDataArray* GetArray(
    vtkFieldData* fieldData, vtkDataArray* inArray, const char* nameSuffix);

private:
  vtkTemporalStatistics(const vtkTemporalStatistics&) = delete;
  void operator=(const vtkTemporalStatistics&) = delete;

  vtkTemporalStatisticsInternal* Internal;


  bool GeneratedChangingTopologyWarning;
};

VTK_ABI_NAMESPACE_END
#endif //_vtkTemporalStatistics_h