vtkSegment.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 __vtkSegment_h
#define __vtkSegment_h

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

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

// Segmentation includes
#include "vtkSegmentationCoreConfigure.h"

class vtkSegmentationCore_EXPORT vtkSegment : public vtkObject
{
  typedef std::map<std::string, vtkSmartPointer<vtkDataObject> > RepresentationMap;

public:

  static const double SEGMENT_COLOR_INVALID[3];

  static const char* GetTerminologyEntryTagName();

  static vtkSegment* New();
  vtkTypeMacro(vtkSegment, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void ReadXMLAttributes(const char** atts);

  void WriteXML(ostream& of, int nIndent);

  virtual void DeepCopy(vtkSegment* source);

  virtual void DeepCopyMetadata(vtkSegment* source);

  virtual void GetBounds(double bounds[6]);

  vtkDataObject* GetRepresentation(std::string name);

  bool AddRepresentation(std::string type, vtkDataObject* representation);

  bool RemoveRepresentation(std::string name);

  void RemoveAllRepresentations(std::string exceptionRepresentationName="");

  void SetTag(std::string tag, std::string value);
  void SetTag(std::string tag, int value);

  void RemoveTag(std::string tag);

  bool GetTag(std::string tag, std::string &value);
  bool HasTag(std::string tag);
  void GetTags(std::map<std::string,std::string> &tags);

  void GetContainedRepresentationNames(std::vector<std::string>& representationNames);

public:
  vtkGetStringMacro(Name);
  vtkSetStringMacro(Name);

  vtkGetVector3Macro(Color, double);
  vtkSetVector3Macro(Color, double);

  vtkGetMacro(NameAutoGenerated, bool);
  vtkSetMacro(NameAutoGenerated, bool);
  vtkBooleanMacro(NameAutoGenerated, bool);

  vtkGetMacro(ColorAutoGenerated, bool);
  vtkSetMacro(ColorAutoGenerated, bool);
  vtkBooleanMacro(ColorAutoGenerated, bool);

  vtkGetMacro(LabelValue, int);
  vtkSetMacro(LabelValue, int);

protected:
  vtkSegment();
  ~vtkSegment() override;

protected:
  RepresentationMap Representations;
  char* Name;
  double Color[3];
  std::map<std::string,std::string> Tags;
  bool NameAutoGenerated;
  bool ColorAutoGenerated;
  int LabelValue;

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

#endif // __vtkSegment_h