itkFiniteDifferenceSparseImageFilter.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 itkFiniteDifferenceSparseImageFilter_h
#define itkFiniteDifferenceSparseImageFilter_h

#include "itkFiniteDifferenceSparseImageFunction.h"
#include "itkFiniteDifferenceImageFilter.h"
#include "itkMultiThreaderBase.h"
#include "itkSparseImage.h"

namespace itk
{
template< typename TInputImageType, typename TSparseOutputImageType >
class ITK_TEMPLATE_EXPORT FiniteDifferenceSparseImageFilter:
  public FiniteDifferenceImageFilter< TInputImageType,
                                      TSparseOutputImageType >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(FiniteDifferenceSparseImageFilter);

  using Self = FiniteDifferenceSparseImageFilter;
  using Superclass = FiniteDifferenceImageFilter<
    TInputImageType, TSparseOutputImageType >;

  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(FiniteDifferenceSparseImageFilter, FiniteDifferenceImageFilter);

  using InputImageType = typename Superclass::InputImageType;
  using SparseOutputImageType = typename Superclass::OutputImageType;
  using PixelType = typename Superclass::PixelType;
  using TimeStepType = typename Superclass::TimeStepType;
  using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType;
  // the PixelType is from output image; therefore, it is a pointer

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using IndexType = typename SparseOutputImageType::IndexType;
  using SizeType = typename SparseOutputImageType::SizeType;
  using OutputNodeType = typename SparseOutputImageType::NodeType;
  using NodeListType = typename SparseOutputImageType::NodeListType;

  using NodeDataType = typename OutputNodeType::NodeDataType;

  using NodeValueType = typename OutputNodeType::NodeValueType;

  using SparseFunctionType = FiniteDifferenceSparseImageFunction<SparseOutputImageType>;

  void SetSparseFunction(SparseFunctionType *sf);

  itkSetMacro(PrecomputeFlag, bool);
  itkGetConstMacro(PrecomputeFlag, bool);

protected:
  FiniteDifferenceSparseImageFilter();
  ~FiniteDifferenceSparseImageFilter() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void Initialize() override;

  void AllocateUpdateBuffer() override {}

  virtual NodeDataType DataConstraint(const NodeDataType & data) const
  { return data; }

private:
  struct ThreadRegionType {
    // this is the first element
    typename NodeListType::Iterator first;
    // this is one past the last element
    typename NodeListType::Iterator last;
  };

protected:
  ThreadIdType GetSplitRegion(ThreadIdType i, ThreadIdType num, ThreadRegionType & splitRegion);

  void ApplyUpdate(const TimeStepType& dt) override;

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ApplyUpdateThreaderCallback(void *arg);

  virtual void ThreadedApplyUpdate(const TimeStepType& dt,
                                   const ThreadRegionType & regionToProcess,
                                   ThreadIdType threadId);

  TimeStepType CalculateChange() override;

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION CalculateChangeThreaderCallback(void *arg);

  virtual TimeStepType ThreadedCalculateChange
    (const ThreadRegionType & regionToProcess, ThreadIdType threadId);

  virtual void PrecalculateChange();

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION PrecalculateChangeThreaderCallback(void *arg);

  virtual void ThreadedPrecalculateChange
    (const ThreadRegionType & regionToProcess, ThreadIdType threadId);

  struct FDThreadStruct {
    FiniteDifferenceSparseImageFilter *Filter;
    TimeStepType TimeStep;
    std::vector< TimeStepType > TimeStepList;
    std::vector< bool > ValidTimeStepList;
  };

private:
  bool m_PrecomputeFlag;

  SparseFunctionType *m_SparseFunction;

  typename NodeListType::RegionListType m_RegionList;

};
} // end namespace itk

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

#endif