examples/homology-zigzags/README
author Dmitriy Morozov <dmitriy@mrzv.org>
Sun, 27 Apr 2014 13:49:14 -0700 (2014-04-27)
branchdev
changeset 287 d3a10e66c6ab
parent 274 73d69c01ed6c
permissions -rw-r--r--
Added a practical guide slides and examples to the docs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
274
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     1
********************************************************************************
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     2
*		 Rips-ZZ: Rips Zigzags for Homology Inference                  *
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     3
********************************************************************************
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     4
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     5
This is an extension to the Rips package of the Dionysus library. It
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     6
adapts the code of the Morozov zigzag (M-ZZ) and image Rips zigzag
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     7
(iR-ZZ) to the context of the following paper:
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     8
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
     9
Title: Zigzag Zoology: Rips Zigzags for Homology Inference
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    10
Authors: Steve Y. Oudot and Donald R. Sheehy
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    11
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    12
It also provides two variants of the M-ZZ: the discretized Morozov
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    13
zigzag (dM-ZZ) and the oscillating Rips zigzag (oR-ZZ).
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    14
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    15
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    16
Source files:
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    17
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    18
 - M-ZZ.cpp: implementation of the Morozov zigzag
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    19
 - dM-ZZ.cpp: implementation of the discretized Morozov zigzag
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    20
 - oR-ZZ.cpp: implementation of the oscillating Rips zigzag
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    21
 - iR-ZZ.cpp: implementation of the image Rips zigzag
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    22
 - rips-pairwise.cpp: computation of the standard Rips filtration 
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    23
                      and its persistent homology.
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    24
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    25
Execution:
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    26
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    27
 - the list of arguments required by a program can be obtained by
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    28
   running that program without arguments.
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    29
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    30
 - every program takes in a point cloud file, in xyz... format (no
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    31
   need to indicate the ambient dimension at the beginning of the
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    32
   file. A sample point cloud is provided in the file
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    33
   input/spiral_3d_10k.xyz
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    34
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    35
 - every program also asks for the name of the output file in which
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    36
   the barcode will be written. The output format is such that the
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    37
   file can be executed in Matlab. This creates a cells structures
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    38
   that can be read by the px_homologyplot function from the PLEX 2.5
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    39
   library (a copy of which is provided). This function will plot the
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    40
   barcode dimension per dimension.
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    41
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    42
73d69c01ed6c Added homology zigzags by Steve Oudot and Don Sheehy
Dmitriy Morozov <dmitriy@mrzv.org>
parents:
diff changeset
    43