heat_map.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_COLOR_HEAT_MAP_H_
#define GENESIS_UTILS_COLOR_HEAT_MAP_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2023 Lucas Czech
 
    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include "genesis/utils/containers/matrix.hpp"
#include "genesis/utils/color/color.hpp"
#include "genesis/utils/color/map.hpp"
 
#include <limits>
#include <memory>
#include <string>
#include <vector>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Heat Map Parameters
// =================================================================================================
 
struct HeatmapParameters
{
    // -------------------------------------------------------------------------
    //     Typedefs and Enums
    // -------------------------------------------------------------------------
 
    enum class ColorNorm
    {
        kLinear,
        kLogarithmic,
        kDiverging
    };
 
    enum class NormalizationRange
    {
        kAll,
        kRow,
        kCol
    };
 
    // -------------------------------------------------------------------------
    //     Constructors
    // -------------------------------------------------------------------------
 
    HeatmapParameters( ColorMap const& map )
        : color_map( map )
    {}
 
    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------
 
    // Color settings. We are currently not providing the normalization here,
    // but instead use an enum for that, because the classes are not super well done,
    // and that would get messy... so instead we introduce more development debt here.
    // What could go wrong?!
    // std::unique_ptr<ColorNormalization> color_norm;
 
    ColorMap color_map;
 
    ColorNorm color_norm;
 
    NormalizationRange normalization_range = NormalizationRange::kAll;
 
    double min_value = std::numeric_limits<double>::quiet_NaN();
 
    double max_value = std::numeric_limits<double>::quiet_NaN();
};
 
// =================================================================================================
//     Heat Map Matrix Functions
// =================================================================================================
 
std::unique_ptr<ColorNormalization> make_heatmap_color_norm(
    Matrix<double> const& values,
    HeatmapParameters const& parameters
);
 
Matrix<Color> make_heatmap_matrix(
    Matrix<double> const& values,
    HeatmapParameters const& parameters
);
 
} // namespace utils
} // namespace genesis
 
#endif // include guard