vtkSegmentationConverter.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 __vtkSegmentationConverter_h
#define __vtkSegmentationConverter_h

// VTK includes
#include <vtkObject.h>
#include <vtkSmartPointer.h>

// STD includes
#include <map>
#include <set>
#include <utility>
#include <vector>

// Segmentation includes
#include "vtkSegmentationCoreConfigure.h"

#include "vtkSegmentationConverterRule.h"

class vtkAbstractTransform;
class vtkSegment;
class vtkMatrix4x4;
class vtkImageData;
class vtkOrientedImageData;

class vtkSegmentationCore_EXPORT vtkSegmentationConverter : public vtkObject
{
public:
  typedef std::vector< vtkSmartPointer<vtkSegmentationConverterRule> > ConverterRulesListType;

  typedef std::vector<vtkSegmentationConverterRule*> ConversionPathType; // Contains a list of converter rule names
  typedef std::pair<ConversionPathType, unsigned int> ConversionPathAndCostType;
  typedef std::vector<ConversionPathAndCostType> ConversionPathAndCostListType;

  static const char* GetSegmentationBinaryLabelmapRepresentationName()     { return "Binary labelmap"; };
  static const char* GetSegmentationFractionalLabelmapRepresentationName() { return "Fractional labelmap"; };
  static const char* GetSegmentationPlanarContourRepresentationName()      { return "Planar contour"; };
  static const char* GetSegmentationClosedSurfaceRepresentationName()      { return "Closed surface"; };
  static const char* GetBinaryLabelmapRepresentationName()     { return GetSegmentationBinaryLabelmapRepresentationName(); };
  static const char* GetFractionalLabelmapRepresentationName() { return GetSegmentationFractionalLabelmapRepresentationName(); };
  static const char* GetPlanarContourRepresentationName()      { return GetSegmentationPlanarContourRepresentationName(); };
  static const char* GetClosedSurfaceRepresentationName()      { return GetSegmentationClosedSurfaceRepresentationName(); };

  // Common conversion parameters
  // ----------------------------
  static const std::string GetReferenceImageGeometryParameterName() { return "Reference image geometry"; };

  static const char* GetScalarRangeFieldName() {return "ScalarRange";};
  static const char* GetThresholdValueFieldName() {return "ThresholdValue";};
  static const char* GetInterpolationTypeFieldName() {return "InterpolationType";};

public:
  static vtkSegmentationConverter* New();
  vtkTypeMacro(vtkSegmentationConverter, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual void DeepCopy(vtkSegmentationConverter* aConverter);

  void GetAvailableRepresentationNames(std::set<std::string>& representationNames);

  void GetPossibleConversions(const std::string& sourceRepresentationName, const std::string& targetRepresentationName, ConversionPathAndCostListType &pathsCosts);

  void GetConversionParametersForPath(vtkSegmentationConverterRule::ConversionParameterListType& conversionParameters, const ConversionPathType& path);

  void GetAllConversionParameters(vtkSegmentationConverterRule::ConversionParameterListType& conversionParameters);

  void SetConversionParameters(vtkSegmentationConverterRule::ConversionParameterListType parameters);

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

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

  std::string GetConversionParameterDescription(const std::string& description);

  std::string SerializeAllConversionParameters();

  void DeserializeConversionParameters(std::string conversionParametersString);

  void ApplyTransformOnReferenceImageGeometry(vtkAbstractTransform* transform);

// Utility functions
public:
  static ConversionPathType GetCheapestPath(const ConversionPathAndCostListType &pathsCosts);

  static std::string SerializeImageGeometry(vtkOrientedImageData* orientedImageData);

  static std::string SerializeImageGeometry(vtkMatrix4x4* geometryMatrix, vtkImageData* imageData);

  static std::string SerializeImageGeometry(vtkMatrix4x4* geometryMatrix, int extent[6]);

  static bool DeserializeImageGeometry(std::string geometryString, vtkOrientedImageData* orientedImageData, bool allocateScalars=true, int scalarType=VTK_VOID, int numberOfScalarsComponents=-1);

  static bool DeserializeImageGeometry(std::string geometryString, vtkMatrix4x4* geometryMatrix, int extent[6]);

protected:
  void RebuildRulesGraph();

  void FindPath(const std::string& sourceRepresentationName, const std::string& targetRepresentationName, ConversionPathAndCostListType &pathsCosts, std::set<std::string>& skipRepresentations);

protected:
  vtkSegmentationConverter();
  ~vtkSegmentationConverter();
  void operator=(const vtkSegmentationConverter&);

protected:
  ConverterRulesListType ConverterRules;

  typedef std::vector<vtkSegmentationConverterRule*> RulesListType;
  typedef std::map<std::string, RulesListType> RepresentationToRepresentationToRuleMapType;

  RepresentationToRepresentationToRuleMapType RulesGraph;
};

#endif // __vtkSegmentationConverter_h