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

Example

To plot a 3D volume rendering for GW170104 and optionally mark a position (here, RA=135° Dec=+37° luminosity distance=500 Mpc):

$ curl -OL https://gwosc.org/s/events/GW170104/P1500227/bayestar.fits.gz
$ ligo-skymap-plot-volume bayestar.fits.gz --radecdist 135 37 500 -o bayestar.png

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

../_images/ligo_skymap_plot_volume-1.png

To plot a single projection plane:

$ curl -OL https://gwosc.org/s/events/GW170104/P1500227/bayestar.fits.gz
$ ligo-skymap-plot-volume bayestar.fits.gz --projection 1 -o bayestar-plane1.png

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

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