Metadata-Version: 2.4
Name: pvextractor
Version: 0.4
Summary: Position-velocity diagram extractor.
Home-page: http://pvextractor.readthedocs.io
Author: Adam Ginsburg and Thomas Robitaille
Author-email: adam.g.ginsburg@gmail.com
License: BSD 3-Clause
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy>=1.22
Requires-Dist: astropy>=5.0
Requires-Dist: matplotlib>=3.5
Requires-Dist: scipy>=1.8
Requires-Dist: qtpy>=2.0
Requires-Dist: spectral-cube>=0.4
Provides-Extra: test
Requires-Dist: pytest-astropy; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx-astropy; extra == "docs"
Dynamic: license-file

Position-Velocity Diagram Extractor
===================================

Full docs are available
`here <http://pvextractor.readthedocs.org/en/latest/>`__

Tool to slice through data cubes and extract position-velocity (or
other) slices.

There are a few `utilities <pvextractor/utils>`__ related to header
trimming & parsing. Otherwise, there’s one main function,
`pvextractor <pvextractor/pvextractor.py>`__, that takes a data cube and
a series of points and returns a PV array. It is based on scipy’s
``map_coordinates`` but also has .

For an example use case, see [this notebook]
(http://nbviewer.ipython.org/urls/raw.github.com/radio-astro-tools/pvextractor/master/examples/IRAS05358Slicing.ipynb)
(for a permanent, compiled version, look
`here <examples/IRAS05358Slicing.html>`__)

.. figure:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
   :alt: Powered by Astropy Badge

   Powered by Astropy Badge

Minimal Install Instructions
----------------------------

::

   pip install https://github.com/ericmandel/pyds9/archive/master.zip
   pip install https://github.com/radio-astro-tools/spectral-cube/archive/master.zip
   pip install https://github.com/radio-astro-tools/pvextractor/archive/master.zip

The pvextractor GUI
-------------------

Run it like this:

::

   from pvextractor.gui import PVSlicer
   pv = PVSlicer('L1448_13CO.fits')
   pv.show()

Click to select “control points” along the path, then press “enter” to
expand the width of the slice, then click. Optionally, “y” will show the
exact regions extracted.

Using pvextractor in ds9
------------------------

There is a python script that will be installed along with pvextractor.
You can invoke it from the command line, but the preferred approach is
to load the tool into ds9. First, determine the path to
``ds9_pvextract.ans``; it is in
`scripts/ds9_pvextract.ans <scripts/ds9_pvextract.ans>`__. Then start up
ds9 with the analysis tool loaded

::

   ds9 -analysis load /path/to/pvextractor/scripts/ds9_pvextract.ans  &

Then load any cube in ds9, draw a line, and press ‘x’ or press “PV
Extractor” in the menu.

.. figure:: images/pvextractor_ds9_example.png
   :alt: Example DS9 use

   Example DS9 use

Build and coverage status
=========================

|Build Status| |Coverage Status| |Bitdeli badge|

.. |Build Status| image:: https://travis-ci.org/radio-astro-tools/pvextractor.png?branch=master
   :target: https://travis-ci.org/radio-astro-tools/pvextractor
.. |Coverage Status| image:: https://coveralls.io/repos/radio-astro-tools/pvextractor/badge.svg?branch=master
   :target: https://coveralls.io/r/radio-astro-tools/pvextractor?branch=master
.. |Bitdeli badge| image:: https://d2weczhvl823v0.cloudfront.net/keflavich/pvextractor/trend.png
   :target: https://bitdeli.com/free
