core/ica.hh

Go to the documentation of this file.

/* -*- mia-c++  -*-
 *
 * This file is part of MIA - a toolbox for medical image analysis
 * Copyright (c) Leipzig, Madrid 1999-2017 Gert Wollny
 *
 * MIA is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MIA; if not, see <http://www.gnu.org/licenses/>.
 *
 */
 
 
#ifndef mia_core_ICAANALYSISBASE_HH
#define mia_core_ICAANALYSISBASE_HH
 
#include <memory>
#include <set>
#include <boost/concept/requires.hpp>
#include <boost/concept_check.hpp>
 
#include <mia/core/defines.hh>
#include <mia/core/slopevector.hh>
#include <mia/core/factory.hh>
 
namespace mia
{
 
class EXPORT_CORE CIndepCompAnalysis
{
public:

       enum EApproach {
              appr_defl, 
              appr_symm,  
              appr_unknown
       };
 
       typedef std::unique_ptr<CIndepCompAnalysis> Pointer;

       typedef std::set<unsigned int> IndexSet;
 
       virtual ~CIndepCompAnalysis();

       template <class Iterator>
       BOOST_CONCEPT_REQUIRES(((::boost::ForwardIterator<Iterator>)),
                              (void))
       set_row(unsigned row, Iterator begin, Iterator end);
 
 
       virtual void initialize(unsigned int series_length, unsigned int slice_size) = 0;
       virtual bool run(unsigned int nica, std::vector<std::vector<float>> guess) = 0;

       virtual std::vector<float> get_feature_row(unsigned int row)const = 0;

       virtual std::vector<float> get_mix_series(unsigned int row)const = 0;

       virtual std::vector<float> get_mix(unsigned int idx)const = 0;

       virtual std::vector<float> get_incomplete_mix(unsigned int idx, const IndexSet& skip)const = 0;

       virtual std::vector<float> get_partial_mix(unsigned int idx, const IndexSet& use)const = 0;

       virtual std::vector<float> get_delta_feature(const IndexSet& plus, const IndexSet& minus)const = 0;

       virtual void set_mixing_series(unsigned int index, const std::vector<float>& series) = 0;

       virtual CSlopeColumns   get_mixing_curves() const = 0;

       virtual void normalize_ICs() = 0;

       virtual std::vector<float> normalize_Mix() = 0;
 

       virtual unsigned int get_ncomponents() const = 0;

       virtual void set_max_iterations(int n) = 0;

       virtual void set_approach(EApproach approach) = 0;
 
       virtual void set_deterministic_seed(int seed)  = 0;
private:
       virtual void set_row_internal(unsigned row, const std::vector<double>&  buffer, double mean) = 0;
 
};
 
typedef CIndepCompAnalysis::Pointer PIndepCompAnalysis;
 
 
class EXPORT_CORE CIndepCompAnalysisFactory : public CProductBase
{
public:
       static const char *data_descr;
       static const char *type_descr;
 
       typedef CIndepCompAnalysisFactory plugin_type;
       typedef CIndepCompAnalysisFactory plugin_data;
 
       CIndepCompAnalysisFactory();
       virtual ~CIndepCompAnalysisFactory();
       void set_deterministic_seed(int seed);
       CIndepCompAnalysis *create() const __attribute__((warn_unused_result));
private:
       virtual CIndepCompAnalysis *do_create() const __attribute__((warn_unused_result)) = 0;
       int m_deterministic_seed;
};
 
 
typedef TFactory<CIndepCompAnalysisFactory> CIndepCompAnalysisFactoryPlugin;
 
typedef std::shared_ptr<CIndepCompAnalysisFactory> PIndepCompAnalysisFactory;

typedef THandlerSingleton<TFactoryPluginHandler<CIndepCompAnalysisFactoryPlugin>>
              CIndepCompAnalysisFactoryPluginHandler;
 
 
template<>  const char *const
TPluginHandler<TFactory<CIndepCompAnalysisFactory>>::m_help;
 
extern template class EXPORT_CORE  TPluginHandler<TFactory<CIndepCompAnalysisFactory>>;

FACTORY_TRAIT(CIndepCompAnalysisFactoryPluginHandler);
 
 
 
inline PIndepCompAnalysisFactory produce_ica_factory(const std::string& descr)
{
       return CIndepCompAnalysisFactoryPluginHandler::instance().produce(descr);
}
 
 

template <class Iterator>
BOOST_CONCEPT_REQUIRES(((::boost::ForwardIterator<Iterator>)),
                       (void))
CIndepCompAnalysis::set_row(unsigned row, Iterator begin, Iterator end)
{
       const unsigned int length = std::distance(begin, end);
       std::vector<double> buffer(length);
       unsigned int idx = 0;
       double mean = 0.0;
 
       while (begin != end)
              mean += (buffer[idx++] = *begin++);
 
       mean /= length;
 
       for (unsigned int i = 0; i < length; ++i)
              buffer[i] -= mean;
 
       set_row_internal(row, buffer, mean);
}
 
}
 
#endif // CICAANALYSISBASE_HH