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

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

      virtual ~LabelOverlayImageFilter();

      LabelOverlayImageFilter();

      using PixelIDTypeList = BasicPixelIDTypeList;
 
\

      SITK_RETURN_SELF_TYPE_HEADER SetOpacity ( double Opacity ) { this->m_Opacity = Opacity; return *this; }

      double GetOpacity() const { return this->m_Opacity; }\

      SITK_RETURN_SELF_TYPE_HEADER SetBackgroundValue ( double BackgroundValue ) { this->m_BackgroundValue = BackgroundValue; return *this; }

      double GetBackgroundValue() const { return this->m_BackgroundValue; }\

      SITK_RETURN_SELF_TYPE_HEADER SetColormap ( std::vector<uint8_t> Colormap ) { this->m_Colormap = Colormap; return *this; }

      std::vector<uint8_t> GetColormap() const { return this->m_Colormap; }

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

      std::string ToString() const;
 

#ifndef SWIG
      Image Execute ( Image && image, const Image & labelImage );
#endif
      Image Execute ( const Image & image, const Image & labelImage );
 
 
    private:
      using MemberFunctionType = Image (Self::*)( const Image * image, const Image * labelImage );
 
      friend struct detail::DualExecuteInternalAddressor<MemberFunctionType>;
      template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image * image, const Image * labelImage );
 
 
      std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
 
 
 
      /* Value assigned to pixels outside of the mask */
      double  m_Opacity{0.5};
 
      double  m_BackgroundValue{0.0};
 
      std::vector<uint8_t>  m_Colormap{std::vector<uint8_t>()};
 
 
      bool m_InPlace{false};
    };

#ifndef SWIG
     SITKBasicFilters_EXPORT Image LabelOverlay ( Image && image, const Image & labelImage, double opacity = 0.5, double backgroundValue = 0.0, std::vector<uint8_t> colormap = std::vector<uint8_t>() );
#endif
     SITKBasicFilters_EXPORT Image LabelOverlay ( const Image & image, const Image & labelImage, double opacity = 0.5, double backgroundValue = 0.0, std::vector<uint8_t> colormap = std::vector<uint8_t>() );

}
#endif