vtkSegmentationConverterRule.h

Go to the documentation of this file.

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

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Csaba Pinter, PerkLab, Queen's University
  and was supported through the Applied Cancer Research Unit program of Cancer Care
  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care

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

#ifndef __vtkSegmentationConverterRule_h
#define __vtkSegmentationConverterRule_h

#include "vtkSegmentationCoreConfigure.h"

// VTK includes
#include <vtkObject.h>

// STD includes
#include <map>
#include <string>
#include <vector>

class vtkDataObject;
class vtkSegmentation;
class vtkSegment;

#ifndef vtkSegmentationConverterRuleNewMacro
#define vtkSegmentationConverterRuleNewMacro(newClass) \
  vtkStandardNewMacro(newClass); \
  vtkSegmentationConverterRule* newClass::CreateRuleInstance() \
  { \
    return newClass::New(); \
  }
#endif

class vtkSegmentationCore_EXPORT vtkSegmentationConverterRule : public vtkObject
{
public:
  typedef std::map<std::string, std::pair<std::string, std::string> > ConversionParameterListType;

  static unsigned int GetConversionInfiniteCost() { return 10000000; };

public:
  //static vtkSegmentationConverterRule* New();
  vtkTypeMacro(vtkSegmentationConverterRule, vtkObject);

  virtual vtkSegmentationConverterRule* CreateRuleInstance() = 0;

  virtual vtkSegmentationConverterRule* Clone();

  virtual vtkDataObject* ConstructRepresentationObjectByRepresentation(std::string representationName) = 0;

  virtual vtkDataObject* ConstructRepresentationObjectByClass(std::string className) = 0;

  virtual bool PreConvert(vtkSegmentation* vtkNotUsed(segmentation)) { return true; };

  virtual bool Convert(vtkSegment* segment) = 0;

  virtual bool PostConvert(vtkSegmentation* vtkNotUsed(segmentation)) { return true; };

  virtual unsigned int GetConversionCost(vtkDataObject* sourceRepresentation=nullptr, vtkDataObject* targetRepresentation=nullptr)
    {
    (void)(sourceRepresentation); // unused
    (void)(targetRepresentation); // unused
    return 100;
    };

  virtual const char* GetName() = 0;

  virtual const char* GetSourceRepresentationName() = 0;

  virtual const char* GetTargetRepresentationName() = 0;

  virtual void GetRuleConversionParameters(ConversionParameterListType& conversionParameters);

  virtual void SetConversionParameter(const std::string& name, const std::string& value, const std::string& description="");

  virtual std::string GetConversionParameter(const std::string& name);

  virtual std::string GetConversionParameterDescription(const std::string& name);

  bool HasConversionParameter(const std::string& name);

protected:
  virtual bool CreateTargetRepresentation(vtkSegment* segment);

  vtkSegmentationConverterRule();
  ~vtkSegmentationConverterRule() override;
  void operator=(const vtkSegmentationConverterRule&);

protected:
  ConversionParameterListType ConversionParameters;

  bool ReplaceTargetRepresentation{false};

  friend class vtkSegmentationConverter;
};

#endif // __vtkSegmentationConverterRule_h