cutout_fits.casda
=================

.. py:module:: cutout_fits.casda


Functions
---------

.. autoapisummary::

   cutout_fits.casda.casda_login
   cutout_fits.casda.cutout_from_casda
   cutout_fits.casda.get_casda_parser
   cutout_fits.casda.get_cutouts_from_casda
   cutout_fits.casda.get_download_url
   cutout_fits.casda.get_staging_url
   cutout_fits.casda.main


Module Contents
---------------

.. py:function:: casda_login(username: str | None = None, store_password: bool = False, reenter_password: bool = False) -> astroquery.casda.core.CasdaClass

   Login to CASDA.

   :param username: CASDA username. Defaults to None.
   :type username: str | None, optional
   :param store_password: Stores the password securely in your keyring. Defaults to False.
   :type store_password: bool, optional
   :param reenter_password: Asks for the password even if it is already stored in the keyring. This is the way to overwrite an already stored passwork on the keyring. Defaults to False.
   :type reenter_password: bool, optional

   :returns: CASDA class
   :rtype: CasdaClass


.. py:function:: cutout_from_casda(casda: astroquery.casda.core.CasdaClass, file_name: str, ra_deg: float, dec_deg: float, radius_arcmin: float, output_dir: pathlib.Path, freq_start_hz: float | None = None, freq_end_hz: float | None = None) -> astropy.io.fits.HDUList
   :async:


   Stage a file on CASDA and make a cutout.

   :param casda: CASDA class
   :type casda: CasdaClass
   :param file_name: File name to search for
   :type file_name: 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 output_dir: Directory to save FITS cutouts
   :type output_dir: Path
   :param freq_start_hz: Starting frequency in Hz. Defaults to None.
   :type freq_start_hz: float | None, optional
   :param freq_end_hz: Stopping frequency in Hz. Defaults to None.
   :type freq_end_hz: float | None, optional

   :returns: FITS HDU list
   :rtype: fits.HDUList


.. py:function:: get_casda_parser(parent_parser: bool = False) -> argparse.ArgumentParser

.. py:function:: get_cutouts_from_casda(file_name_list: list[str], ra_deg: float, dec_deg: float, radius_arcmin: float, output_dir: pathlib.Path | None = None, username: str | None = None, freq_start_hz: float | None = None, freq_end_hz: float | None = None, store_password: bool = False, reenter_password: bool = False) -> list[astropy.io.fits.HDUList]
   :async:


   Get cutouts from CASDA.

   :param file_name_list: File name(s) to search for
   :type file_name_list: list[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 output_dir: Output directory. Defaults to None.
   :type output_dir: Path | None, optional
   :param username: CASDA username. Defaults to None.
   :type username: str | None, optional
   :param freq_start_hz: Starting frequency in Hz. Defaults to None.
   :type freq_start_hz: float | None, optional
   :param freq_end_hz: Stopping frequnecy in Hz. Defaults to None.
   :type freq_end_hz: float | None, optional
   :param store_password: Store CASDA password. Defaults to False.
   :type store_password: bool, optional
   :param reenter_password: Force CASDA password prompt. Defaults to False.
   :type reenter_password: bool, optional

   :returns: List of FITS HDU lists
   :rtype: list[fits.HDUList]


.. py:function:: get_download_url(result_table: astropy.table.Table, casda: astroquery.casda.core.CasdaClass) -> str
   :async:


   Get the download URL for a file on CASDA.

   :param result_table: Table of results
   :type result_table: Table
   :param casda: CASDA class
   :type casda: CasdaClass

   :raises ValueError: If no results are found
   :raises ValueError: If multiple results are found

   :returns: Download URL
   :rtype: str


.. py:function:: get_staging_url(file_name: str) -> astropy.table.Table
   :async:


   Get the staging URL for a file on CASDA.

   :param file_name: File name to search for
   :type file_name: str

   :raises ValueError: If no results are found

   :returns: Table of results
   :rtype: Table


.. py:function:: main() -> None

   CLI