diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2019-02-12 14:08:56 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2019-02-12 14:08:56 +0000 |
| commit | f29a6e9a03dca95dc0a070b604fb11e18897a6f6 (patch) | |
| tree | 0da92a78fad0b15c119c18480b6d98d94924c78e /src/cython/doc/fileformats.rst | |
| parent | b1843507262c7c0d9831ebbeb2f43f43093aa15d (diff) | |
Fix doc for C++ and Python.
Fix some warnings on Nerve GIC sphinx doc generation
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/cubical_complex_small_fix@4101 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 57eacb8c4108be212e61796c65e3b45bb9c13644
Diffstat (limited to 'src/cython/doc/fileformats.rst')
| -rw-r--r-- | src/cython/doc/fileformats.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/src/cython/doc/fileformats.rst b/src/cython/doc/fileformats.rst index ff20f26e..e205cc8b 100644 --- a/src/cython/doc/fileformats.rst +++ b/src/cython/doc/fileformats.rst @@ -51,10 +51,12 @@ Here is a simple sample file in the 3D case:: 1. 1. 1. +.. _Perseus file format: + Perseus ******* -This file format is the format used by the +This file format is a format inspired from the `Perseus software <http://www.sas.upenn.edu/~vnanda/perseus/>`_ by Vidit Nanda. The first line contains a number d begin the dimension of the bitmap (2 in the example below). Next d lines are the numbers of top dimensional cubes in each @@ -88,3 +90,9 @@ Indicate that we have imposed periodic boundary conditions in the direction x, but not in the direction y. Other sample files can be found in the `data/bitmap` folder. + +.. note:: + Unlike in Perseus format the filtration on the maximal cubes can be any + double precision number. Consequently one cannot mark the cubes that are + not present with ``-1``'s. To do that please set their filtration value to + :math:`+\infty` (aka. ``inf`` in the file).
\ No newline at end of file |