1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
/*=========================================================================
*
* 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 itkMovingHistogramImageFilter_h
#define itkMovingHistogramImageFilter_h
#include "itkMovingHistogramImageFilterBase.h"
namespace itk
{
/**
* \class MovingHistogramImageFilter
* \brief Implements a generic moving histogram algorithm
*
* This filter is a base class to implement efficiently many neighborhood
* filters. Instead of visiting all the neighbors of a pixel, the set
* of pixels in the neighborhood is updated when the filter is moving
* to a new pixel. The number of pixels read for each pixel can be very
* smaller than the number of pixels read by a basic algorithm.
*
* This filter moves the neighborhood over all the pixels of the output requested region,
* and pass the pixel added and removed of the neighborhood to the an
* histogram class. This filter doesn't implement the histogram class - it
* must be implement and passed as template parameter. The histogram class
* is not necessary a real histogram. It can be implemented in many ways,
* and only has to provide the methods described below.
*
* This filter takes 4 template parameters: the input and output image type,
* the structuring element (or kernel) type, and the histogram type.
* The input and output image must have the same number of dimension.
*
* The histogram type is a class which has to implements six methods:
* + a default constructor which takes no parameter.
* + void AddPixel( const InputPixelType &p ) is called when a new pixel
* is added to the histogram.
* + void RemovePixel( const InputPixelType &p ) is called when a pixel
* is removed of the histogram.
* + void AddBoundary() is called when a pixel outside the image is added.
* No value is provided: it's the responsibility to the histogram class to
* get it if needed. This method can be kept empty to ignore the boundary
* pixels.
* + void RemoveBoundary() is called to when a pixel outside the image is removed.
* No value is provided: it's the responsibility to the histogram class to
* get it if needed. This method can be kept empty to ignore the boundary
* pixels.
* + AType GetValue() is called to set the value of the output image. AType
* must be the output pixel type, or a type castable to the output pixel type.
*
* MovingHistogramImageFilter add the new pixels before removing the old ones,
* so, if AddBoundary() is implemented and/or the kernel is symetric, it is safe
* to consider that the histogram will never be empty.
*
* One histogram is created for each thread by the method NewHistogram().
* The NewHistogram() method can be overiden to pass some parameters to the
* histogram.
*
* The neighborhood is defined by a structuring element, and must a
* itk::Neighborhood object or a subclass.
* The structuring element is assumed to be composed of binary
* values (zero or one). Only elements of the structuring element
* having values > 0 are candidates for affecting the center pixel.
*
* \sa MovingWindowMeanImageFilter, RankImageFilter, MaskedMovingHistogramImageFilter,
* \sa MovingHistogramMorphologicalGradientImageFilter
* \ingroup ImageEnhancement MathematicalMorphologyImageFilters
*
* \author Gaetan Lehmann
* \author Richard Beare
* \ingroup ITKImageFilterBase
*/
template< typename TInputImage, typename TOutputImage, typename TKernel, typename THistogram >
class ITK_TEMPLATE_EXPORT MovingHistogramImageFilter:
public MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >
{
public:
/** Standard class typedefs. */
typedef MovingHistogramImageFilter Self;
typedef MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Standard New method. */
itkNewMacro(Self);
/** Runtime information support. */
itkTypeMacro(MovingHistogramImageFilter,
MovingHistogramImageFilter);
/** Image related typedefs. */
typedef TInputImage InputImageType;
typedef TOutputImage OutputImageType;
typedef typename TInputImage::RegionType RegionType;
typedef typename TInputImage::SizeType SizeType;
typedef typename TInputImage::IndexType IndexType;
typedef typename TInputImage::PixelType PixelType;
typedef typename TInputImage::OffsetType OffsetType;
typedef typename Superclass::OutputImageRegionType OutputImageRegionType;
typedef typename TOutputImage::PixelType OutputPixelType;
/** Image related typedefs. */
itkStaticConstMacro(ImageDimension, unsigned int,
TInputImage::ImageDimension);
/** Kernel typedef. */
typedef TKernel KernelType;
/** Kernel (structuring element) iterator. */
typedef typename KernelType::ConstIterator KernelIteratorType;
/** n-dimensional Kernel radius. */
typedef typename KernelType::SizeType RadiusType;
typedef typename std::list< OffsetType > OffsetListType;
typedef typename std::map< OffsetType, OffsetListType, typename OffsetType::LexicographicCompare > OffsetMapType;
/** Configure the histogram.
* Subclasses must override this method. */
virtual void ConfigureHistogram(THistogram &) {}
protected:
MovingHistogramImageFilter();
~MovingHistogramImageFilter() ITK_OVERRIDE {}
/** Multi-thread version GenerateData. */
void ThreadedGenerateData(const OutputImageRegionType &
outputRegionForThread,
ThreadIdType threadId) ITK_OVERRIDE;
// declare the type used to store the histogram
typedef THistogram HistogramType;
void PushHistogram(HistogramType & histogram,
const OffsetListType *addedList,
const OffsetListType *removedList,
const RegionType & inputRegion,
const RegionType & kernRegion,
const InputImageType *inputImage,
const IndexType currentIdx);
private:
ITK_DISALLOW_COPY_AND_ASSIGN(MovingHistogramImageFilter);
}; // end of class
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMovingHistogramImageFilter.hxx"
#endif
#endif
|