sitkSLICImageFilter.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
*
*         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 sitkSLICImageFilter_h
#define sitkSLICImageFilter_h
 
/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageFilterTemplate.h.jinja to make changes.
 */
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
#include "sitkProcessObjectDeleter.h"
 
namespace itk::simple {

class SITKBasicFilters_EXPORT SLICImageFilter : public ImageFilter {
public:
  using Self = SLICImageFilter;

  virtual ~SLICImageFilter();

  SLICImageFilter();

  using PixelIDTypeList = typelist2::append<BasicPixelIDTypeList, VectorPixelIDTypeList>::type;
 
 
 

  void
  SetSuperGridSize(std::vector<unsigned int> SuperGridSize )
    { this->m_SuperGridSize = std::move(SuperGridSize); }

  std::vector<unsigned int>
  GetSuperGridSize() const { return this->m_SuperGridSize; }
 

  void
  SetSpatialProximityWeight(double SpatialProximityWeight )
    { this->m_SpatialProximityWeight = SpatialProximityWeight; }

  double
  GetSpatialProximityWeight() const { return this->m_SpatialProximityWeight; }
 

  void
  SetMaximumNumberOfIterations(uint32_t MaximumNumberOfIterations )
    { this->m_MaximumNumberOfIterations = MaximumNumberOfIterations; }

  uint32_t
  GetMaximumNumberOfIterations() const { return this->m_MaximumNumberOfIterations; }
 

  void
  SetEnforceConnectivity(bool EnforceConnectivity )
    { this->m_EnforceConnectivity = EnforceConnectivity; }

  void
  EnforceConnectivityOn() { return this->SetEnforceConnectivity(true); }
  void
  EnforceConnectivityOff() { return this->SetEnforceConnectivity(false); }
  bool
  GetEnforceConnectivity() const { return this->m_EnforceConnectivity; }
 

  void
  SetInitializationPerturbation(bool InitializationPerturbation )
    { this->m_InitializationPerturbation = InitializationPerturbation; }

  void
  InitializationPerturbationOn() { return this->SetInitializationPerturbation(true); }
  void
  InitializationPerturbationOff() { return this->SetInitializationPerturbation(false); }
  bool
  GetInitializationPerturbation() const { return this->m_InitializationPerturbation; }
 

  double GetAverageResidual()const { return this->m_pfGetAverageResidual(); }

  std::string GetName() const { return std::string("SLICImageFilter"); }

  std::string ToString() const;
 

  Image Execute(const Image &image1);
 
 
private:
  using MemberFunctionType = Image (Self::*)(const Image &image1);
  template <class TImageType> Image ExecuteInternal(const Image &image1);
    friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
    static const detail::MemberFunctionFactory<MemberFunctionType> &GetMemberFunctionFactory();
 
 
    std::vector<unsigned int> m_SuperGridSize{ std::vector<unsigned int>(3, 50) };
 
    double m_SpatialProximityWeight{ 10.0 };
 
  /* Number of iterations to run */
    uint32_t m_MaximumNumberOfIterations{ 5u };
 
    bool m_EnforceConnectivity{ true };
 
    bool m_InitializationPerturbation{ true };
 
 
 
    std::function<double()> m_pfGetAverageResidual;
 
 
    // Holder of process object for active measurements
    std::unique_ptr<itk::ProcessObject, ProcessObjectDeleter> m_Filter{nullptr};
 
 
 
};
 

SITKBasicFilters_EXPORT Image SLIC(
    const Image &image1, std::vector<unsigned int> superGridSize = std::vector<unsigned int>(3, 50), double spatialProximityWeight = 10.0, uint32_t maximumNumberOfIterations = 5u, bool enforceConnectivity = true, bool initializationPerturbation = true
);

 
}
#endif