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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
|
/*=========================================================================
*
* 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 itkVector_h
#define itkVector_h
#include "itkFixedArray.h"
#include "vnl/vnl_vector_ref.h" // GetVnlVector method return
namespace itk
{
/** \class Vector
* \brief A templated class holding a n-Dimensional vector.
*
* Vector is a templated class that holds a single vector (i.e., an array
* of values). Vector can be used as the data type held at each pixel in
* an Image or at each vertex of an Mesh. The template parameter T can
* be any data type that behaves like a primitive (or atomic) data type (int,
* short, float, complex). The VVectorDimension defines the number of
* components in the vector array.
*
* Vector is not a dynamically extendible array like std::vector. It is
* intended to be used like a mathematical vector.
*
* If you wish a simpler pixel types, you can use Scalar, which represents
* a single data value at a pixel. There is also the more complex type
* ScalarVector, which supports (for a given pixel) a single scalar value
* plus an array of vector values. (The scalar and vectors can be of
* different data type.)
*
* \ingroup Geometry
* \ingroup DataRepresentation
*
* \sa Image
* \sa Mesh
* \sa Point
* \sa CovariantVector
* \sa Matrix
* \ingroup ITKCommon
*
* \sphinx
* \sphinxexample{Core/Common/CreateAVector,Create a vector}
* \sphinxexample{Core/Common/VectorDotProduct,Dot product (inner product) of two vectors}
* \endsphinx
*/
template <typename T, unsigned int VVectorDimension = 3>
class ITK_TEMPLATE_EXPORT Vector : public FixedArray<T, VVectorDimension>
{
public:
/** Standard class type aliases. */
using Self = Vector;
using Superclass = FixedArray<T, VVectorDimension>;
/** ValueType can be used to declare a variable that is the same type
* as a data element held in an Vector. */
using ValueType = T;
using RealValueType = typename NumericTraits<ValueType>::RealType;
/** Dimension of the vector space. */
static constexpr unsigned int Dimension = VVectorDimension;
/** I am a vector type. */
using VectorType = Self;
/** Component value type */
using ComponentType = T;
/** The Array type from which this vector is derived. */
using BaseArray = FixedArray<T, VVectorDimension>;
/** Get the dimension (size) of the vector. */
static unsigned int
GetVectorDimension()
{
return VVectorDimension;
}
/** Copy values from the vnl_vector input to the internal memory block. The minimum of
* VVectorDimension and vnl_vector::size() elements are copied. */
void
SetVnlVector(const vnl_vector<T> &);
/** Get a vnl_vector_ref referencing the same memory block. */
vnl_vector_ref<T>
GetVnlVector();
/** Get a vnl_vector with a copy of the internal memory block. */
vnl_vector<T>
GetVnlVector() const;
/** Default-constructor.
* \note The other five "special member functions" are defaulted implicitly, following the C++ "Rule of Zero". */
Vector() = default;
#if !defined(ITK_LEGACY_REMOVE)
/** Constructor to initialize entire vector to one value.
* \warning Not intended to convert a scalar value into
* a Vector filled with that value.
* \deprecated */
Vector(const ValueType & r);
#else
/** Constructor to initialize entire vector to one value,
* if explicitly invoked. */
explicit Vector(const ValueType & r);
/** Prevents copy-initialization from `nullptr`, as well as from `0` (NULL). */
Vector(std::nullptr_t) = delete;
#endif
/** Pass-through constructor for the Array base class. */
template <typename TVectorValueType>
Vector(const Vector<TVectorValueType, VVectorDimension> & r)
: BaseArray(r)
{}
Vector(const ValueType r[Dimension])
: BaseArray(r)
{}
template <typename TVectorValueType>
Vector(const TVectorValueType r[Dimension])
: BaseArray(r)
{}
/** Explicit constructor for std::array. */
explicit Vector(const std::array<ValueType, VVectorDimension> & stdArray)
: BaseArray(stdArray)
{}
/** Pass-through assignment operator for the Array base class. */
template <typename TVectorValueType>
Vector &
operator=(const Vector<TVectorValueType, VVectorDimension> & r)
{
BaseArray::operator=(r);
return *this;
}
Vector &
operator=(const ValueType r[VVectorDimension]);
/** Scalar operator*=. Scales elements by a scalar. */
template <typename Tt>
inline const Self &
operator*=(const Tt & value)
{
for (unsigned int i = 0; i < VVectorDimension; ++i)
{
(*this)[i] = static_cast<ValueType>((*this)[i] * value);
}
return *this;
}
/** Scalar operator/=. Scales (divides) elements by a scalar. */
template <typename Tt>
inline const Self &
operator/=(const Tt & value)
{
for (unsigned int i = 0; i < VVectorDimension; ++i)
{
(*this)[i] = static_cast<ValueType>((*this)[i] / value);
}
return *this;
}
/** Vector operator+=. Adds a vectors to the current vector. */
const Self &
operator+=(const Self & vec);
/** Vector operator-=. Subtracts a vector from a current vector. */
const Self &
operator-=(const Self & vec);
/** Vector negation. Negate all the elements of a vector. Return a new
* vector */
Self
operator-() const;
/** Vector addition. Add two vectors. Return a new vector. */
Self
operator+(const Self & vec) const;
/** Vector subtraction. Subtract two vectors. Return a new vector. */
Self
operator-(const Self & vec) const;
/** Vector operator*. Performs the inner product of two vectors.
* this is also known as the scalar product. */
ValueType operator*(const Self & other) const;
/** Scalar operator*. Scale the elements of a vector by a scalar.
* Return a new vector. */
inline Self operator*(const ValueType & value) const
{
Self result;
for (unsigned int i = 0; i < VVectorDimension; ++i)
{
result[i] = static_cast<ValueType>((*this)[i] * value);
}
return result;
}
/** Scalar operator/. Scale (divide) the elements of a vector by a scalar.
* Return a new vector. */
template <typename Tt>
inline Self
operator/(const Tt & value) const
{
Self result;
for (unsigned int i = 0; i < VVectorDimension; ++i)
{
result[i] = static_cast<ValueType>((*this)[i] / value);
}
return result;
}
/** Operators == and != compare a vector component by component. All
* components must be equal for two vectors to be equal. (Of course
* compile-time constraints on the template parameters length and type
* prevent comparisons between vectors of different type and length.) */
bool
operator==(const Self & v) const
{
return Superclass::operator==(v);
}
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);
/** Returns the Euclidean Norm of the vector */
RealValueType
GetNorm() const;
/** Returns vector's Squared Euclidean Norm */
RealValueType
GetSquaredNorm() const;
/** Returns the number of components in this vector type */
static unsigned int
GetNumberOfComponents()
{
return VVectorDimension;
}
/** Divides the vector components by the vector norm (when the norm is not
* null). The norm used is returned. */
RealValueType
Normalize();
void
SetNthComponent(int c, const ComponentType & v)
{
this->operator[](c) = v;
}
/** Copy from another Vector with a different representation type.
* Casting is done with C-Like rules */
template <typename TCoordRepB>
void
CastFrom(const Vector<TCoordRepB, VVectorDimension> & pa)
{
for (unsigned int i = 0; i < VVectorDimension; ++i)
{
(*this)[i] = static_cast<T>(pa[i]);
}
}
template <typename TCoordRepB>
operator Vector<TCoordRepB, VVectorDimension>()
{
Vector<TCoordRepB, VVectorDimension> r;
for (unsigned int i = 0; i < VVectorDimension; ++i)
{
r[i] = static_cast<TCoordRepB>((*this)[i]);
}
return r;
}
};
/** Premultiply Operator for product of a vector and a scalar.
* Vector< T, N > = T * Vector< T,N > */
template <typename T, unsigned int VVectorDimension>
inline Vector<T, VVectorDimension> operator*(const T & scalar, const Vector<T, VVectorDimension> & v)
{
return v.operator*(scalar);
}
/** Print content to an ostream */
template <typename T, unsigned int VVectorDimension>
std::ostream &
operator<<(std::ostream & os, const Vector<T, VVectorDimension> & vct);
/** Read content from an istream */
template <typename T, unsigned int VVectorDimension>
std::istream &
operator>>(std::istream & is, Vector<T, VVectorDimension> & vct);
ITKCommon_EXPORT Vector<double, 3>
CrossProduct(const Vector<double, 3> &, const Vector<double, 3> &);
ITKCommon_EXPORT Vector<float, 3>
CrossProduct(const Vector<float, 3> &, const Vector<float, 3> &);
ITKCommon_EXPORT Vector<int, 3>
CrossProduct(const Vector<int, 3> &, const Vector<int, 3> &);
template <typename T, unsigned int VVectorDimension>
inline void
swap(Vector<T, VVectorDimension> & a, Vector<T, VVectorDimension> & b)
{
a.swap(b);
}
/** Makes a Vector object, having the specified values as coordinates. */
template <typename TValue, typename... TVariadic>
auto
MakeVector(const TValue firstValue, const TVariadic... otherValues)
{
static_assert(std::conjunction_v<std::is_same<TVariadic, TValue>...>,
"The other values should have the same type as the first value.");
constexpr unsigned int dimension{ 1 + sizeof...(TVariadic) };
const std::array<TValue, dimension> stdArray{ { firstValue, otherValues... } };
return Vector<TValue, dimension>{ stdArray };
}
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkVector.hxx"
#endif
#endif
|