
//                                               -*- C++ -*-
/**
 * @brief HSICEstimatorTargetSensitivity implements the sensivity analysis method based on HSIC indices
 *
 *  Copyright 2005-2025 Airbus-EDF-IMACS-ONERA-Phimeca
 *
 *  This library is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef OPENTURNS_HSICESTIMATORTARGETSENSITIVITY_HXX
#define OPENTURNS_HSICESTIMATORTARGETSENSITIVITY_HXX

#include "openturns/HSICEstimatorImplementation.hxx"
#include "openturns/CovarianceModel.hxx"
#include "openturns/Sample.hxx"
#include "openturns/Function.hxx"

BEGIN_NAMESPACE_OPENTURNS

/**
 * @class HSICEstimatorTargetSensitivity
 *
 */
class OT_API HSICEstimatorTargetSensitivity
  : public HSICEstimatorImplementation
{
  CLASSNAME

public:

  typedef Collection<CovarianceModel> CovarianceModelCollection;
  typedef Collection <CovarianceMatrix>  CovarianceMatrixCollection;

  /** Default */
  HSICEstimatorTargetSensitivity();

  /** Constructor */
  HSICEstimatorTargetSensitivity(const CovarianceModelCollection & covarianceModelCollection,
                                 const Sample & X,
                                 const Sample & Y,
                                 const HSICStat & estimatorType,
                                 const Function & filterFunction);

  /** Virtual constructor */
  HSICEstimatorTargetSensitivity* clone() const override;

  /** Get the filter function */
  Function getFilterFunction() const;

  /** Get the filter function */
  void setFilterFunction(const Function & filterFunction);

  /** Method save() stores the object through the StorageManager */
  void save(Advocate & adv) const override;

  /** Method load() reloads the object from the StorageManager */
  void load(Advocate & adv) override;

protected:

  /** Compute the weights from the weight function */
  void computeWeights() override;

  /* data */
  Function filterFunction_ ;

  // unfiltered sample
  Sample unfilteredSample_;

};


END_NAMESPACE_OPENTURNS

#endif /* OPENTURNS_HSICESTIMATORTARGETSENSITIVITY_HXX */
