data_input.h

Go to the documentation of this file.

/****************************************************************************************
 * SCYLLARUS : C++ HYPERSPECTRAL PROCESSING LIBRARY
 * data_input.h - Generic data input class.
 *
 * 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 DATAINPUT_H_
#define DATAINPUT_H_

#include "input.h"
#include "logger.h"
#include "utility.h"
#include "scyllarus_types.h"

#include <armadillo>

namespace scyl
{

class data_input: public scyl::input
{

public:

    data_input();

    virtual ~data_input();

    arma::fcube         I() const;

    const arma::fcube * I_ptr() const;

    arma::fvec          illuminant() const;

    arma::fmat          k() const;

    arma::fmat          g() const;

    arma::fcube         s() const;

    const arma::fcube * s_ptr() const;

    arma::fmat          elements() const;

    arma::fcube         element_abundances() const;

    arma::ucube         element_abundance_indexes() const;

    arma::fmat          endmembers() const;

    std::vector<std::string> endmember_labels() const;

    arma::fmat          endmember_abundances() const;

    arma::umat          endmember_abundance_indexes() const;

    arma::fvec          wavelengths() const;


    // Setters (specific to this class only)

    void                set_I(const arma::fcube & in);

    void                set_illuminant(const arma::fvec & in);

    void                set_k(const arma::fmat & in);

    void                set_g(const arma::fmat & in);

    void                set_s(const arma::fcube & in);

    void                set_elements(const arma::fmat & in);

    void                set_element_abundances(const arma::fcube & in);

    void                set_element_abundance_indexes(const arma::ucube & in);

    void                set_endmembers(const arma::fmat & in);

    void                set_endmember_abundances(const arma::fmat & in);

    void                set_endmember_abundance_indexes(const arma::umat & in);

    void                set_endmember_labels(const std::vector<std::string> & in);

    void                set_wavelengths(const arma::fvec & in);

    scyl::INPUT_TYPE    type();


private:

    arma::fcube m_I;
    arma::fvec  m_illuminant;
    arma::fmat  m_k;
    arma::fmat  m_g;
    arma::fcube m_s;
    arma::fmat  m_elements;
    arma::fcube m_element_abundances;
    arma::ucube m_element_abundance_indexes;
    arma::fmat  m_endmembers;
    arma::fmat  m_endmember_abundances;
    arma::umat  m_endmember_abundance_indexes;
    std::vector<std::string> m_endmember_labels;
    arma::fvec  m_wavelengths;

};

}
#endif /* DATAINPUT_H_ */