itkScalarRegionBasedLevelSetFunction.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 itkScalarRegionBasedLevelSetFunction_h
#define itkScalarRegionBasedLevelSetFunction_h

#include "itkRegionBasedLevelSetFunction.h"
#include "itkNeighborhoodIterator.h"
#include "itkImageRegionConstIterator.h"
#include "itkImageRegionIteratorWithIndex.h"

namespace itk
{
template< typename TInputImage, typename TFeatureImage, typename TSharedData >
class ITK_TEMPLATE_EXPORT ScalarRegionBasedLevelSetFunction:
  public RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ScalarRegionBasedLevelSetFunction);

  using Self = ScalarRegionBasedLevelSetFunction;
  using Superclass = RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  // itkNewMacro() is not provided since this is an abstract class.

  itkTypeMacro(ScalarRegionBasedLevelSetFunction, RegionBasedLevelSetFunction);

  static constexpr unsigned int ImageDimension = TFeatureImage::ImageDimension;

  using InputImageType = typename Superclass::InputImageType;
  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
  using InputImagePointer = typename Superclass::InputImagePointer;
  using InputPixelType = typename Superclass::InputPixelType;
  using InputIndexType = typename Superclass::InputIndexType;
  using InputIndexValueType = typename Superclass::InputIndexValueType;
  using InputSizeType = typename Superclass::InputSizeType;
  using InputSizeValueType = typename Superclass::InputSizeValueType;
  using InputRegionType = typename Superclass::InputRegionType;
  using InputPointType = typename Superclass::InputPointType;

  using FeatureImageType = typename Superclass::FeatureImageType;
  using FeatureImageConstPointer = typename FeatureImageType::ConstPointer;
  using FeaturePixelType = typename Superclass::FeaturePixelType;
  using FeatureIndexType = typename Superclass::FeatureIndexType;
  using FeatureOffsetType = typename Superclass::FeatureOffsetType;

  using ScalarValueType = typename Superclass::ScalarValueType;
  using NeighborhoodType = typename Superclass::NeighborhoodType;
  using FloatOffsetType = typename Superclass::FloatOffsetType;
  using RadiusType = typename Superclass::RadiusType;
  using TimeStepType = typename Superclass::TimeStepType;
  using GlobalDataStruct = typename Superclass::GlobalDataStruct;
  using PixelType = typename Superclass::PixelType;
  using VectorType = typename Superclass::VectorType;

  using SharedDataType = typename Superclass::SharedDataType;
  using SharedDataPointer = typename Superclass::SharedDataPointer;

  using ImageIteratorType = ImageRegionIteratorWithIndex< InputImageType >;
  using ConstImageIteratorType = ImageRegionConstIteratorWithIndex< InputImageType >;
  using FeatureImageIteratorType = ImageRegionIteratorWithIndex< FeatureImageType >;
  using ConstFeatureIteratorType = ImageRegionConstIterator< FeatureImageType >;

  using ListPixelType = std::list< unsigned int >;
  using ListPixelConstIterator = typename ListPixelType::const_iterator;
  using ListPixelIterator = typename ListPixelType::iterator;
  using ListImageType =
      Image< ListPixelType, Self::ImageDimension >;

  void UpdatePixel(const unsigned int & idx,
                   NeighborhoodIterator< TInputImage > & iterator,
                   InputPixelType & newValue,
                   bool & status);

protected:
  ScalarRegionBasedLevelSetFunction():Superclass(){}
  ~ScalarRegionBasedLevelSetFunction() override{}

  ScalarValueType ComputeOverlapParameters(const FeatureIndexType & featIndex,
                                           ScalarValueType & product) override;

  // update the background and foreground constants for pixel updates
  // Called only when sparse filters are used to prevent iteration through the
  // entire image
  virtual void UpdateSharedDataInsideParameters(const unsigned int & iId,
                                                const FeaturePixelType & iVal, const ScalarValueType & iChange) = 0;

  virtual void UpdateSharedDataOutsideParameters(const unsigned int & iId,
                                                 const FeaturePixelType & iVal, const ScalarValueType & iChange) = 0;
};
}

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

#endif