diff options
author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-12-06 08:13:32 +0000 |
---|---|---|
committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2017-12-06 08:13:32 +0000 |
commit | 9c0ff374057baf19d3ea1147553b68f5293074ac (patch) | |
tree | 007f17b1fd37ef7f689a63d4ebcaf9fa409d76ee /src/common/doc/file_formats.h | |
parent | 841c4db0448687a61c25bd57729ae0cad1ae2b72 (diff) | |
parent | 86f7c676f094e44d4c06392c452b372f4470099b (diff) |
Merge add_utils_in_gudhi_v2 branch after 2nd round of review
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@3041 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: ad134cc2b6756e20afc8d9db9e40c5af87d09f9d
Diffstat (limited to 'src/common/doc/file_formats.h')
-rw-r--r-- | src/common/doc/file_formats.h | 55 |
1 files changed, 52 insertions, 3 deletions
diff --git a/src/common/doc/file_formats.h b/src/common/doc/file_formats.h index 3b3d9248..d06b81f5 100644 --- a/src/common/doc/file_formats.h +++ b/src/common/doc/file_formats.h @@ -57,10 +57,10 @@ namespace Gudhi { \section FileFormatsIsoCuboid Iso-cuboid - Such a file describes an iso-oriented cuboid with diagonal opposite vertices (min_hx, min_hy, min_hz,...) and (max_hx, max_hy, max_hz, ...). The format is:<br> + Such a file describes an iso-oriented cuboid with diagonal opposite vertices (min_x, min_y, min_z,...) and (max_x, max_y, max_z, ...). The format is:<br> \verbatim - min_hx min_hy [min_hz ...] - max_hx max_hy [max_hz ...] + min_x min_y [min_z ...] + max_x max_y [max_z ...] \endverbatim Here is a simple sample file in the 3D case: @@ -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 |