itkFrustumSpatialFunction.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 __itkFrustumSpatialFunction_h
#define __itkFrustumSpatialFunction_h

#include "itkInteriorExteriorSpatialFunction.h"

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

  typedef FrustumSpatialFunction< VImageDimension, TInput >          Self;
  typedef InteriorExteriorSpatialFunction< VImageDimension, TInput > Superclass;
  typedef SmartPointer< Self >                                       Pointer;
  typedef SmartPointer< const Self >                                 ConstPointer;

  itkTypeMacro(FrustumSpatialFunction, InteriorExteriorSpatialFunction);

  itkNewMacro(Self);

  typedef typename Superclass::InputType InputType;

  typedef typename Superclass::OutputType OutputType;

  typedef enum {
    RotateInXZPlane = 1,
    RotateInYZPlane
    } FrustumRotationPlaneType;

  OutputType Evaluate(const InputType & position) const;

  itkGetConstMacro(Apex, InputType);
  itkSetMacro(Apex, InputType);

  itkGetConstMacro(AngleZ, double);
  itkSetMacro(AngleZ, double);

  itkGetConstMacro(ApertureAngleX, double);
  itkSetMacro(ApertureAngleX, double);

  itkGetConstMacro(ApertureAngleY, double);
  itkSetMacro(ApertureAngleY, double);

  itkGetConstMacro(TopPlane, double);
  itkSetMacro(TopPlane, double);

  itkGetConstMacro(BottomPlane, double);
  itkSetMacro(BottomPlane, double);

  itkSetMacro(RotationPlane, FrustumRotationPlaneType);

protected:
  FrustumSpatialFunction();
  virtual ~FrustumSpatialFunction();
  void PrintSelf(std::ostream & os, Indent indent) const;

private:
  FrustumSpatialFunction(const Self &); //purposely not implemented
  void operator=(const Self &);         //purposely not implemented

  InputType m_Apex;

  double m_AngleZ;

  double m_ApertureAngleX;

  double m_ApertureAngleY;

  double m_TopPlane;

  double m_BottomPlane;

  FrustumRotationPlaneType m_RotationPlane;
};
} // end namespace itk

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

#endif