pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::ProjectionDocument Struct Reference

pulsatrix.projection.v1: inputs placed in a few dimensions (INT-5), such as their first principal components, for a scatter plot. Each point can carry a label (shown on hover), a group (drawn as a color) and a value (drawn on a color scale when there are no groups). More...

#include <document.hpp>

Public Member Functions

int64_t num_points () const
 

Public Attributes

std::string title
 
std::string method
 How the coordinates were made, for example "pca". Optional.
 
std::vector< std::string > axes
 One name per dimension, for example "PC1". At least two.
 
std::vector< float > explained_variance_ratio
 Each axis's share of the variance, or empty when it has none.
 
std::vector< float > coordinates
 Row-major (points, axes).
 
std::vector< std::string > labels
 One per point, or empty.
 
std::vector< std::string > groups
 One per point, or empty.
 
std::vector< float > values
 One per point, or empty.
 

Detailed Description

pulsatrix.projection.v1: inputs placed in a few dimensions (INT-5), such as their first principal components, for a scatter plot. Each point can carry a label (shown on hover), a group (drawn as a color) and a value (drawn on a color scale when there are no groups).

Member Function Documentation

◆ num_points()

int64_t pulsatrix::ProjectionDocument::num_points ( ) const
inline

Member Data Documentation

◆ axes

std::vector<std::string> pulsatrix::ProjectionDocument::axes

One name per dimension, for example "PC1". At least two.

◆ coordinates

std::vector<float> pulsatrix::ProjectionDocument::coordinates

Row-major (points, axes).

◆ explained_variance_ratio

std::vector<float> pulsatrix::ProjectionDocument::explained_variance_ratio

Each axis's share of the variance, or empty when it has none.

◆ groups

std::vector<std::string> pulsatrix::ProjectionDocument::groups

One per point, or empty.

◆ labels

std::vector<std::string> pulsatrix::ProjectionDocument::labels

One per point, or empty.

◆ method

std::string pulsatrix::ProjectionDocument::method

How the coordinates were made, for example "pca". Optional.

◆ title

std::string pulsatrix::ProjectionDocument::title

◆ values

std::vector<float> pulsatrix::ProjectionDocument::values

One per point, or empty.


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