3D Volume Rendering (ligo-skymap-plot-volume)

Example

To plot a 3D volume rendering for GW170104:

$ curl -O https://losc.ligo.org/s/events/GW170104/P1500227/bayestar.fits.gz
$ ligo-skymap-plot-volume bayestar.fits.gz -o bayestar.png

(Source code, png, hires.png, pdf)

../_images/ligo_skymap_plot_volume-1.png

Plot a volumetric posterior in three-projection view.

usage: ligo-skymap-plot-volume [-h] [-o FILE.{pdf,png}] [--colormap CMAP]
                               [--help-colormap] [--figure-width INCHES]
                               [--figure-height INCHES] [--dpi PIXELS]
                               [--transparent [TRANSPARENT]] [--version]
                               [-l CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET]
                               [--annotate] [--max-distance Mpc]
                               [--contour PERCENT [PERCENT ...]]
                               [--radecdist RADECDIST RADECDIST RADECDIST]
                               [--chain CHAIN.hdf5] [--projection {0,1,2,3}]
                               [--align-to SKYMAP.fits[.gz]]
                               [INPUT.fits[.gz]]

Positional Arguments

INPUT.fits[.gz]

Input FITS file

Default: -

Named Arguments

--version

show program’s version number and exit

-l, --loglevel

Default: INFO

--annotate

annotate plot with information about the event

Default: False

--max-distance

maximum distance of plot in Mpc

--contour

plot contour enclosing this percentage of probability mass

--radecdist

right ascension (deg), declination (deg), and distance to mark

Default: []

--chain

optionally plot a posterior sample chain

--projection

Possible choices: 0, 1, 2, 3

Plot one specific projection, or 0 for all projections

Default: 0

--align-to

Align to the principal axes of this sky map

figure options

Options that affect figure output format

-o, --output

output file, or - to plot to screen

Default: -

--colormap

Possible choices: Accent, Accent_r, Blues, Blues_r, BrBG, BrBG_r, BuGn, BuGn_r, BuPu, BuPu_r, CMRmap, CMRmap_r, Dark2, Dark2_r, GnBu, GnBu_r, Greens, Greens_r, Greys, Greys_r, OrRd, OrRd_r, Oranges, Oranges_r, PRGn, PRGn_r, Paired, Paired_r, Pastel1, Pastel1_r, Pastel2, Pastel2_r, PiYG, PiYG_r, PuBu, PuBuGn, PuBuGn_r, PuBu_r, PuOr, PuOr_r, PuRd, PuRd_r, Purples, Purples_r, RdBu, RdBu_r, RdGy, RdGy_r, RdPu, RdPu_r, RdYlBu, RdYlBu_r, RdYlGn, RdYlGn_r, Reds, Reds_r, Set1, Set1_r, Set2, Set2_r, Set3, Set3_r, Spectral, Spectral_r, Wistia, Wistia_r, YlGn, YlGnBu, YlGnBu_r, YlGn_r, YlOrBr, YlOrBr_r, YlOrRd, YlOrRd_r, afmhot, afmhot_r, autumn, autumn_r, binary, binary_r, bone, bone_r, brg, brg_r, bwr, bwr_r, cividis, cividis_r, cool, cool_r, coolwarm, coolwarm_r, copper, copper_r, cubehelix, cubehelix_r, cylon, cylon_r, flag, flag_r, gist_earth, gist_earth_r, gist_gray, gist_gray_r, gist_heat, gist_heat_r, gist_ncar, gist_ncar_r, gist_rainbow, gist_rainbow_r, gist_stern, gist_stern_r, gist_yarg, gist_yarg_r, gnuplot, gnuplot2, gnuplot2_r, gnuplot_r, gray, gray_r, hot, hot_r, hsv, hsv_r, inferno, inferno_r, jet, jet_r, magma, magma_r, nipy_spectral, nipy_spectral_r, ocean, ocean_r, pink, pink_r, plasma, plasma_r, prism, prism_r, rainbow, rainbow_r, seismic, seismic_r, spring, spring_r, summer, summer_r, tab10, tab10_r, tab20, tab20_r, tab20b, tab20b_r, tab20c, tab20c_r, terrain, terrain_r, turbo, turbo_r, twilight, twilight_r, twilight_shifted, twilight_shifted_r, viridis, viridis_r, winter, winter_r

matplotlib colormap

Default: cylon

--help-colormap

show supported values for –colormap and exit

--figure-width

width of figure in inches

Default: 3.5

--figure-height

height of figure in inches

Default: 3.5

--dpi

resolution of figure in dots per inch

Default: 300

--transparent

Save image with transparent background

Default: 0