A library for working with phylogenetic and population genetic data.
v0.32.0
CathedralPlotRecord Struct Reference

#include <genesis/population/plotting/cathedral_plot.hpp>

Inherited by FstCathedralPlotRecord.

Detailed Description

Collection of the data used for making for a cathedral plot.

Base class that contains the data-derived parameters, such as chromosome name. In each of the steps during the creating of a cathedral plot, it receives more data, resulting from what the step did.

Meant to be derived from to add more parameters for specific types of cathedral plots, as well as the data needed by compute_cathedral_matrix() and its accumulator to compute the data matrix. In particular, the derived class shall add a std::vector<Entry> entries that contains the per-position entries that are the data to compute the per-window (per-pixel) values.

See also
compute_cathedral_matrix()

Definition at line 116 of file cathedral_plot.hpp.

Public Member Functions

virtual ~CathedralPlotRecord ()=default
 

Public Attributes

size_t chromosome_length = 0
 
std::string chromosome_name
 
CathedralPlotParameters parameters
 
std::string plot_name
 
std::string title
 
genesis::utils::Matrix< double > value_matrix
 
std::vector< double > window_widths
 

Constructor & Destructor Documentation

◆ ~CathedralPlotRecord()

virtual ~CathedralPlotRecord ( )
virtualdefault

Member Data Documentation

◆ chromosome_length

size_t chromosome_length = 0

Definition at line 126 of file cathedral_plot.hpp.

◆ chromosome_name

std::string chromosome_name

Definition at line 125 of file cathedral_plot.hpp.

◆ parameters

Definition at line 129 of file cathedral_plot.hpp.

◆ plot_name

std::string plot_name

Definition at line 124 of file cathedral_plot.hpp.

◆ title

std::string title

Definition at line 123 of file cathedral_plot.hpp.

◆ value_matrix

genesis::utils::Matrix<double> value_matrix

Definition at line 132 of file cathedral_plot.hpp.

◆ window_widths

std::vector<double> window_widths

Definition at line 133 of file cathedral_plot.hpp.


The documentation for this struct was generated from the following file: