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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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 itkEllipseSpatialObject_h
#define itkEllipseSpatialObject_h
#include "itkSpatialObject.h"
#include "itkAffineTransform.h"
#include "itkFixedArray.h"
namespace itk
{
/**
* \class EllipseSpatialObject
*
* \ingroup ITKSpatialObjects
*
* \sphinx
* \sphinxexample{Core/SpatialObjects/Ellipse,Ellipse}
* \endsphinx
*/
template <unsigned int TDimension = 3>
class ITK_TEMPLATE_EXPORT EllipseSpatialObject : public SpatialObject<TDimension>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(EllipseSpatialObject);
using Self = EllipseSpatialObject;
using ScalarType = double;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using Superclass = SpatialObject<TDimension>;
using SuperclassPointer = SmartPointer<Superclass>;
using typename Superclass::PointType;
using typename Superclass::TransformType;
using typename Superclass::BoundingBoxType;
using PointContainerType = VectorContainer<IdentifierType, PointType>;
using PointContainerPointer = SmartPointer<PointContainerType>;
using ArrayType = FixedArray<double, TDimension>;
static constexpr unsigned int ObjectDimension = TDimension;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(EllipseSpatialObject);
/** Reset the spatial object to its initial condition, yet preserves
* Id, Parent, and Child information */
void
Clear() override;
/** Set all radii to the same radius value
*
* Each radius is half the length of one axis of the ellipse.
*
* The ellipse is formed by setting the ObjectToParentTransform.
*/
void
SetRadiusInObjectSpace(double radius);
/** Set radii via an array of radius values */
itkSetMacro(RadiusInObjectSpace, ArrayType);
/** Get radii via an array of radius values */
itkGetConstReferenceMacro(RadiusInObjectSpace, ArrayType);
/** Set center point in object space. */
itkSetMacro(CenterInObjectSpace, PointType);
/** Get center in object space */
itkGetConstReferenceMacro(CenterInObjectSpace, PointType);
/** Test whether a point is inside the object.
*
* For computational speed purposes, it is faster if the method does not check the name of the class and the
* current depth.
*/
bool
IsInsideInObjectSpace(const PointType & point) const override;
/* Avoid hiding the overload that supports depth and name arguments */
using Superclass::IsInsideInObjectSpace;
#if !defined(ITK_LEGACY_REMOVE)
itkLegacyMacro(void SetRadius(double radius)) { this->SetRadiusInObjectSpace(radius); }
itkLegacyMacro(void SetRadius(ArrayType radii)) { this->SetRadiusInObjectSpace(radii); }
itkLegacyMacro(ArrayType GetRadius() const) { return this->GetRadiusInObjectSpace(); }
itkLegacyMacro(void SetRadiiInObjectSpace(ArrayType radii)) { this->SetRadiusInObjectSpace(radii); }
#endif
protected:
/** Get the boundaries of a specific object. This function needs to
* be called every time one of the object's components is
* changed. */
void
ComputeMyBoundingBox() override;
EllipseSpatialObject();
~EllipseSpatialObject() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
typename LightObject::Pointer
InternalClone() const override;
private:
/* object space */
ArrayType m_RadiusInObjectSpace{};
PointType m_CenterInObjectSpace{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkEllipseSpatialObject.hxx"
#endif
#endif // itkEllipseSpatialObject_h
|