sitkSLICImageFilter.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 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.in to make changes.
 */

#include <memory>

#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"

namespace itk {
  namespace simple {

    class SITKBasicFilters_EXPORT SLICImageFilter : public ImageFilter<1> {
    public:
      typedef SLICImageFilter Self;

      virtual ~SLICImageFilter();

      SLICImageFilter();

      typedef typelist::Append<BasicPixelIDTypeList, VectorPixelIDTypeList>::Type  PixelIDTypeList;



      SITK_RETURN_SELF_TYPE_HEADER SetSuperGridSize ( const std::vector<unsigned int> & SuperGridSize ) { this->m_SuperGridSize = SuperGridSize; return *this; }

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

      SITK_RETURN_SELF_TYPE_HEADER SetSpatialProximityWeight ( double SpatialProximityWeight ) { this->m_SpatialProximityWeight = SpatialProximityWeight; return *this; }

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

      SITK_RETURN_SELF_TYPE_HEADER SetMaximumNumberOfIterations ( uint32_t MaximumNumberOfIterations ) { this->m_MaximumNumberOfIterations = MaximumNumberOfIterations; return *this; }

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

      SITK_RETURN_SELF_TYPE_HEADER SetEnforceConnectivity ( bool EnforceConnectivity ) { this->m_EnforceConnectivity = EnforceConnectivity; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER EnforceConnectivityOn() { return this->SetEnforceConnectivity(true); }
      SITK_RETURN_SELF_TYPE_HEADER EnforceConnectivityOff() { return this->SetEnforceConnectivity(false); }

        bool GetEnforceConnectivity() const { return this->m_EnforceConnectivity; }

      SITK_RETURN_SELF_TYPE_HEADER SetInitializationPerturbation ( bool InitializationPerturbation ) { this->m_InitializationPerturbation = InitializationPerturbation; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER InitializationPerturbationOn() { return this->SetInitializationPerturbation(true); }
      SITK_RETURN_SELF_TYPE_HEADER 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 );


      Image Execute ( const Image& image1, const std::vector<unsigned int> & superGridSize, double spatialProximityWeight, uint32_t maximumNumberOfIterations, bool enforceConnectivity, bool initializationPerturbation );

    private:

      typedef Image (Self::*MemberFunctionType)( const Image& image1 );
      template <class TImageType> Image ExecuteInternal ( const Image& image1 );


      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;

      nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;


      /*  */
      std::vector<unsigned int>  m_SuperGridSize;
      double  m_SpatialProximityWeight;
      /* Number of iterations to run */
      uint32_t  m_MaximumNumberOfIterations;
      bool  m_EnforceConnectivity;
      bool  m_InitializationPerturbation;

      nsstd::function<double()> m_pfGetAverageResidual;

      // Holder of process object for active measurements
      itk::ProcessObject *m_Filter;
    };


     SITKBasicFilters_EXPORT Image SLIC ( const Image& image1, const 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