cutout_fits
===========

.. py:module:: cutout_fits

.. autoapi-nested-parse::

   Copyright (c) 2024 Alec Thomson. All rights reserved.

   cutout-fits: A package to produce cutouts of (remote) FITS files.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/cutout_fits/_version/index
   /autoapi/cutout_fits/casda/index
   /autoapi/cutout_fits/casda_login/index
   /autoapi/cutout_fits/cutout/index
   /autoapi/cutout_fits/logger/index


Attributes
----------

.. autoapisummary::

   cutout_fits.__version__


Functions
---------

.. autoapisummary::

   cutout_fits.make_cutout


Package Contents
----------------

.. py:function:: make_cutout(infile: str, outfile: str, ra_deg: float, dec_deg: float, radius_arcmin: float, freq_start_hz: float | None = None, freq_end_hz: float | None = None, overwrite: bool = False) -> astropy.io.fits.HDUList

   Make a cutout of a FITS file

   :param infile: Path to FITS file - can be a remote URL
   :type infile: str
   :param outfile: Path to output file - must be local
   :type outfile: str
   :param ra_deg: Centre RA in degrees
   :type ra_deg: float
   :param dec_deg: Centre Dec in degrees
   :type dec_deg: float
   :param radius_arcmin: Cutout radius in arcminutes
   :type radius_arcmin: float
   :param freq_start_hz: Start frequency in Hz. Defaults to None.
   :type freq_start_hz: float | None, optional
   :param freq_end_hz: End frequency in Hz. Defaults to None.
   :type freq_end_hz: float | None, optional
   :param overwrite: Whether to overwrite the output file.
   :type overwrite: bool

   :returns: Cutout HDUList
   :rtype: fits.HDUList


.. py:data:: __version__
   :type:  str