diff options
author | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-24 08:10:28 +0000 |
---|---|---|
committer | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-11-24 08:10:28 +0000 |
commit | f1691997a3f6eceab45256ce4a94a9aa64d92471 (patch) | |
tree | 762fde69adbe5553eb8c5b1068c87d6af1da3c1c /src/common/doc | |
parent | 32324d2b6ef2d7a4dd1c75e6f09c725eadc5145a (diff) |
Move Perseus file format to file_formats.h
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/add_utils_in_gudhi_v2@2949 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: e2f0dcf1efdc3c26ff609b7a14d37a604a9c162f
Diffstat (limited to 'src/common/doc')
-rw-r--r-- | src/common/doc/file_formats.h | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h index 069b19d1..d06b81f5 100644 --- a/src/common/doc/file_formats.h +++ b/src/common/doc/file_formats.h @@ -68,6 +68,55 @@ namespace Gudhi { -1. -1. -1. 1. 1. 1. \endverbatim + + + \section FileFormatsPerseus Perseus + + This file format is the format used by 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 dimensions (3 and 3 + in the example below). Next, in lexicographical order, the filtration of top dimensional cubes is given (1 4 6 8 + 20 4 7 6 5 in the example below). + + \image html "exampleBitmap.png" "Example of a input data." + + The input file for the following complex is: + \verbatim + 2 + 3 + 3 + 1 + 4 + 6 + 8 + 20 + 4 + 7 + 6 + 5 + \endverbatim + + To indicate periodic boundary conditions in a + given direction, then number of top dimensional cells in this direction have to be multiplied by -1. For instance: + + \verbatim + 2 + -3 + 3 + 1 + 4 + 6 + 8 + 20 + 4 + 7 + 6 + 5 + \endverbatim + + Indicate that we have imposed periodic boundary conditions in the direction x, but not in the direction y. + */ } // namespace Gudhi |