pulsatrix 1.1.0
Loading...
Searching...
No Matches
topology_documents.hpp File Reference

The persistence diagram document (TDA-9): the features of each homology dimension, with the certified error bound and any significance results, for the persistence diagram, barcode and Betti curve views in topology_views.hpp. More...

#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
#include "pulsatrix/tda/persistence_diagram.hpp"
#include "pulsatrix/tda/rips_persistence.hpp"
#include "pulsatrix/tda/significance.hpp"
Include dependency graph for topology_documents.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  pulsatrix::PersistenceDiagramEntry
 One homology dimension of a PersistenceDiagramDocument. More...
 
struct  pulsatrix::PersistenceDiagramDocument
 Persistence diagrams of one point cloud, one entry per homology dimension. More...
 

Namespaces

namespace  pulsatrix
 

Functions

PersistenceDiagramDocument pulsatrix::ToPersistenceDiagramDocument (const std::vector< PersistenceDiagram > &diagrams, std::string title="")
 The diagrams as a document: births, deaths and each diagram's error bound.
 
PersistenceDiagramDocument pulsatrix::ToPersistenceDiagramDocument (const RipsResult &result, std::string title="")
 The same, from ComputeRipsPersistence(), with its threshold.
 
void pulsatrix::AttachSignificance (PersistenceDiagramDocument &doc, int dimension, const UniversalNullResult &test)
 Adds UniversalNullTest()'s p-values and corrected threshold to the entry for dimension. Features the test skipped get NaN.
 
void pulsatrix::AttachBootstrapBand (PersistenceDiagramDocument &doc, int dimension, const BootstrapBandResult &band)
 Adds BootstrapBand()'s band to the entry for dimension.
 
bool pulsatrix::IsSignificant (const PersistenceDiagramEntry &entry, size_t i)
 Whether feature i of entry passed the attached tests: its p-value is below the threshold, or, with only a bootstrap band, its persistence is above twice the band. True for every feature when no test is attached.
 
std::string pulsatrix::ToJson (const PersistenceDiagramDocument &doc)
 Writes the document.
 
PersistenceDiagramDocument pulsatrix::ParsePersistenceDiagramDocument (std::string_view json)
 Reads a document ToJson() wrote.
 

Detailed Description

The persistence diagram document (TDA-9): the features of each homology dimension, with the certified error bound and any significance results, for the persistence diagram, barcode and Betti curve views in topology_views.hpp.

It follows the rules of every viz document (document.hpp): a "schema" of pulsatrix.persistence_diagram.v1, non-finite numbers (an essential feature's infinite death, an untested feature's NaN p-value) as null plus a "nonfinite" entry, and readers that name the JSON Pointer of the first problem.