itkFiniteCylinderSpatialFunction.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 __itkFiniteCylinderSpatialFunction_h
#define __itkFiniteCylinderSpatialFunction_h

#include "itkInteriorExteriorSpatialFunction.h"
#include "itkConceptChecking.h"

namespace itk
{
template< unsigned int VDimension = 3,
          typename TInput = Point< double, VDimension > >
class ITK_EXPORT FiniteCylinderSpatialFunction:
  public InteriorExteriorSpatialFunction< VDimension, TInput >
{
public:

  typedef FiniteCylinderSpatialFunction                         Self;
  typedef InteriorExteriorSpatialFunction< VDimension, TInput > Superclass;
  typedef SmartPointer< Self >                                  Pointer;
  typedef SmartPointer< const Self >                            ConstPointer;

  itkTypeMacro(FiniteCylinderSpatialFunction, InteriorExteriorSpatialFunction);

  itkNewMacro(Self);

  typedef typename Superclass::InputType InputType;

  typedef typename Superclass::OutputType OutputType;

  itkGetConstMacro(Center, InputType);
  itkSetMacro(Center, InputType);

  itkGetConstMacro(AxisLength, double);
  itkSetMacro(AxisLength, double);

  itkGetConstMacro(Radius, double);
  itkSetMacro(Radius, double);

  itkGetConstMacro(Orientation, InputType);
  itkSetMacro(Orientation, InputType);

  OutputType Evaluate(const InputType & position) const;

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( DimensionShouldBe3,
                   ( Concept::SameDimension< VDimension, 3u > ) );
  itkConceptMacro( PointDimensionShouldBe3,
                   ( Concept::SameDimension< InputType::Dimension, 3u > ) );

#endif

protected:

  FiniteCylinderSpatialFunction();
  virtual ~FiniteCylinderSpatialFunction();

  void PrintSelf(std::ostream & os, Indent indent) const;

private:

  FiniteCylinderSpatialFunction(const Self &); //purposely not implemented
  void operator=(const Self &);                //purposely not implemented

  InputType m_Center;

  double m_AxisLength;

  double m_Radius;

  InputType m_Orientation;
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_FiniteCylinderSpatialFunction(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                                 \
  {                                                                             \
  _( 2 ( class EXPORT FiniteCylinderSpatialFunction< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                                           \
  {                                                                             \
  typedef FiniteCylinderSpatialFunction< ITK_TEMPLATE_2 TypeX >                 \
  FiniteCylinderSpatialFunction##TypeY;                                       \
  }                                                                             \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkFiniteCylinderSpatialFunction+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkFiniteCylinderSpatialFunction.hxx"
#endif

#endif