itkFiniteDifferenceSparseImageFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkFiniteDifferenceSparseImageFunction_h
#define itkFiniteDifferenceSparseImageFunction_h

#include "itkFiniteDifferenceFunction.h"

namespace itk
{
template< typename TSparseImageType >
class ITK_TEMPLATE_EXPORT FiniteDifferenceSparseImageFunction:
  public FiniteDifferenceFunction< TSparseImageType >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(FiniteDifferenceSparseImageFunction);

  using Self = FiniteDifferenceSparseImageFunction;
  using Superclass = FiniteDifferenceFunction< TSparseImageType >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(FiniteDifferenceSparseImageFunction, FiniteDifferenceFunction);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using PixelType = typename Superclass::PixelType;
  using TimeStepType = typename Superclass::TimeStepType;
  using RadiusType = typename Superclass::RadiusType;
  using NeighborhoodType = typename Superclass::NeighborhoodType;
  using FloatOffsetType = typename Superclass::FloatOffsetType;
  using SparseImageType = typename Superclass::ImageType;

  using IndexType = typename SparseImageType::IndexType;

  using NodeType = typename SparseImageType::NodeType;

  using NodeDataType = typename NodeType::NodeDataType;

  PixelType ComputeUpdate(const NeighborhoodType &,
                                  void *,
                                  const FloatOffsetType &) override
  {
    return static_cast< PixelType >( nullptr );
  }

  virtual NodeDataType
  ComputeSparseUpdate( NeighborhoodType & neighborhood,
                       void *globalData,
                       const FloatOffsetType & offset = FloatOffsetType(0.0) ) const = 0;

  virtual void PrecomputeSparseUpdate(NeighborhoodType &) const {}

protected:
  FiniteDifferenceSparseImageFunction() = default;
  ~FiniteDifferenceSparseImageFunction() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFiniteDifferenceSparseImageFunction.hxx"
#endif

#endif