itkMeanImageFilter.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
 *
 *         https://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 itkMeanImageFilter_h
#define itkMeanImageFilter_h
 
#include "itkBoxImageFilter.h"
#include "itkImage.h"
#include "itkNumericTraits.h"
#include "itkVariableLengthVector.h"
 
#include <vector>
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT MeanImageFilter : public BoxImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MeanImageFilter);

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

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using Self = MeanImageFilter;
  using Superclass = BoxImageFilter<InputImageType, OutputImageType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MeanImageFilter);

  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;
  using InputRealType = typename NumericTraits<InputPixelType>::RealType;
 
  using InputImageRegionType = typename InputImageType::RegionType;
  using OutputImageRegionType = typename OutputImageType::RegionType;
 
  using InputSizeType = typename InputImageType::SizeType;
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
 
protected:
  MeanImageFilter();
  ~MeanImageFilter() override = default;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
private:
  template <typename TPixelAccessPolicy, typename TPixelType>
  static void
  GenerateDataInSubregion(const TInputImage &                              inputImage,
                          TOutputImage &                                   outputImage,
                          const ImageRegion<InputImageDimension> &         imageRegion,
                          const std::vector<Offset<InputImageDimension>> & neighborhoodOffsets,
                          const TPixelType *);
 
  template <typename TPixelAccessPolicy, typename TValue>
  static void
  GenerateDataInSubregion(const TInputImage &                              inputImage,
                          TOutputImage &                                   outputImage,
                          const ImageRegion<InputImageDimension> &         imageRegion,
                          const std::vector<Offset<InputImageDimension>> & neighborhoodOffsets,
                          const VariableLengthVector<TValue> *);
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMeanImageFilter.hxx"
#endif
 
#endif