Skip to main content

High-contrast Imaging Plotting library

Project description

PyPI version

HCIplot

HCIplot -- High-contrast Imaging Plotting library. The goal of this library is to be the "Swiss army" solution for plotting and visualizing multi-dimensional high-contrast imaging datacubes on JupyterLab. While visualizing FITS files is straightforward with SaoImage DS9 or any other FITS viewer, exploring the content of an HCI datacube as an in-memory numpy array (for example when running your Jupyter session on a remote machine) is far from easy.

HCIplot contains two functions, plot_frames and plot_cubes, and relies on the matplotlib and HoloViews libraries and ImageMagick. HCIplot allows to:

  • Plot a single frame (2d array) or create a mosaic of frames.

mosaic

  • Annotate and save publication ready frames/mosaics.

  • Visualize 2d arrays as surface plots.

  • Create interactive plots when handling 3d or 4d arrays (thanks to HoloViews)

datacube

  • Save to disk a 3d array as an animation (gif or mp4).

Installation

You can install HCIplot with pip:

pip install hciplot

JupyterLab can be installed either with pip or with conda:

conda install -c conda-forge jupyterlab

The PyViz extension must be installed to display the holoviews widgets on JupyterLab:

jupyter labextension install @pyviz/jupyterlab_pyviz

If you want to create animations with plot_cubes you need to install ImageMagick with your system's package manager (e.g. brew if you are on MacOS or apt-get if you are on Ubuntu).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hciplot, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size hciplot-0.1.7-py2.py3-none-any.whl (12.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size hciplot-0.1.7.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page