TARDIS-Spectrum-Filtering 1.0.0__py2.py3-none-any.whl

TARDIS_Spectrum_Filtering/TARDIS_Spectrum_Filtering.py

@@ -0,0 +1,134 @@
+"""Main module."""
+import os
+import xml.etree.ElementTree as et
+import matplotlib.pyplot as plt
+import numpy as np
+import requests
+import yaml
+from astropy import units as u
+
+# Function to get Filter URL from TARDIS config file
+def get_url_from_config(config_file_path):
+    
+    with open(config_file_path, 'r') as f:
+        config = yaml.safe_load(f)
+        telescope = config['filter']['Telescope_Name']
+        instrument = config['filter']['Instrument']
+        filter_id = config['filter']['Filter_ID']
+
+
+    name = f"{telescope}/{instrument}.{filter_id}"
+    safe_name = name.replace('/', '.')
+    url = f"https://svo2.cab.inta-csic.es/theory/fps/fps.php?ID={name}"
+
+    return url, safe_name
+
+
+# Function to check if the filter file is valid
+def check_filter(filter_name):
+    
+    root = et.parse(f"Filters/{filter_name}.xml")
+    
+    info = root.find('INFO')
+
+    check = info.get('value')
+
+    if check == 'ERROR':
+        return False
+    elif info is None:
+        return False
+    else:
+        return True
+
+
+# Function to download the filter file
+def download_filter(url, filename):
+    req = requests.get(url, timeout = 10)
+
+    with open((f'Filters/{filename}.xml'), 'wb') as f:
+            
+        # Chunking to avoid large memory consumption
+        for chunk in req.iter_content(chunk_size=8192):
+            if chunk:
+                f.write(chunk)
+    
+    if check_filter(filename) == True:
+        print("Filter URL is valid.")
+        return filename
+    elif check_filter(filename) == False:
+        print("Filter URL is not valid. Removing invalid filter file.")
+        os.remove(f'Filters/{filename}.xml')
+        raise ValueError("Invalid Filter URL. The filter file has been removed.")
+
+
+# Function to get wavelength and transmission values from filter file
+def get_filter(filter_name):
+    
+    # Parse XML File from Filters Directory 
+    root = et.parse(f"Filters/{filter_name}.xml")
+    
+    # Get wavelength and transmission values in one array (Will be in aleternating order)
+    all_vals = np.array([float(x.text) for x in root.findall('.//TD')])
+
+    # Separate wavelength and transmission values
+    wl = all_vals[0::2] * u.AA
+    tr = all_vals[1::2]
+    return wl, tr
+
+
+# Function to interpolate filter to match TARDIS Spectrum
+def interp_filter(spectrum_to_filter, filter_name):
+    #Interpolate filter transmission values to match TARDIS Spectrum
+    wl, tr = get_filter(filter_name)
+    return np.interp(spectrum_to_filter, wl, tr)
+
+# Function to apply filter to TARDIS Spectrum
+def apply_filter(spectrum, spectrum_virtual, spectrum_integrated, chosen_filter):
+    
+    # Interpolate filter transmission values to match TARDIS Spectrum
+    prepared_filter = interp_filter(spectrum.wavelength, chosen_filter)
+    
+    # Apply filter to TARDIS Spectrum
+    filtered_spectrum = spectrum.luminosity_density_lambda * prepared_filter
+    filtered_spectrum_virt = spectrum_virtual.luminosity_density_lambda * prepared_filter
+    filtered_spec_integ = spectrum_integrated.luminosity_density_lambda * prepared_filter
+    return filtered_spectrum, filtered_spectrum_virt, filtered_spec_integ
+
+
+# Function to plot original TARDIS Spectrum
+def plot_original_spectrum(spectrum, spectrum_virtual, spectrum_integrated):
+    # Plot TARDIS Spectrum before filtering
+    plt.figure()
+    plt.plot(spectrum.wavelength, spectrum.luminosity_density_lambda)
+    plt.plot(spectrum.wavelength, spectrum_virtual.luminosity_density_lambda)
+    plt.plot(spectrum.wavelength, spectrum_integrated.luminosity_density_lambda)
+    plt.xlabel("Wavelength (Angstrom)")
+    plt.ylabel("Luminosity Density (erg/s/Angstrom)")
+    plt.title("Unfiltered TARDIS Spectrum")
+
+
+# Function to plot filter transmission curve
+def plot_filter(spectrum, chosen_filter):
+    
+    # Interpolate filter transmission values to match TARDIS Spectrum
+    prepared_filter = interp_filter(spectrum.wavelength, chosen_filter)
+    
+    # Plot the filter transmission curve
+    plt.figure()
+    plt.plot(spectrum.wavelength, prepared_filter)
+    plt.title("Filter Transmission Curve")
+    plt.xlabel("Wavelength (Angstrom)")
+    plt.ylabel("Transmission")
+
+
+# Function to plot the filtered spectrum
+def plot_filtered_spectrum(spectrum, spectrum_virtual, spectrum_integrated, chosen_filter):
+
+    plt.figure()
+    plt.plot(spectrum.wavelength, apply_filter(spectrum, spectrum_virtual, spectrum_integrated, chosen_filter)[0])
+    plt.plot(spectrum.wavelength, apply_filter(spectrum, spectrum_virtual, spectrum_integrated, chosen_filter)[1])
+    plt.plot(spectrum.wavelength, apply_filter(spectrum, spectrum_virtual, spectrum_integrated, chosen_filter)[2])
+    plt.xlabel("Wavelength (Angstrom)")
+    plt.ylabel("Luminosity Density (erg/s/Angstrom)")
+    plt.title("Filtered TARDIS Example Model Spectrum")
+    plt.show()

