forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkInteriorExteriorSpatialFunction.h
101 lines (81 loc) · 3.67 KB
/
itkInteriorExteriorSpatialFunction.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkInteriorExteriorSpatialFunction.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkInteriorExteriorSpatialFunction_h
#define __itkInteriorExteriorSpatialFunction_h
#include "itkSpatialFunction.h"
namespace itk
{
/** \class InteriorExteriorSpatialFunction
* \brief Returns whether or not a location is "inside" or "outside" a function
*
* InteriorExteriorSpatialFunction is a specialized version of SpatialFunction
* where the output type is a boolean. In particular, the return type is understood
* to mean the following:
*
* A return of 1 means inside or on the surface of the function,
* 0 means outside the function
*
* There is no implied meaning in the terms "inside" or "outside"; although
* the standard assumption is that "inside" means "bounded by a closed surface",
* alternative definitions are also fine. For example, inside might be one side
* of a plane, outside the other side.
*
* A typical use for an InteriorExteriorSpatialFunction is to generate test
* primitives of arbitrary dimensionality, in conjunction with
* itk::SpatialFunctionImageEvaluatorFilter or itk::FloodFilledSpatialFunctionConditionalIterator
*
* \ingroup SpatialFunctions
*/
template <unsigned int VDimension=3,typename TInput=Point<double,VDimension> >
class ITK_EXPORT InteriorExteriorSpatialFunction : public
SpatialFunction<bool, VDimension, TInput >
{
public:
/** Standard class typedefs. */
typedef InteriorExteriorSpatialFunction Self;
typedef SpatialFunction<bool, VDimension,TInput> Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Run-time type information (and related methods). */
itkTypeMacro(InteriorExteriorSpatialFunction, SpatialFunction);
/** Input type for the function */
typedef typename Superclass::InputType InputType;
/** Output type for the function */
typedef typename Superclass::OutputType OutputType;
/** Evaluate the function at a given position.
* A return of 1 means inside or on the surface of the function,
* 0 means outside the function
* The actual definition of inside/outside is left up to the subclass */
virtual OutputType Evaluate( const InputType& input ) const = 0;
protected:
InteriorExteriorSpatialFunction();
virtual ~InteriorExteriorSpatialFunction();
void PrintSelf(std::ostream& os, Indent indent) const;
private:
InteriorExteriorSpatialFunction(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
};
} // end namespace itk
// Define instantiation macro for this template.
#define ITK_TEMPLATE_InteriorExteriorSpatialFunction(_, EXPORT, x, y) namespace itk { \
_(2(class EXPORT InteriorExteriorSpatialFunction< ITK_TEMPLATE_2 x >)) \
namespace Templates { typedef InteriorExteriorSpatialFunction< ITK_TEMPLATE_2 x > \
InteriorExteriorSpatialFunction##y; } \
}
#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkInteriorExteriorSpatialFunction+-.h"
#endif
#if ITK_TEMPLATE_TXX
# include "itkInteriorExteriorSpatialFunction.txx"
#endif
#endif