sitkExtractImageFilter.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 sitkExtractImageFilter_h
#define sitkExtractImageFilter_h
 
#include <memory>
 
#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"
 
namespace itk::simple
{

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

  virtual ~ExtractImageFilter();

  ExtractImageFilter();

  using PixelIDTypeList = NonLabelPixelIDTypeList;

  SITK_RETURN_SELF_TYPE_HEADER
  SetSize(std::vector<unsigned int> Size)
  {
    this->m_Size = std::move(Size);
    return *this;
  }

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

  SITK_RETURN_SELF_TYPE_HEADER
  SetIndex(std::vector<int> Index)
  {
    this->m_Index = std::move(Index);
    return *this;
  }

  std::vector<int>
  GetIndex() const
  {
    return this->m_Index;
  }
 
  typedef enum
  {
    DIRECTIONCOLLAPSETOUNKOWN,
    DIRECTIONCOLLAPSETOIDENTITY,
    DIRECTIONCOLLAPSETOSUBMATRIX,
    DIRECTIONCOLLAPSETOGUESS
  } DirectionCollapseToStrategyType;

  SITK_RETURN_SELF_TYPE_HEADER
  SetDirectionCollapseToStrategy(DirectionCollapseToStrategyType DirectionCollapseToStrategy)
  {
    this->m_DirectionCollapseToStrategy = DirectionCollapseToStrategy;
    return *this;
  }

  DirectionCollapseToStrategyType
  GetDirectionCollapseToStrategy() const
  {
    return this->m_DirectionCollapseToStrategy;
  }

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

  std::string
  ToString() const;
 

#ifndef SWIG
  Image
  Execute(Image && image1);
#endif
  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>;
 
  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType>> m_MemberFactory;
 
 
  template <class TImageType, unsigned int OutputDimension>
  Image
  ExecuteInternal(const TImageType *                                    image1,
                  unsigned int                                          outputDimension,
                  std::integral_constant<unsigned int, OutputDimension> meta);
  template <class TImageType>
  Image
  ExecuteInternal(const TImageType *                      image1,
                  unsigned int                            outputDimension,
                  std::integral_constant<unsigned int, 1> meta);
 
 
  std::vector<unsigned int> m_Size{ std::vector<unsigned int>(SITK_MAX_DIMENSION, 1) };
 
  std::vector<int> m_Index{ std::vector<int>(SITK_MAX_DIMENSION, 0) };
 
  DirectionCollapseToStrategyType m_DirectionCollapseToStrategy{
    itk::simple::ExtractImageFilter::DIRECTIONCOLLAPSETOGUESS
  };
 
 
  bool m_InPlace{ false };
};

#ifndef SWIG
SITKBasicFilters_EXPORT Image
Extract(Image &&                                            image1,
        std::vector<unsigned int>                           size = std::vector<unsigned int>(SITK_MAX_DIMENSION, 1),
        std::vector<int>                                    index = std::vector<int>(SITK_MAX_DIMENSION, 0),
        ExtractImageFilter::DirectionCollapseToStrategyType directionCollapseToStrategy =
          itk::simple::ExtractImageFilter::DIRECTIONCOLLAPSETOGUESS);
#endif
SITKBasicFilters_EXPORT Image
Extract(const Image &                                       image1,
        std::vector<unsigned int>                           size = std::vector<unsigned int>(SITK_MAX_DIMENSION, 1),
        std::vector<int>                                    index = std::vector<int>(SITK_MAX_DIMENSION, 0),
        ExtractImageFilter::DirectionCollapseToStrategyType directionCollapseToStrategy =
          itk::simple::ExtractImageFilter::DIRECTIONCOLLAPSETOGUESS);

} // namespace itk::simple
#endif