fitszoom 0.0.1__py3-none-any.whl

fitszoom/__init__.py

@@ -0,0 +1,7 @@
+import os
+
+__version__ = "0.0.1"
+
+#set directories where input images are located and outputs are sent to
+fitszoom_dir = os.path.dirname(__file__)
+DATADIR = os.path.join(fitszoom_dir, "images/")

fitszoom/zoom.py

@@ -0,0 +1,109 @@
+from astropy.io import fits  # importing i/o subpackage for reading FITS files
+from astropy.nddata import Cutout2D
+import astropy.units as u # astropy units
+from astropy.wcs import WCS
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+class FITSZoom(object):
+    """
+    Zoom into the given coordinates and create a cutout with the given dimensions
+    """
+
+    def __init__(self, filename, extension=0):
+        """
+        Enter your file directory and your file name should be in .fits format in the DATADIR folder defined in __init__.py.
+        Args:
+            filename (string): your file name -> "{DATADIR}/<<your image>>.fits"
+        """
+        self.filename = filename             
+        self.fits = fits.open(filename) # open the fits file --> this returns as a list of Header and Data units
+        self.setup(extension=extension) # pull out the data we need so that they are ready to use right after construction
+    
+    def setup(self, extension=0):
+        """
+        Extract the necessary attributes from the fits header
+        Print out the recommended image bounds and sky coordinates
+
+        Args:
+            extension (int): the index where the desired data is within the fits
+            alternative_names (dict): dictionary mapping the names of appropriate values
+        """
+        self.header = self.fits[extension].header
+        self.data = self.fits[extension].data
+        self.wcs = WCS(self.header)
+        ### TO DO ##
+        sky1 = self.wcs.pixel_to_world(0,0)
+        sky2 = self.wcs.pixel_to_world(-1,-1)
+        print("---------- Recommendations ------------")
+        print("---------- Use the ra and dec within the following range ------------")
+        print(f"ra between {sky1.ra.value:.6f} and {sky2.ra.value:.6f}.")
+        print(f"dec between {sky1.dec.value:.6f} and {sky2.dec.value:.6f}.")
+        return 
+    
+    def zoom(self, coordinates, cutout_dimensions, save=False):
+        """
+        Zoom into the given coordinates and create a cutout with the given dimensions
+
+        Args:
+            coordinates (tuple): ra, dec in decimal degrees
+            cutout_dimensions (tuple): dimensions 
+            
+        Return:
+            axes: plt.plot of the cutout image
+            cutout: 
+        """
+
+        if cutout_dimensions[0].unit != u.arcsec or cutout_dimensions[1].unit != u.arcsec:
+            raise ValueError("please use arcseconds for the dimensions")
+        
+        cutout = Cutout2D(self.data, coordinates, cutout_dimensions, wcs=self.wcs)
+        
+        ax = self.plot(data=cutout.data, save=save)
+
+        return ax, cutout
+    
+    
+    def plot(self, data=None, save=False, **kwargs):
+        """
+        Use matplotlib imshow to display the cutout
+        
+        Args:
+            data : data from FITS image
+
+        Returns:
+            axes: the plt axes with the image
+        """
+
+        if data is None:
+            data = self.data
+
+        # set some defaults
+        if not kwargs.get('vmin', False):
+            kwargs['vmin'] = np.percentile(self.data, 1)
+
+        if not kwargs.get('vmax', False):
+            kwargs['vmax'] = np.percentile(self.data, 99)
+    
+        fig, ax = plt.subplots(1,1, subplot_kw=dict(projection=self.wcs))
+
+        ax.imshow(data, **kwargs, origin='lower')
+        ax.grid(color='white', ls='solid')
+
+        return plt.gca()
+    
+
+    def save(self, cutout, output_filename):
+        """
+        Save a cutout to a new FITS file, without changing the cutout's WCS in the header.
+        """
+
+        new_header = cutout.wcs.to_header()
+
+        # Wrap the cropped pixel data and the new header into a primary HDU
+        hdu = fits.PrimaryHDU(data=cutout.data, header=new_header)
+        # Write it out to disk, overwriting any existing file at that path
+        hdu.writeto(output_filename, overwrite=True)
+
+        return output_filename

fitszoom-0.0.1.dist-info/METADATA

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: fitszoom
+Version: 0.0.1
+License-File: LICENSE
+Requires-Dist: numpy>=2.0
+Requires-Dist: astropy
+Requires-Dist: matplotlib
+Requires-Dist: pytest
+Dynamic: license-file

fitszoom-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+fitszoom/__init__.py,sha256=u8Vp6ORhsINNcmZ-9CaYV-_GWoRERmJoJfF2Wtg7edk,194
+fitszoom/zoom.py,sha256=7TD0Sz4i-qwXViQKxvmhomfiLxv6CyuvVHpTWAbHG8I,3875
+fitszoom-0.0.1.dist-info/licenses/LICENSE,sha256=BeoIgq35gYaTYUn9W-wi0EyO_K3ox5mwBfohtul1l94,1123
+fitszoom-0.0.1.dist-info/METADATA,sha256=Z6vnqf7PULTNNzRTHckPUDInmwdaA6KR0aGu_aMpPw8,193
+fitszoom-0.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+fitszoom-0.0.1.dist-info/top_level.txt,sha256=VCocApiWyWUW94rmT3XLTZBIq2iYcAHgOI5zGvrGzZM,9
+fitszoom-0.0.1.dist-info/RECORD,,

fitszoom-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fitszoom-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2026] [Christa DeCoursey, Haille Perkins, Omar Velasco, Toe Oo Wai Yan]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fitszoom-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+fitszoom