itkBinShrinkImageFilter.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 itkBinShrinkImageFilter_h
#define itkBinShrinkImageFilter_h

#include "itkShrinkImageFilter.h"
#include <type_traits>

namespace itk
{

template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT BinShrinkImageFilter :
  public ImageToImageFilter<TInputImage,TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(BinShrinkImageFilter);

  using Self = BinShrinkImageFilter;
  using Superclass = ImageToImageFilter<TInputImage,TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkTypeMacro(BinShrinkImageFilter, ImageToImageFilter);

  using OutputImageType = TOutputImage;
  using InputImageType = TInputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;

  using OutputOffsetType = typename TOutputImage::OffsetType;
  using OutputIndexType = typename TOutputImage::IndexType;
  using InputIndexType = typename TInputImage::IndexType;

  using OutputImageRegionType = typename TOutputImage::RegionType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  using ShrinkFactorsType = FixedArray< unsigned int, ImageDimension >;

  itkSetMacro(ShrinkFactors, ShrinkFactorsType);
  void SetShrinkFactors(unsigned int factor);
  void SetShrinkFactor(unsigned int i, unsigned int factor);

  itkGetConstReferenceMacro(ShrinkFactors, ShrinkFactorsType);

  void GenerateOutputInformation() override;

  void GenerateInputRequestedRegion() override;


#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(InputConvertibleToOutputCheck,
    (Concept::Convertible<typename TInputImage::PixelType, typename TOutputImage::PixelType>));
  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<ImageDimension, OutputImageDimension>));

#endif

protected:
  BinShrinkImageFilter();
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

private:
  ShrinkFactorsType m_ShrinkFactors;

  template< class TOutputType, class TInputType >
    typename std::enable_if<std::numeric_limits<TOutputType>::is_integer, TOutputType>::type
  RoundIfInteger( TInputType input )
    {
      return Math::Round< TOutputType >( input );
    }

  // For Non-fundamental types numeric_limits is not specialized, and
  // is_integer defaults to false.
  template< class TOutputType, class TInputType >
    typename std::enable_if<!std::numeric_limits<TOutputType>::is_integer, TOutputType>::type
  RoundIfInteger( const TInputType & input, ...)
    {
      return static_cast<TOutputType>(input);
    }
};

} // end namespace itk

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

#endif