vtkStatisticalModel.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkStatisticalModel_h
#define vtkStatisticalModel_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"
#include "vtkNew.h"          // For vtkNew
#include "vtkSmartPointer.h" // For vtkSmartPointer

#include <map>

VTK_ABI_NAMESPACE_BEGIN
class vtkTable;

class VTKCOMMONDATAMODEL_EXPORT vtkStatisticalModel : public vtkDataObject
{
public:
  static vtkStatisticalModel* New();
  vtkTypeMacro(vtkStatisticalModel, vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMTimeType GetMTime() override;

  void Initialize() override;

  bool IsEmpty();

  unsigned long GetActualMemorySize() override;

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_STATISTICAL_MODEL; }


  void ShallowCopy(vtkDataObject* src) override;
  void DeepCopy(vtkDataObject* src) override;

  enum TableType
  {
    Learned = 0, 
    Derived = 1, 
    Test = 2     
  };

  static const char* GetTableTypeName(int tableType);
  static int GetTableTypeValue(const std::string& tableType);


  static vtkStatisticalModel* GetData(vtkInformation* info);
  static vtkStatisticalModel* GetData(vtkInformationVector* vv, int ii = 0);

  static int GetNumberOfTableTypes() { return 3; }

  int GetNumberOfTables();

  int GetNumberOfTables(int type);

  vtkTable* GetTable(int type, int index);

  std::string GetTableName(int type, int index);


  vtkTable* FindTableByName(int type, const std::string& tableName);
  vtkTable* FindTableByName(int type, const std::string& tableName, int& index);

  bool SetNumberOfTables(int type, int number);

  bool SetTable(int type, int index, vtkTable* table, const std::string& tableName);

  bool SetTableName(int type, int index, const std::string& name);


  vtkSetStringMacro(AlgorithmParameters);
  vtkGetStringMacro(AlgorithmParameters);
  void SetAlgorithmParameters(const std::string& algorithmParameters)
  {
    if (algorithmParameters.empty())
    {
      this->SetAlgorithmParameters(nullptr);
    }
    else
    {
      this->SetAlgorithmParameters(algorithmParameters.c_str());
    }
  }

protected:
  // Constructor with no model tables.
  vtkStatisticalModel();
  ~vtkStatisticalModel() override;

  using TableMap = std::map<int, std::vector<vtkSmartPointer<vtkTable>>>;
  TableMap ModelTables;

  char* AlgorithmParameters{ nullptr };

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

VTK_ABI_NAMESPACE_END
#endif // vtkStatisticalModel_h