itkContourSpatialObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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.
 *
 *=========================================================================*/
#ifndef __itkContourSpatialObject_h
#define __itkContourSpatialObject_h

#include <list>

#include "itkPointBasedSpatialObject.h"
#include "itkContourSpatialObjectPoint.h"

namespace itk
{
template< unsigned int TDimension = 3 >
class ITK_EXPORT ContourSpatialObject:
  public PointBasedSpatialObject<  TDimension >
{
public:

  typedef ContourSpatialObject                    Self;
  typedef PointBasedSpatialObject< TDimension >   Superclass;
  typedef SmartPointer< Self >                    Pointer;
  typedef SmartPointer< const Self >              ConstPointer;
  typedef double                                  ScalarType;
  typedef ContourSpatialObjectPoint< TDimension > ControlPointType;
  typedef SpatialObjectPoint< TDimension >        InterpolatedPointType;
  typedef std::vector< ControlPointType >         ControlPointListType;
  typedef std::vector< InterpolatedPointType >    InterpolatedPointListType;

  typedef typename Superclass::SpatialObjectPointType  SpatialObjectPointType;
  typedef typename Superclass::PointType               PointType;
  typedef typename Superclass::TransformType           TransformType;
  typedef typename Superclass::BoundingBoxType         BoundingBoxType;
  typedef VectorContainer< IdentifierType, PointType > PointContainerType;
  typedef SmartPointer< PointContainerType >           PointContainerPointer;

  itkNewMacro(Self);

  itkTypeMacro(ContourSpatialObject, PointBasedSpatialObject);

  ControlPointListType & GetControlPoints(void);

  const ControlPointListType & GetControlPoints(void) const;

  void SetControlPoints(ControlPointListType & newPoints);

  const ControlPointType * GetControlPoint(IdentifierType id) const
  { return &( m_ControlPoints[id] ); }

  ControlPointType * GetControlPoint(IdentifierType id)
  { return &( m_ControlPoints[id] ); }

  SizeValueType GetNumberOfControlPoints(void) const
  { return m_ControlPoints.size(); }

  InterpolatedPointListType & GetInterpolatedPoints(void);

  const InterpolatedPointListType & GetInterpolatedPoints(void) const;

  void SetInterpolatedPoints(InterpolatedPointListType & newPoints);

  const InterpolatedPointType * GetInterpolatedPoint(IdentifierType id) const
  { return &( m_InterpolatedPoints[id] ); }

  InterpolatedPointType * GetInterpolatedPoint(IdentifierType id)
  { return &( m_InterpolatedPoints[id] ); }

  SizeValueType GetNumberOfInterpolatedPoints(void) const
  { return m_InterpolatedPoints.size(); }

  enum InterpolationType { NO_INTERPOLATION = 0,
                           EXPLICIT_INTERPOLATION, BEZIER_INTERPOLATION,
                           LINEAR_INTERPOLATION };

  InterpolationType GetInterpolationType() const
  { return m_InterpolationType; }
  void SetInterpolationType(InterpolationType interpolation)
  { m_InterpolationType = interpolation; }

  itkSetMacro(Closed, bool);
  itkGetConstMacro(Closed, bool);

  itkSetMacro(DisplayOrientation, int);
  itkGetConstMacro(DisplayOrientation, int);

  itkSetMacro(AttachedToSlice, int);
  itkGetConstMacro(AttachedToSlice, int);

  bool IsEvaluableAt(const PointType & point,
                     unsigned int depth = 0, char *name = NULL) const;

  bool ValueAt(const PointType & point, double & value,
               unsigned int depth = 0, char *name = NULL) const;

  bool IsInside(const PointType & point,
                unsigned int depth, char *name) const;

  virtual bool IsInside(const PointType & point) const;

  bool ComputeLocalBoundingBox(void) const;

protected:
  ContourSpatialObject(const Self &); //purposely not implemented
  void operator=(const Self &);       //purposely not implemented

  ControlPointListType      m_ControlPoints;
  InterpolatedPointListType m_InterpolatedPoints;
  InterpolationType         m_InterpolationType;
  bool                      m_Closed;
  int                       m_DisplayOrientation;
  int                       m_AttachedToSlice;

  ContourSpatialObject();
  virtual ~ContourSpatialObject();

  virtual void PrintSelf(std::ostream & os, Indent indent) const;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkContourSpatialObject.hxx"
#endif

#endif // __itkContourSpatialObject_h