itkCovarianceSampleFilter.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 itkCovarianceSampleFilter_h
#define itkCovarianceSampleFilter_h
 
#include "itkProcessObject.h"
 
#include "itkVariableSizeMatrix.h"
#include "itkSimpleDataObjectDecorator.h"
 
namespace itk
{
namespace Statistics
{
template <typename TSample>
class ITK_TEMPLATE_EXPORT CovarianceSampleFilter : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CovarianceSampleFilter);
 
  using Self = CovarianceSampleFilter;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using SampleType = TSample;
 
  itkOverrideGetNameOfClassMacro(CovarianceSampleFilter);
  itkNewMacro(Self);
  using MeasurementVectorType = typename SampleType::MeasurementVectorType;
 
  using MeasurementVectorSizeType = typename SampleType::MeasurementVectorSizeType;
 
  using MeasurementType = typename SampleType::MeasurementType;
 
  using MeasurementVectorRealType = typename NumericTraits<MeasurementVectorType>::RealType;
 
  using MeasurementRealType = typename NumericTraits<MeasurementType>::RealType;
 
 
  using Superclass::SetInput;
  void
  SetInput(const SampleType * sample);
 
  const SampleType *
  GetInput() const;
 
 
  using MatrixType = VariableSizeMatrix<MeasurementRealType>;
 
  const MatrixType
  GetCovarianceMatrix() const;
 
  using MatrixDecoratedType = SimpleDataObjectDecorator<MatrixType>;
  const MatrixDecoratedType *
  GetCovarianceMatrixOutput() const;
 
 
  const MeasurementVectorRealType
  GetMean() const;
 
  using MeasurementVectorDecoratedType = SimpleDataObjectDecorator<MeasurementVectorRealType>;
  const MeasurementVectorDecoratedType *
  GetMeanOutput() const;
  using OutputType = MeasurementVectorDecoratedType;
 
 
  MeasurementVectorSizeType
  GetMeasurementVectorSize() const;
 
protected:
  CovarianceSampleFilter();
  ~CovarianceSampleFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  using DataObjectPointer = DataObject::Pointer;
 
  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType index) override;
 
  void
  GenerateData() override;
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkCovarianceSampleFilter.hxx"
#endif
 
#endif