A library for working with phylogenetic data.
v0.25.0
HeatmapColorization Class Reference

#include <genesis/population/functions/heatmap_colorization.hpp>

Detailed Description

Definition at line 54 of file heatmap_colorization.hpp.

Public Member Functions

 HeatmapColorization ()=default
 
 HeatmapColorization (HeatmapColorization &&)=default
 
 HeatmapColorization (HeatmapColorization const &)=default
 
 HeatmapColorization (std::vector< utils::Color > const &palette)
 
 ~HeatmapColorization ()=default
 
utils::ColorMapcolor_map ()
 
bool diverging_scale () const
 
self_typediverging_scale (bool value)
 
utils::Color const & empty_window_color () const
 
self_typeempty_window_color (utils::Color const &value)
 
bool invert_vertically () const
 
self_typeinvert_vertically (bool value)
 
bool log_scale () const
 
self_typelog_scale (bool value)
 
bool max_per_column () const
 
self_typemax_per_column (bool value)
 
HeatmapColorizationoperator= (HeatmapColorization &&)=default
 
HeatmapColorizationoperator= (HeatmapColorization const &)=default
 
self_typepalette (std::vector< utils::Color > const &value)
 
double spectrum_to_bmp_file (Spectrum const &spectrum, std::shared_ptr< utils::BaseOutputTarget > target) const
 
std::pair< utils::Matrix< utils::Color >, double > spectrum_to_image (Spectrum const &spectrum) const
 
std::pair< utils::SvgGroup, double > spectrum_to_svg (Spectrum const &spectrum, utils::SvgMatrixSettings settings={}) const
 
bool use_empty_window_color () const
 
self_typeuse_empty_window_color (bool value)
 

Public Types

using self_type = HeatmapColorization
 

Classes

struct  Spectrum
 

Constructor & Destructor Documentation

◆ HeatmapColorization() [1/4]

HeatmapColorization ( )
default

◆ HeatmapColorization() [2/4]

HeatmapColorization ( std::vector< utils::Color > const &  palette)
inlineexplicit

Definition at line 81 of file heatmap_colorization.hpp.

◆ ~HeatmapColorization()

~HeatmapColorization ( )
default

◆ HeatmapColorization() [3/4]

◆ HeatmapColorization() [4/4]

Member Function Documentation

◆ color_map()

utils::ColorMap& color_map ( )
inline

Definition at line 188 of file heatmap_colorization.hpp.

◆ diverging_scale() [1/2]

bool diverging_scale ( ) const
inline

Definition at line 127 of file heatmap_colorization.hpp.

◆ diverging_scale() [2/2]

self_type& diverging_scale ( bool  value)
inline

Definition at line 132 of file heatmap_colorization.hpp.

◆ empty_window_color() [1/2]

utils::Color const& empty_window_color ( ) const
inline

Definition at line 160 of file heatmap_colorization.hpp.

◆ empty_window_color() [2/2]

self_type& empty_window_color ( utils::Color const &  value)
inline

Definition at line 165 of file heatmap_colorization.hpp.

◆ invert_vertically() [1/2]

bool invert_vertically ( ) const
inline

Definition at line 138 of file heatmap_colorization.hpp.

◆ invert_vertically() [2/2]

self_type& invert_vertically ( bool  value)
inline

Definition at line 143 of file heatmap_colorization.hpp.

◆ log_scale() [1/2]

bool log_scale ( ) const
inline

Definition at line 116 of file heatmap_colorization.hpp.

◆ log_scale() [2/2]

self_type& log_scale ( bool  value)
inline

Definition at line 121 of file heatmap_colorization.hpp.

◆ max_per_column() [1/2]

bool max_per_column ( ) const
inline

Definition at line 149 of file heatmap_colorization.hpp.

◆ max_per_column() [2/2]

self_type& max_per_column ( bool  value)
inline

Definition at line 154 of file heatmap_colorization.hpp.

◆ operator=() [1/2]

HeatmapColorization& operator= ( HeatmapColorization &&  )
default

◆ operator=() [2/2]

HeatmapColorization& operator= ( HeatmapColorization const &  )
default

◆ palette()

self_type& palette ( std::vector< utils::Color > const &  value)
inline

Definition at line 182 of file heatmap_colorization.hpp.

◆ spectrum_to_bmp_file()

double spectrum_to_bmp_file ( HeatmapColorization::Spectrum const &  spectrum,
std::shared_ptr< utils::BaseOutputTarget target 
) const

Definition at line 205 of file heatmap_colorization.cpp.

◆ spectrum_to_image()

std::pair< utils::Matrix< utils::Color >, double > spectrum_to_image ( Spectrum const &  spectrum) const

Definition at line 55 of file heatmap_colorization.cpp.

◆ spectrum_to_svg()

std::pair< utils::SvgGroup, double > spectrum_to_svg ( Spectrum const &  spectrum,
utils::SvgMatrixSettings  settings = {} 
) const

Definition at line 194 of file heatmap_colorization.cpp.

◆ use_empty_window_color() [1/2]

bool use_empty_window_color ( ) const
inline

Definition at line 171 of file heatmap_colorization.hpp.

◆ use_empty_window_color() [2/2]

self_type& use_empty_window_color ( bool  value)
inline

Definition at line 176 of file heatmap_colorization.hpp.

Member Typedef Documentation

◆ self_type

Definition at line 62 of file heatmap_colorization.hpp.


The documentation for this class was generated from the following files: