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

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

Detailed Description

Definition at line 49 of file genome_heatmap.hpp.

Public Member Functions

 GenomeHeatmap ()=default
 
 GenomeHeatmap (GenomeHeatmap &&)=default
 
 GenomeHeatmap (GenomeHeatmap const &)=default
 
 ~GenomeHeatmap ()=default
 
void add (std::string const &label, utils::Matrix< utils::Color > const &heatmap)
 
utils::SvgDocument const & document () const
 
double horizontal_scaling () const
 
GenomeHeatmaphorizontal_scaling (double value)
 
GenomeHeatmapoperator= (GenomeHeatmap &&)=default
 
GenomeHeatmapoperator= (GenomeHeatmap const &)=default
 
TextPosition text_position () const
 
GenomeHeatmaptext_position (TextPosition value)
 
utils::SvgTexttext_template ()
 
utils::SvgText const & text_template () const
 
void text_template (utils::SvgText const &tt)
 
double vertical_scaling () const
 
GenomeHeatmapvertical_scaling (double value)
 
void write (std::shared_ptr< utils::BaseOutputTarget > target) const
 

Public Types

enum  TextPosition { kTop, kBottom, kLeft, kRight }
 

Constructor & Destructor Documentation

◆ GenomeHeatmap() [1/3]

GenomeHeatmap ( )
default

◆ ~GenomeHeatmap()

~GenomeHeatmap ( )
default

◆ GenomeHeatmap() [2/3]

GenomeHeatmap ( GenomeHeatmap const &  )
default

◆ GenomeHeatmap() [3/3]

GenomeHeatmap ( GenomeHeatmap &&  )
default

Member Function Documentation

◆ add()

void add ( std::string const &  label,
utils::Matrix< utils::Color > const &  heatmap 
)

Definition at line 44 of file genome_heatmap.cpp.

◆ document()

utils::SvgDocument const& document ( ) const
inline

Definition at line 127 of file genome_heatmap.hpp.

◆ horizontal_scaling() [1/2]

double horizontal_scaling ( ) const
inline

Definition at line 82 of file genome_heatmap.hpp.

◆ horizontal_scaling() [2/2]

GenomeHeatmap& horizontal_scaling ( double  value)
inline

Definition at line 87 of file genome_heatmap.hpp.

◆ operator=() [1/2]

GenomeHeatmap& operator= ( GenomeHeatmap &&  )
default

◆ operator=() [2/2]

GenomeHeatmap& operator= ( GenomeHeatmap const &  )
default

◆ text_position() [1/2]

TextPosition text_position ( ) const
inline

Definition at line 104 of file genome_heatmap.hpp.

◆ text_position() [2/2]

GenomeHeatmap& text_position ( TextPosition  value)
inline

Definition at line 109 of file genome_heatmap.hpp.

◆ text_template() [1/3]

utils::SvgText& text_template ( )

◆ text_template() [2/3]

utils::SvgText const& text_template ( ) const

◆ text_template() [3/3]

void text_template ( utils::SvgText const &  tt)

◆ vertical_scaling() [1/2]

double vertical_scaling ( ) const
inline

Definition at line 93 of file genome_heatmap.hpp.

◆ vertical_scaling() [2/2]

GenomeHeatmap& vertical_scaling ( double  value)
inline

Definition at line 98 of file genome_heatmap.hpp.

◆ write()

void write ( std::shared_ptr< utils::BaseOutputTarget target) const

Definition at line 106 of file genome_heatmap.cpp.

Member Enumeration Documentation

◆ TextPosition

enum TextPosition
strong
Enumerator
kTop 
kBottom 
kLeft 
kRight 

Definition at line 57 of file genome_heatmap.hpp.


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