semvec/pypi-packages huggingface dataset:
cornish 1.1
A pure Python interface to the excellent Starlink AST library.
Requires Python: >=3.6

=======
Cornish
=======

Cornish is a Python interface over the `Starlink AST <http://starlink.eao.hawaii.edu/starlink/AST>`_ astronomical software library, part of the `Starlink Software Collection <http://starlink.eao.hawaii.edu/>`_. Cornish is designed and written by Demitri Muna.

The Starlink AST library is a collection of tools for working with world coordinate systems and excels at coordinate system transformations, representing and working with regions on the celestial sphere (e.g. polygons, circles, boxes, etc.), plotting, and more.

A `Python interface <http://starlink.github.io/starlink-pyast/pyast.html>`_ called `starlink-ast <https://pypi.org/project/starlink-pyast/>`_ written by the library's authors, David Berry and Tim Jenness, is available, however it thinly exposes the C interface. A working knowledge of the C API is realistically a prerequisite to using ``starlink-ast``. Similarly, the primary `documentation for the library <http://www.starlink.ac.uk/cgi-bin/htxserver/sun211.htx/sun211.html>`_ is the that of the C version which does not refer to the Python interface.

The aim of Cornish is to be a fully Pythonic interface to the library. It doesn't replace the existing ``starlink-ast`` Python interface; rather, it is a wrapper around that. The current development focus is defining and working with regions on the sky. It accepts and returns `Astropy <https://www.astropy.org>`_ objects where possible.

Cornish is currently under active development and all APIs are subject to change. It is not recommended to be used in a pipeline yet, but it is becoming increasingly mature and particularly useful for interactive use. The project is being released in this state as it is a dependency of the Trillian and SciDD projects.

Many thanks to David Berry for the generous and extremely responsive help and advice in the development of the library.

--------
Examples
--------

The main documentation (in progress) will be the primary reference for this library. A few examples demonstrate its capabilities.


.. code-block:: python

    from cornish import ASTRegion
    from astropy.io import fits

    # read FITS HDU (assuming a 2D image with a WCS)
    hdu1 = fits.open("my_file.fits")[0]

    # define a polygon around the border the image
    polygon = ASTRegion.fromFITSHeader(hdu1.header)

    # get a circle that bounds that polygon
    circle = polygon.boundingCircle()

    # create a polygon from a circle region
    polygon2 = circle.toPolygon(npoints=20)

    # check if polygons overlap
    polygon.overlaps(polygon3)

(If it seems too simple... that's kind of the point.)