itkContinuousIndex.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkContinuousIndex_h
#define itkContinuousIndex_h
 
#include "itkPoint.h"
#include "itkIndex.h"
 
#include <type_traits> // For is_floating_point.
 
namespace itk
{
template <typename TCoordinate = double, unsigned int VIndexDimension = 2>
class ITK_TEMPLATE_EXPORT ContinuousIndex : public Point<TCoordinate, VIndexDimension>
{
  static_assert(std::is_floating_point_v<TCoordinate>,
                "The coordinates of a continuous index must be represented by floating point numbers.");
 
public:
  using Self = ContinuousIndex;
  using Superclass = Point<TCoordinate, VIndexDimension>;
 
  using ValueType = TCoordinate;
  using CoordinateType = TCoordinate;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
 
  static constexpr unsigned int IndexDimension = VIndexDimension;
 
  using IndexType = Index<VIndexDimension>;
 
  using BaseArray = typename Superclass::BaseArray;
  using Iterator = typename BaseArray::Iterator;
  using ConstIterator = typename BaseArray::ConstIterator;
 
  ContinuousIndex() = default;
 
  ContinuousIndex(const ValueType r[IndexDimension])
    : Superclass(r)
  {}
 
  ContinuousIndex(const IndexType & index)
  {
    for (unsigned int i = 0; i < VIndexDimension; ++i)
    {
      (*this)[i] = static_cast<TCoordinate>(index[i]);
    }
  }
};
} // namespace itk
#endif