itkWeightedMeanSampleFilter.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 itkWeightedMeanSampleFilter_h
#define itkWeightedMeanSampleFilter_h
 
#include "itkMeanSampleFilter.h"
#include "itkFunctionBase.h"
#include "itkDataObjectDecorator.h"
 
namespace itk
{
namespace Statistics
{
template <typename TSample>
class ITK_TEMPLATE_EXPORT WeightedMeanSampleFilter : public MeanSampleFilter<TSample>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(WeightedMeanSampleFilter);

  using Self = WeightedMeanSampleFilter;
  using Superclass = MeanSampleFilter<TSample>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(WeightedMeanSampleFilter);
  itkNewMacro(Self);

  using typename Superclass::SampleType;
  using typename Superclass::MeasurementVectorType;
  using typename Superclass::MeasurementVectorSizeType;
  using typename Superclass::MeasurementType;

  using typename Superclass::MeasurementVectorRealType;
  using typename Superclass::MeasurementRealType;
 

  using WeightValueType = double;
 

  using WeightArrayType = Array<WeightValueType>;

  using InputWeightArrayObjectType = SimpleDataObjectDecorator<WeightArrayType>;

  itkSetGetDecoratedInputMacro(Weights, WeightArrayType);
 

  using WeightingFunctionType = FunctionBase<MeasurementVectorType, WeightValueType>;

  using InputWeightingFunctionObjectType = DataObjectDecorator<WeightingFunctionType>;

  itkSetGetDecoratedObjectInputMacro(WeightingFunction, WeightingFunctionType);
 

  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