Metadata-Version: 2.1
Name: astro-ndslice
Version: 0.1.1
Summary: Convenience tools for slicing images & calcualting offsets before combinations (focusing on converting astronomical FITS/IRAF and python conventions)
Home-page: https://github.com/ysBach/astro-ndslice
Author: Yoonsoo P. Bach
Author-email: ysbach93@gmail.com,
License: BSD 3-clause
Project-URL: Source, https://github.com/ysBach/astro-ndslice
Project-URL: Tracker, https://github.com/ysBach/astro-ndslice/issues
Keywords: astronomy,data reduction,image analysis
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8
License-File: LICENSE

# astro-ndslice
A collection of simple tools to slicing astronomical images (many are applicable to general ndarray).

* Module `list`: Contains some universally usable convenience functions.
  * `is_list_like` : Checks if anything is list-like (list, tuple, ndarray).
  * `listify`: Convert scalar or iterable into list (``scalar2list=True, none2list=False``)
  * `ndfy`: Convert scalar or iterable into ndarray (see docstring for details)
* Module `slices`: Contains tools to convert FITS convention (e.g., "[10:20, 1:2]") or bezel (e.g., `bezel=[10, 10]`) into python `slice`.
* Module `offset`: Contains tools to find the offsets between two images/FITS files (essential before image combination)
  * To use `calc_offset_wcs` or `calc_offset_physical`, `astropy` is required.
BSD 3-Clause License

Copyright (c) 2023, Yoonsoo P. Bach

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
