itkMaskedStatisticsImageFilter.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
*
*         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 itkMaskedStatisticsImageFilter_h
#define itkMaskedStatisticsImageFilter_h
 
#include <itkImageToImageFilter.h>
#include <itkNumericTraits.h>
#include <itkArray.h>
#include <itkSimpleDataObjectDecorator.h>
 
namespace itk
{
  template< typename TInputImage , typename TMaskImage = ::itk::Image<unsigned char, TInputImage::ImageDimension> >
  class MaskedStatisticsImageFilter:
    public ImageToImageFilter< TInputImage, TInputImage >
  {
  public:
    typedef MaskedStatisticsImageFilter                          Self;
    typedef ImageToImageFilter< TInputImage, TInputImage > Superclass;
    typedef SmartPointer< Self >                           Pointer;
    typedef SmartPointer< const Self >                     ConstPointer;
 
    itkNewMacro(Self);
 
    itkTypeMacro(MaskedStatisticsImageFilter, ImageToImageFilter);
 
    typedef typename Superclass::InputImageType InputImageType;
    typedef typename Superclass::InputImagePointer InputImagePointer;
 
    typedef typename TInputImage::RegionType RegionType;
    typedef typename TInputImage::SizeType   SizeType;
    typedef typename TInputImage::IndexType  IndexType;
    typedef typename TInputImage::PixelType  PixelType;
 
    itkStaticConstMacro(ImageDimension, unsigned int,
      TInputImage::ImageDimension);
 
    typedef typename NumericTraits< PixelType >::RealType RealType;
 
    typedef typename DataObject::Pointer DataObjectPointer;
 
    typedef SimpleDataObjectDecorator< RealType >  RealObjectType;
    typedef SimpleDataObjectDecorator< PixelType > PixelObjectType;
 
    typedef TMaskImage MaskImageType;
    typedef typename MaskImageType::ConstPointer     MaskImageConstPointer;
    typedef typename MaskImageType::RegionType  MaskImageRegionType;
 
    PixelType GetMinimum() const
    { return this->GetMinimumOutput()->Get(); }
    PixelObjectType * GetMinimumOutput();
 
    const PixelObjectType * GetMinimumOutput() const;
 
    PixelType GetMaximum() const
    { return this->GetMaximumOutput()->Get(); }
    PixelObjectType * GetMaximumOutput();
 
    const PixelObjectType * GetMaximumOutput() const;
 
    RealType GetMean() const
    { return this->GetMeanOutput()->Get(); }
    RealObjectType * GetMeanOutput();
 
    const RealObjectType * GetMeanOutput() const;
 
    RealType GetSigma() const
    { return this->GetSigmaOutput()->Get(); }
    RealObjectType * GetSigmaOutput();
 
    const RealObjectType * GetSigmaOutput() const;
 
    RealType GetVariance() const
    { return this->GetVarianceOutput()->Get(); }
    RealObjectType * GetVarianceOutput();
 
    const RealObjectType * GetVarianceOutput() const;
 
    RealType GetSum() const
    { return this->GetSumOutput()->Get(); }
    RealObjectType * GetSumOutput();
 
    const RealObjectType * GetSumOutput() const;
 
    typedef ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
    using Superclass::MakeOutput;
    DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) override;
 
    itkSetConstObjectMacro(Mask, MaskImageType);
    itkGetConstObjectMacro(Mask, MaskImageType);
 
#ifdef ITK_USE_CONCEPT_CHECKING
    // Begin concept checking
    itkConceptMacro( InputHasNumericTraitsCheck,
      ( Concept::HasNumericTraits< PixelType > ) );
    // End concept checking
#endif
 
  protected:
    MaskedStatisticsImageFilter();
    ~MaskedStatisticsImageFilter() override{}
    void PrintSelf(std::ostream & os, Indent indent) const override;
 
    void AllocateOutputs() override;
 
    void BeforeThreadedGenerateData() override;
 
    void AfterThreadedGenerateData() override;
 
    void  ThreadedGenerateData(const RegionType &
      outputRegionForThread,
      ThreadIdType threadId) override;
 
    // Override since the filter needs all the data for the algorithm
    void GenerateInputRequestedRegion() override;
 
    // Override since the filter produces all of its output
    void EnlargeOutputRequestedRegion(DataObject *data) override;
 
  private:
    MaskedStatisticsImageFilter(const Self &); //purposely not implemented
    void operator=(const Self &);        //purposely not implemented
 
    Array< RealType >       m_ThreadSum;
    Array< RealType >       m_SumOfSquares;
    Array< SizeValueType >  m_Count;
    Array< PixelType >      m_ThreadMin;
    Array< PixelType >      m_ThreadMax;
    MaskImageConstPointer        m_Mask;
  }; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include <itkMaskedStatisticsImageFilter.tpp>
#endif
 
#endif