TARDIS_Spectrum_Filtering/__init__.py

@@ -0,0 +1,5 @@
+"""Top-level package for TARDIS-Spectrum-Filtering."""
+
+__author__ = """Clyde Watson"""
+__email__ = "clyde.n.watson@gmail.com"
+__version__ = "0.0.1"

TARDIS_Spectrum_Filtering/common.py

@@ -0,0 +1,7 @@
+"""The common module contains common functions and classes used by the other modules.
+"""
+
+def hello_world():
+    """Prints "Hello World!" to the console.
+    """
+    print("Hello World!")

tardis_spectrum_filtering-1.0.0.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: TARDIS_Spectrum_Filtering
+Version: 1.0.0
+Summary: Package used to apply telescope filters to spectra from Stars or Supernovae
+Author-email: Clyde Watson <clyde.n.watson@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/ClydeME/TARDIS_Spectrum_Filtering
+Keywords: TARDIS_Spectrum_Filtering
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Provides-Extra: all
+Requires-Dist: spectra-filtering[extra]; extra == "all"
+Provides-Extra: extra
+Requires-Dist: pandas; extra == "extra"
+Dynamic: license-file
+
+# spectra-filtering
+
+
+[![image](https://img.shields.io/pypi/v/spectra-filtering.svg)](https://pypi.python.org/pypi/spectra-filtering)
+[![image](https://img.shields.io/conda/vn/conda-forge/spectra-filtering.svg)](https://anaconda.org/conda-forge/spectra-filtering)
+
+
+**Package used to apply telescope filters to spectra from Stars or Supernovae**
+
+
+-   Free software: MIT License

tardis_spectrum_filtering-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+TARDIS_Spectrum_Filtering/TARDIS_Spectrum_Filtering.py,sha256=9m6ajMDodJ9E99B-6pFLUsc05Q7J-7IkSNqQCPFEC0U,4807
+TARDIS_Spectrum_Filtering/__init__.py,sha256=y_joxtHrPuHZgVWumIkTeL6xQSMtGSZMl37BKLOKiwM,149
+TARDIS_Spectrum_Filtering/common.py,sha256=UkxoF8RazqaFu7o-ZH3HUoPu7oVGAAB3Ja02Zm6IW9I,189
+tardis_spectrum_filtering-1.0.0.dist-info/licenses/LICENSE,sha256=J8qEL369U2AjyyxQeLNe50xQVZj1CVfxpcR-KZDYSqk,1071
+tardis_spectrum_filtering-1.0.0.dist-info/METADATA,sha256=tNAEtN-Z4VXsKN-Wz2zqwLh-qVpkUi1CkdP3iChVpeg,1375
+tardis_spectrum_filtering-1.0.0.dist-info/WHEEL,sha256=Mk1ST5gDzEO5il5kYREiBnzzM469m5sI8ESPl7TRhJY,110
+tardis_spectrum_filtering-1.0.0.dist-info/entry_points.txt,sha256=VxSb86QTkEoasQ0E8LoEnYMdvYEQ0Ji1sXpvx6CH6II,81
+tardis_spectrum_filtering-1.0.0.dist-info/top_level.txt,sha256=JAeZtUL5WUopZQbw6RgjDU0dO7I7Fytpfil1lz4lLjM,26
+tardis_spectrum_filtering-1.0.0.dist-info/RECORD,,

tardis_spectrum_filtering-1.0.0.dist-info/WHEEL

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

tardis_spectrum_filtering-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+TARDIS_Spectrum_Filtering = TARDIS_Spectrum_Filtering.cli:main

tardis_spectrum_filtering-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026, Clyde Watson
+
+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.
+

tardis_spectrum_filtering-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+TARDIS_Spectrum_Filtering