itkLevelSetVelocityNeighborhoodExtractor.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 itkLevelSetVelocityNeighborhoodExtractor_h
#define itkLevelSetVelocityNeighborhoodExtractor_h
 
#include "itkLevelSetNeighborhoodExtractor.h"
 
namespace itk
{
template <typename TLevelSet, typename TAuxValue, unsigned int VAuxDimension = 1>
class ITK_TEMPLATE_EXPORT LevelSetVelocityNeighborhoodExtractor : public LevelSetNeighborhoodExtractor<TLevelSet>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LevelSetVelocityNeighborhoodExtractor);

  using Self = LevelSetVelocityNeighborhoodExtractor;
  using Superclass = LevelSetNeighborhoodExtractor<TLevelSet>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(LevelSetVelocityNeighborhoodExtractor);

  using LevelSetType = LevelSetTypeDefault<TLevelSet>;

  static constexpr unsigned int SetDimension = LevelSetType::SetDimension;

  using Index = itk::Index<Self::SetDimension>;

  using AuxVarType = AuxVarTypeDefault<TAuxValue, VAuxDimension, Self::SetDimension>;
  using AuxValueType = typename AuxVarType::AuxValueType;
  using AuxValueVectorType = typename AuxVarType::AuxValueVectorType;
  using AuxValueContainer = typename AuxVarType::AuxValueContainer;
  using AuxImageType = typename AuxVarType::AuxImageType;
  using AuxImagePointer = typename AuxVarType::AuxImagePointer;
  using AuxImageConstPointer = typename AuxVarType::AuxImageConstPointer;

  void
  SetAuxImage(const AuxImageType * ptr, unsigned int idx = 0)
  {
    if (idx < VAuxDimension && m_AuxImage[idx] != ptr)
    {
      m_AuxImage[idx] = ptr;
    }
    this->Modified();
  }


  AuxImageConstPointer
  GetAuxImage(unsigned int idx = 0)
  {
    if (idx >= VAuxDimension)
    {
      return nullptr;
    }
 
    return m_AuxImage[idx];
  }

  itkGetModifiableObjectMacro(AuxInsideValues, AuxValueContainer);

  itkGetModifiableObjectMacro(AuxOutsideValues, AuxValueContainer);
 
protected:
  LevelSetVelocityNeighborhoodExtractor();
  ~LevelSetVelocityNeighborhoodExtractor() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  Initialize() override;
 
  double
  CalculateDistance(Index & index) override;
 
private:
  typename AuxValueContainer::Pointer m_AuxInsideValues{};
  typename AuxValueContainer::Pointer m_AuxOutsideValues{};
  AuxImageConstPointer                m_AuxImage[VAuxDimension]{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelSetVelocityNeighborhoodExtractor.hxx"
#endif
 
#endif