FilterMags 0.0.1__tar.gz

filtermags-0.0.1/FilterMags/filtermag.py

@@ -0,0 +1,90 @@
+# outside packages
+import os
+from astropy.io import ascii
+from astropy.io import fits
+import numpy as np
+
+# dictionary containing keywords for all filter transmission files
+current_dir = os.getcwd()
+filter_dict = {
+    "sdss_u": os.path.join(current_dir, 'TransmissionCurves/SLOAN_SDSS.u.dat'),
+    "sdss_g": os.path.join(current_dir, 'TransmissionCurves/SLOAN_SDSS.g.dat'),
+    "sdss_r": os.path.join(current_dir, 'TransmissionCurves/SLOAN_SDSS.r.dat'),
+    "sdss_i": os.path.join(current_dir, 'TransmissionCurves/SLOAN_SDSS.i.dat'),
+    "sdss_z": os.path.join(current_dir, 'TransmissionCurves/SLOAN_SDSS.z.dat'),
+}
+
+# read the transmission curve
+class TransmissionCurve:
+    """
+    Class that defines transmission curve objects. Each transmission curve has a filter name and arrays of 
+    wavelengths and transmission (%) based on the transmission curve files in the repo. The dictionary 
+    ``filter_dict`` contains the file names for each filter.
+    """
+    def __init__(self, filtername):
+        """Constructor method
+        """
+        filename = filter_dict[filtername]
+        transmission_data = ascii.read(filename)
+        self.wavelength = transmission_data['col1'].data
+        self.transmission = transmission_data['col2'].data
+        pass
+
+# read SDSS spectrum from a FITS file
+def read_spectrum(filename):
+    """Read SDSS spectrum from FITS
+
+    Function to read an SDSS spectrum from a FITS file.
+
+    Args:
+        filename (string): name of the FITS spectrum file
+
+    Returns:
+        wave_spectra (array): wavelength of the spectrum in Angstroms
+        flux (array): flux of the spectrum in erg s-1 cm-2 A-1
+    """
+    spectrum_file = fits.open(filename)
+    spectrum_data = spectrum_file[1].data
+
+    wave_spectra = 10**spectrum_data['loglam']
+    flux = spectrum_data['flux'] * 1e-17
+
+    spectrum_file.close()
+
+    return wave_spectra, flux
+
+# calculate filter magnitude
+def filter_mag(wave_spectra, flux, filter):
+    """Filter magnitude calculator
+
+    Calculate the filter magnitude for a spectrum provided by the user in a given filter.
+    
+    Args: 
+        wave_spectra (array): the wavelengths of the spectrum (in Angstroms)
+        flux (array): the associated fluxes for the wavelengths (in erg s-1 cm-2 A-1)
+        filter (string): the filter that magnitude will be calculated in, identified using a key in ``filter_dict``
+    
+    Returns: 
+        float: filter magnitude for the spectrum
+    """
+    # read in the transmission curve for the given filter
+    trans_curve = TransmissionCurve(filter)
+    wave_trans = trans_curve.wavelength
+    t = trans_curve.transmission
+
+    if max(wave_spectra) < max(wave_trans) or min(wave_spectra) > min(wave_trans):
+        raise ValueError('At least part of filter out of range of spectrum')
+    
+    # three integrals that are needed for calculation
+    int_1 = np.trapezoid(t / wave_trans, wave_trans)
+    int_2 = np.trapezoid(t * wave_trans, wave_trans)
+    t_spectra = np.interp(wave_spectra, wave_trans, t, left=0, right=0) #interpolation for third integral
+    int_3 = np.trapezoid((flux*t_spectra)/wave_spectra, wave_spectra)
+
+    # magnitude calculation
+    flam = int_3 / int_1 #f_lambda
+    pivot = int_2 / int_1 #pivot wavelength squared
+    c = 3e18 #angstrom/s
+    mag = -2.5 * np.log10(flam) - 2.5 * np.log10(pivot / c) - 48.6
+
+    return mag

filtermags-0.0.1/FilterMags.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: FilterMags
+Version: 0.0.1
+Summary: A package to calculate AB magnitude of a filter given a spectrum.
+Author-email: Simarpreet Girn <girn.simarpreet@gmail.com>, Katherine Panebianco <kpanebianco@me.com>, Yogita Patel <ypatel@das.uchile.cl>
+Project-URL: Homepage, https://github.com/SimGirn/FilterMags
+Project-URL: Issues, https://github.com/SimGirn/FilterMags/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: os
+Requires-Dist: astropy
+Requires-Dist: numpy
+Requires-Dist: speclite
+Dynamic: license-file
+
+# FilterMags
+Calculate the AB magnitude in various filters for spectra from SDSS.
+Code Astro project

filtermags-0.0.1/FilterMags.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+FilterMags/__init__.py
+FilterMags/filtermag.py
+FilterMags.egg-info/PKG-INFO
+FilterMags.egg-info/SOURCES.txt
+FilterMags.egg-info/dependency_links.txt
+FilterMags.egg-info/requires.txt
+FilterMags.egg-info/top_level.txt

filtermags-0.0.1/FilterMags.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

filtermags-0.0.1/FilterMags.egg-info/requires.txt

@@ -0,0 +1,4 @@
+os
+astropy
+numpy
+speclite

filtermags-0.0.1/FilterMags.egg-info/top_level.txt

@@ -0,0 +1 @@
+FilterMags

filtermags-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+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.

filtermags-0.0.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: FilterMags
+Version: 0.0.1
+Summary: A package to calculate AB magnitude of a filter given a spectrum.
+Author-email: Simarpreet Girn <girn.simarpreet@gmail.com>, Katherine Panebianco <kpanebianco@me.com>, Yogita Patel <ypatel@das.uchile.cl>
+Project-URL: Homepage, https://github.com/SimGirn/FilterMags
+Project-URL: Issues, https://github.com/SimGirn/FilterMags/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: os
+Requires-Dist: astropy
+Requires-Dist: numpy
+Requires-Dist: speclite
+Dynamic: license-file
+
+# FilterMags
+Calculate the AB magnitude in various filters for spectra from SDSS.
+Code Astro project

filtermags-0.0.1/README.md

@@ -0,0 +1,3 @@
+# FilterMags
+Calculate the AB magnitude in various filters for spectra from SDSS.
+Code Astro project

filtermags-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "FilterMags"
+version = "0.0.1"
+authors = [
+    { name = "Simarpreet Girn", email = "girn.simarpreet@gmail.com"},
+    { name='Katherine Panebianco', email='kpanebianco@me.com'},
+    { name = 'Yogita Patel', email='ypatel@das.uchile.cl'},
+]
+description = "A package to calculate AB magnitude of a filter given a spectrum."
+readme = "README.md"
+requires-python = ">=3.10"
+
+dependencies = [
+    "os",
+    "astropy",
+    "numpy",
+    "speclite"
+]
+
+[project.urls]
+Homepage = "https://github.com/SimGirn/FilterMags"
+Issues = "https://github.com/SimGirn/FilterMags/issues"

filtermags-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+