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

One homology dimension of a PersistenceDiagramDocument. More...

#include <topology_documents.hpp>

Public Member Functions

size_t size () const
 

Public Attributes

int dimension = 0
 0 for components, 1 for loops, 2 for voids.
 
std::vector< double > births
 One birth and one death per feature; a death of +infinity for an essential feature.
 
std::vector< double > deaths
 
double error_bound = 0
 PersistenceDiagram::error_bound: every point is within this distance of where the exact distances would put it, so a feature with persistence at most twice this could be noise in the distances alone.
 
std::vector< double > p_values
 Empty, or one p-value per feature; NaN for a feature that wasn't tested, such as an essential one. From AttachSignificance().
 
double significance_threshold = 0
 A feature is significant when its p-value is below this; 0 when there are no p-values. UniversalNullResult::threshold, already corrected for the number tested.
 
double bootstrap_band = 0
 A bootstrap confidence band (BootstrapBandResult::band); 0 for none. Features with persistence above twice the band are farther from the diagonal than it reaches.
 

Detailed Description

One homology dimension of a PersistenceDiagramDocument.

Member Function Documentation

◆ size()

size_t pulsatrix::PersistenceDiagramEntry::size ( ) const
inline

Member Data Documentation

◆ births

std::vector<double> pulsatrix::PersistenceDiagramEntry::births

One birth and one death per feature; a death of +infinity for an essential feature.

◆ bootstrap_band

double pulsatrix::PersistenceDiagramEntry::bootstrap_band = 0

A bootstrap confidence band (BootstrapBandResult::band); 0 for none. Features with persistence above twice the band are farther from the diagonal than it reaches.

◆ deaths

std::vector<double> pulsatrix::PersistenceDiagramEntry::deaths

◆ dimension

int pulsatrix::PersistenceDiagramEntry::dimension = 0

0 for components, 1 for loops, 2 for voids.

◆ error_bound

double pulsatrix::PersistenceDiagramEntry::error_bound = 0

PersistenceDiagram::error_bound: every point is within this distance of where the exact distances would put it, so a feature with persistence at most twice this could be noise in the distances alone.

◆ p_values

std::vector<double> pulsatrix::PersistenceDiagramEntry::p_values

Empty, or one p-value per feature; NaN for a feature that wasn't tested, such as an essential one. From AttachSignificance().

◆ significance_threshold

double pulsatrix::PersistenceDiagramEntry::significance_threshold = 0

A feature is significant when its p-value is below this; 0 when there are no p-values. UniversalNullResult::threshold, already corrected for the number tested.


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