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
|
/*=========================================================================
*
* 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 itkWeightedMeanSampleFilter_h
#define itkWeightedMeanSampleFilter_h
#include "itkMeanSampleFilter.h"
#include "itkFunctionBase.h"
#include "itkDataObjectDecorator.h"
namespace itk
{
namespace Statistics
{
/**
* \class WeightedMeanSampleFilter
* \brief Given a sample where each measurement vector has
* associated weight value, this filter computes the sample mean
*
* To run this algorithm, you have plug in the target sample data
* using SetInput method and provides weight by an array or function.
*. Then call the Update method to run the algorithm.
*
* \sa MeanSampleFilter
*
* \ingroup ITKStatistics
*/
template <typename TSample>
class ITK_TEMPLATE_EXPORT WeightedMeanSampleFilter : public MeanSampleFilter<TSample>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(WeightedMeanSampleFilter);
/**Standard class type aliases. */
using Self = WeightedMeanSampleFilter;
using Superclass = MeanSampleFilter<TSample>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/**Standard Macros */
itkOverrideGetNameOfClassMacro(WeightedMeanSampleFilter);
itkNewMacro(Self);
/** Types derived from the base class */
using typename Superclass::SampleType;
using typename Superclass::MeasurementVectorType;
using typename Superclass::MeasurementVectorSizeType;
using typename Superclass::MeasurementType;
/** Types derived from the base class */
using typename Superclass::MeasurementVectorRealType;
using typename Superclass::MeasurementRealType;
/** Type of weight values */
using WeightValueType = double;
/** Array type for weights */
using WeightArrayType = Array<WeightValueType>;
/** Type of DataObjects to use for the weight array type */
using InputWeightArrayObjectType = SimpleDataObjectDecorator<WeightArrayType>;
/** Method to set/get the input value of the weight array */
itkSetGetDecoratedInputMacro(Weights, WeightArrayType);
/** Weight calculation function type */
using WeightingFunctionType = FunctionBase<MeasurementVectorType, WeightValueType>;
/** Type of DataObjects to use for Weight function */
using InputWeightingFunctionObjectType = DataObjectDecorator<WeightingFunctionType>;
/** Method to set/get the weighting function */
itkSetGetDecoratedObjectInputMacro(WeightingFunction, WeightingFunctionType);
/** Types derived from the base class */
using typename Superclass::MeasurementVectorDecoratedType;
using typename Superclass::OutputType;
protected:
WeightedMeanSampleFilter();
~WeightedMeanSampleFilter() override = default;
void
GenerateData() override;
// compute mean with weight array
void
ComputeMeanWithWeights();
// compute mean using a weighting function
void
ComputeMeanWithWeightingFunction();
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkWeightedMeanSampleFilter.hxx"
#endif
#endif
|