spectral_library.h

Go to the documentation of this file.

/****************************************************************************************
 * SCYLLARUS : C++ HYPERSPECTRAL PROCESSING LIBRARY
 * spectral_library.h - Hyperspectral Signature IO Helper Object
 *
 * 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 SPECTRAL_LIBRARY_H_
#define SPECTRAL_LIBRARY_H_

#include <armadillo>
#include <iso646.h>
#include <tuple>
#include <map>

#include "iotools/slz.h"
#include "logger.h"
#include "utility.h"

namespace scyl
{

class spectral_library
{
public:

    spectral_library();                                 // Spectral Library with blank fields (Insert data for saving)

    spectral_library(std::string filename);             // Spectral Library populated by a slz file

    spectral_library(arma::fvec   wavelengths,          // Spectral Library populated at time of construction.
         std::vector<std::string>   labels,
                     arma::fmat   endmembers);

    virtual ~spectral_library();

    // IO operations

    void load(std::string filename);

    void save(std::string filename);

    // Setters and Getters

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

    void                     set_metadata(const std::string & in);
    std::string              metadata() const;

    std::vector<std::string> labels(std::string filename="") const;

    std::vector<std::string> loaded_files() const;
    std::vector<std::string> loaded_file_list() const;


    void                     set_endmembers(const arma::fmat & in_endmembers,
                              const std::vector<std::string> & in_labels);

    arma::fmat               endmembers(std::string label="", std::string filename="") const;

    arma::fmat               endmembers_mean() const;
    std::vector<std::string> labels_mean() const;

    void                     add_endmembers(const arma::fmat & in_endmembers,
                              const std::vector<std::string> & in_labels,
                                                 std::string   filename="");

    void                     delete_endmembers(std::string   label="",
                                               std::string   filename="");

    void                     add_library(std::string   filename,
                                                bool   re_evaluate=false);

    void                     add_library(scyl::spectral_library & in,
                                                    std::string   name="nofile",
                                                           bool   re_evaluate=false);

    unsigned int bands();
    unsigned int num_endmembers();
    void         print();

private:

    arma::fvec m_wavelengths;

    std::vector<std::tuple<std::string, std::string, arma::fvec>> m_endmember_list;

    scyl::iotools::slz m_slz;

    unsigned int m_bands;

    std::string m_metadata;
};

}

#endif /* SPECTRAL_LIBRARY_H_ */