otbVirtualDimensionality.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbVirtualDimensionality_h
#define otbVirtualDimensionality_h
 
#include "itkObjectFactory.h"
#include "itkLightObject.h"
#include "vnl/vnl_vector.h"
#include "vnl/vnl_matrix.h"
#include "vnl/algo/vnl_symmetric_eigensystem.h"
 
namespace otb
{
 
template <class TPrecision>
class ITK_EXPORT VirtualDimensionality : public itk::LightObject
{
public:
  typedef VirtualDimensionality         Self;
  typedef itk::LightObject              Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(VirtualDimensionality, itk::LightObject);
 
  typedef TPrecision PrecisionType;
 
  typedef vnl_vector<PrecisionType> VectorType;
  typedef vnl_matrix<PrecisionType> MatrixType;
 
  void SetCovariance(const MatrixType& m)
  {
    m_Covariance = m;
  }
 
  void SetCorrelation(const MatrixType& m)
  {
    m_Correlation = m;
  }
 
  void SetNumberOfPixels(unsigned int n)
  {
    m_NumberOfPixels = n;
  }
 
  void SetFAR(double falseAlarmRate)
  {
    if (falseAlarmRate < 0)
      falseAlarmRate = 0;
 
    if (falseAlarmRate > 1)
      falseAlarmRate = 1;
 
    m_FAR = falseAlarmRate;
  }
 
  double GetFAR()
  {
    return m_FAR;
  }
 
  void Compute();
 
  unsigned int GetNumberOfEndmembers()
  {
    return m_NumberOfEndmembers;
  }
 
protected:
  VirtualDimensionality();
  ~VirtualDimensionality() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  VirtualDimensionality(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  MatrixType m_Covariance;
  MatrixType m_Correlation;
 
  unsigned int m_NumberOfPixels;
  unsigned int m_NumberOfEndmembers;
  double       m_FAR;
};
}
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbVirtualDimensionality.hxx"
#endif
 
#endif