illuminant.h

Go to the documentation of this file.

/****************************************************************************************
 * SCYLLARUS : C++ HYPERSPECTRAL PROCESSING LIBRARY
 * illuminant.h - Hyperspectral Image illuminant recovery/estimation methods.
 *
 * This computer code is subject to copyright: 
 * (c) National ICT Australia Limited (NICTA) 2013-2014 All Rights Reserved.
 * 
 * Jeremy Oorloff, National ICT Australia (NICTA)
 *
 ***************************************************************************************/

#ifndef ILLUMINANT_H_
#define ILLUMINANT_H_

#include <armadillo>
#include "filters.h"
#include "logger.h"
#include "utility.h"
#include "scyllarus_types.h"


namespace scyl
{
    class illuminant_options
    {
    public:
        illuminant_options():
            patches(),
            alpha(50),
            patch_size(20),
            filtered_already(false),
            fast_50(true),
            order(1),
            debug(0)
        {
        }
        ~illuminant_options(){};

        arma::umat  patches;            
        float       alpha;              
        int         patch_size;         
        bool        filtered_already;   

        bool        fast_50;            
        int         order;              
        int         debug;              
    };

    arma::umat select_smooth_patches(const arma::fcube & I,
                                            arma::umat & patches,
                                            arma::fmat & light_estimation_mask,
                                            arma::fmat & contrast_mask,
                                            arma::fmat & highlight_mask,
                                                   int   patch_size=20,
                                                   int   num_patches=50,
                                                   int   debug=0);

    int patch_dichromatic_decompose(const arma::fcube & patch,
                                    const arma::fmat  & illuminant,
                                           arma::fmat & g_out,
                                           arma::fmat & k_out,
                                           arma::fvec & s_out,
                                                float & dichromatic_error,
                                                float & smooth_error,
                                                float   alpha=50,
                                                  int   debug=0);

    arma::fvec recover_global_illuminant(const arma::fcube & I,
                                   scyl::ILLUMINANT_METHOD   method=scyl::ILLUMINANT_HRK,
                                  scyl::illuminant_options   op=scyl::illuminant_options());

    arma::fvec recover_illuminant_HRK(const arma::fcube & I,
                                             arma::umat & patches,
                                                  float   alpha,
                                                    int   patch_size,
                                                   bool   filtered_already=false,
                                                   bool   fast_50=true,
                                                    int   debug=0);

    arma::fvec recover_illuminant_FS(const arma::fcube & I,
                                            arma::umat & patches,
                                                   int   patch_size=20,
                                                  bool   filtered_already=false,
                                                   int   debug=0);

    arma::fvec recover_illuminant_GE(const arma::fcube & I,
                                                   int   order=1,
                                                   int   debug=0);

    arma::fvec recover_illuminant_GW(const arma::fcube & I,
                                                   int   debug=0);

    arma::fvec recover_illuminant_SG(const arma::fcube & I,
                                                   int   order=2,
                                                   int   debug=0);

    arma::fvec recover_illuminant_WP(const arma::fcube & I,
                                                   int   debug=0);

}

#endif /* ILLUMINANT_H_ */