NAME

#

plot_PD_slice - Plot the 1d slice of a PD histogram

SYNOPSIS

#

homcloud-plot-PD-slice
    [-h] [-V] -d DEGREE [-T TYPE] [-N] [-l LEFT_LABEL]
    [-r RIGHT_LABEL] [-b BINS] [--log] [-o OUTPUT]
    [--text-output] [-t TITLE] [--dpi DPI]
    birth1 death1 birth2 death2 width input [input ...]

This program can also be invoked as python3 -m homcloud.cli.plot_PD_slice.

ALIAS

#

homcloud-plot-PD-slice

DESCRIPTION

#

This program plots the 1d slice of a PD histogram.

The program takes the slice on a segment from (birth1, death1) to (birth2, death2). Points on the segment strip whose width is width are counted to construct the 1d histogram.

OPTIONS

#

-h, --help            show this help message and exit
-V, --version         show program's version number and exit
-d DEGREE, --degree DEGREE
                      degree of PH
-T TYPE, --type TYPE  input file format (pdgm, text) (default:
                      autodetect)
-N, --negate          flip the sign of birth/death times for superlevel
                      persistence (default: False)
-l LEFT_LABEL, --left-label LEFT_LABEL
                      label for starting point
-r RIGHT_LABEL, --right-label RIGHT_LABEL
                      label for end point
-b BINS, --bins BINS  number of bins
--log                 log scale
-o OUTPUT, --output OUTPUT
                      output file path
--text-output         output histgram data into a text file
-t TITLE, --title TITLE
                      title
--dpi DPI             output dpi

positional arguments:

birth1                birth of starting point
death1                death of starting point
birth2                birth of end point
death2                death of end point
width                 width for histogram
input                 input file path

INPUT FORMAT

#

You can use the same data format as plot_PD for an input file: a .pdgm file, or a text file of birth-death pairs (-T selects the format explicitly; by default it is auto-detected).

If multiple input files are specified, all birth-death pairs in the input files are counted together.

OUTPUT

#

If -o option is not given, the histogram is shown in your window. If -o option is given, the output is written to that path. By default it is a figure whose format is determined by the file extension (PNG(.png), PDF(.pdf), etc. — anything matplotlib supports). If --text-output is also given, the raw histogram counts are written as a text file instead (one integer count per line) rather than being plotted.