NAME

#

view_vectorized_PD - Plot a vectorized PD in the histogram style

SYNOPSIS

#

homcloud-view-vectorized-PD
    [-h] [-V] [-o OUTPUT] [-p POWER] [-l] [--loglog]
    [--linear-midpoint LINEAR_MIDPOINT] [-m MAX] [--vmin VMIN]
    [-c COLORMAP] [-s STYLE] [-t TITLE] [-U UNIT_NAME]
    [--font-size FONT_SIZE] [--aspect ASPECT] [--plot-essential]
    [--dpi DPI]
    input vectorization_info

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

ALIAS

#

homcloud-view-vectorized-PD

DESCRIPTION

#

This program reconstructs and plots the vectorized PD (persistence image) generated by vectorize_PD, in the same histogram style as plot_PD.

input is a vector text file (as written by -o of homcloud-vectorize-PD), and vectorization_info is the JSON file written by the -H/--histogram-information option of homcloud-vectorize-PD.

OPTIONS

#

-h, --help            show this help message and exit
-V, --version         show program's version number and exit
-o OUTPUT, --output OUTPUT
                      output image file
-p POWER, --power POWER
                      Output x^POWER for each value x
-l, --log             Output log(x+1) for each value x
--loglog              Output log(log(x+1)+1)
--linear-midpoint LINEAR_MIDPOINT
                      linear with midpoint
-m MAX, --vmax MAX    Maximum of colorbar (default: autoscale)
--vmin VMIN           Minimum of colorbar
-c COLORMAP, --colormap COLORMAP
                      matplotlib colormap name
-s STYLE, --style STYLE
                      plotting style (colorhistogram(default), contour)
-t TITLE, --title TITLE
                      title string
-U UNIT_NAME, --unit-name UNIT_NAME
                      The unit name of birth and death times
--font-size FONT_SIZE
                      font size (default: 12)
--aspect ASPECT       histogram aspect (default: auto)
--plot-essential      whether to plot essential values (default: False)
--dpi DPI             output DPI (used with -o option, default is
                      savefig.dpi for matplotlib)

If the output argument (-o) is not given, the plotted picture is shown in your display; otherwise it is saved with the format chosen from the file extension (PNG, PDF, EPS, …).

EXAMPLE

#

homcloud-vectorize-PD -d 0 -x "[-20.25:20.25]" -X 81 -D 0.5 -C 6 -p 4 -H histoinfo.json -o vect.txt data.pdgm
# do some statistical processing
# v.txt is created by the processing

# View v.txt
homcloud-view-vectorized-PD v.txt histoinfo.json