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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
|
/*=========================================================================
*
* 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 itkStatisticsImageFilter_h
#define itkStatisticsImageFilter_h
#include "itkImageToImageFilter.h"
#include "itkNumericTraits.h"
#include "itkArray.h"
#include "itkSimpleDataObjectDecorator.h"
namespace itk
{
/** \class StatisticsImageFilter
* \brief Compute min. max, variance and mean of an Image.
*
* StatisticsImageFilter computes the minimum, maximum, sum, mean, variance
* sigma of an image. The filter needs all of its input image. It
* behaves as a filter with an input and output. Thus it can be inserted
* in a pipline with other filters and the statistics will only be
* recomputed if a downstream filter changes.
*
* The filter passes its input through unmodified. The filter is
* threaded. It computes statistics in each thread then combines them in
* its AfterThreadedGenerate method.
*
* \ingroup MathematicalStatisticsImageFilters
* \ingroup ITKImageStatistics
*
* \wiki
* \wikiexample{Statistics/StatisticsImageFilter,Compute min\, max\, variance and mean of an Image.}
* \endwiki
*/
template< typename TInputImage >
class ITK_TEMPLATE_EXPORT StatisticsImageFilter:
public ImageToImageFilter< TInputImage, TInputImage >
{
public:
/** Standard Self typedef */
typedef StatisticsImageFilter Self;
typedef ImageToImageFilter< TInputImage, TInputImage > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Runtime information support. */
itkTypeMacro(StatisticsImageFilter, ImageToImageFilter);
/** Image related typedefs. */
typedef typename TInputImage::Pointer InputImagePointer;
typedef typename TInputImage::RegionType RegionType;
typedef typename TInputImage::SizeType SizeType;
typedef typename TInputImage::IndexType IndexType;
typedef typename TInputImage::PixelType PixelType;
/** Image related typedefs. */
itkStaticConstMacro(ImageDimension, unsigned int,
TInputImage::ImageDimension);
/** Type to use for computations. */
typedef typename NumericTraits< PixelType >::RealType RealType;
/** Smart Pointer type to a DataObject. */
typedef typename DataObject::Pointer DataObjectPointer;
/** Type of DataObjects used for scalar outputs */
typedef SimpleDataObjectDecorator< RealType > RealObjectType;
typedef SimpleDataObjectDecorator< PixelType > PixelObjectType;
/** Return the computed Minimum. */
PixelType GetMinimum() const
{ return this->GetMinimumOutput()->Get(); }
PixelObjectType * GetMinimumOutput();
const PixelObjectType * GetMinimumOutput() const;
/** Return the computed Maximum. */
PixelType GetMaximum() const
{ return this->GetMaximumOutput()->Get(); }
PixelObjectType * GetMaximumOutput();
const PixelObjectType * GetMaximumOutput() const;
/** Return the computed Mean. */
RealType GetMean() const
{ return this->GetMeanOutput()->Get(); }
RealObjectType * GetMeanOutput();
const RealObjectType * GetMeanOutput() const;
/** Return the computed Standard Deviation. */
RealType GetSigma() const
{ return this->GetSigmaOutput()->Get(); }
RealObjectType * GetSigmaOutput();
const RealObjectType * GetSigmaOutput() const;
/** Return the computed Variance. */
RealType GetVariance() const
{ return this->GetVarianceOutput()->Get(); }
RealObjectType * GetVarianceOutput();
const RealObjectType * GetVarianceOutput() const;
/** Return the compute Sum. */
RealType GetSum() const
{ return this->GetSumOutput()->Get(); }
RealObjectType * GetSumOutput();
const RealObjectType * GetSumOutput() const;
/** Make a DataObject of the correct type to be used as the specified
* output. */
typedef ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
using Superclass::MakeOutput;
virtual DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) ITK_OVERRIDE;
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro( InputHasNumericTraitsCheck,
( Concept::HasNumericTraits< PixelType > ) );
// End concept checking
#endif
protected:
StatisticsImageFilter();
~StatisticsImageFilter() ITK_OVERRIDE {}
void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** Pass the input through unmodified. Do this by Grafting in the
* AllocateOutputs method.
*/
void AllocateOutputs() ITK_OVERRIDE;
/** Initialize some accumulators before the threads run. */
void BeforeThreadedGenerateData() ITK_OVERRIDE;
/** Do final mean and variance computation from data accumulated in threads.
*/
void AfterThreadedGenerateData() ITK_OVERRIDE;
/** Multi-thread version GenerateData. */
void ThreadedGenerateData(const RegionType &
outputRegionForThread,
ThreadIdType threadId) ITK_OVERRIDE;
// Override since the filter needs all the data for the algorithm
void GenerateInputRequestedRegion() ITK_OVERRIDE;
// Override since the filter produces all of its output
void EnlargeOutputRequestedRegion(DataObject *data) ITK_OVERRIDE;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(StatisticsImageFilter);
Array< RealType > m_ThreadSum;
Array< RealType > m_SumOfSquares;
Array< SizeValueType > m_Count;
Array< PixelType > m_ThreadMin;
Array< PixelType > m_ThreadMax;
}; // end of class
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkStatisticsImageFilter.hxx"
#endif
#endif
|