Superfit in python is a software for the spectral classification of Supernovae of all major types accompanied by a host galaxy. The following list of versions are the minumum requierments for its use.
This version has been altered to automatically obtain, fit, and post spectral fits to the Fritz Marshal as part of the ZTF project
config/parameters.json
Update appropriate paths in these files to point to the template bank and the NGSF package top directory. You will also need to put in a token generated from your account profile on Fritz. You can also adjust the parameters for specific fitting.
Python version: 3.7.1numpy version: 1.21.2scipy version: 1.7.1matplotlib version: 3.0.2astropy version: 3.1Pandas version: 0.23.4PyAstronomy version: 0.13.0extinction version: 0.4.6requests version: 2.32.3simplejson version: 3.19.3
The user must make sure to have a template bank to look at. The new template bank can be downloaded from WISeREP here.
The user must download the full superfit folder. The template bank may be placed
anywhere, but the "bank_dir" variable in config/parameters.json must indicate
the path to the bank. The user only changes the parameters from the json file
already within the folder. An explanation of the parameters is below.
The script download_fit_post requires a single argument, which is the spectrum ID on Fritz:
python download_fit_post.py 27168
Will run the code on the DBSP spectrum obtained on 08/16/24 for ZTF24abbenwl
You can view the additional options for the script by running python download_fit_post.py -h
positional arguments: specid specid of spectrum of interest on Fritz
options:
-h, --help show this help message and exit
--fritz_z Use this option to fetch the value of the redshift on Fritz and use that for fitting.
-z REDSHIFT, --redshift REDSHIFT Use this option to fix the redshift
-n, --ngps Use this option to modify wavelength range for fitting based on NGPS R and I channels
--ghts Use this option to modify wavelength range for fitting based on the SOAR GHTS bandpass
--wav_range MIN_WAV MAX_WAV Specify min and max wavelengths to use for fitting in angstroms
The --fritz_z flag trumps a specified redshift using the -z flag and --INSTRUMENT trumps --wav_range
You must run this script from the NGSF directory
The user must only change the parameters of the fit from the parameters.json
file, the file looks like this (the template for this example is included in
the git repository).
"object_to_fit" : "place_hold",
"use_exact_z": 0,
"z_exact": 0.127,
"z_range_begin": 0,
"z_range_end": 0.15,
"z_int": 0.001,
"resolution":10,
"temp_sn_tr" : ["IIb-flash", "computed", "Ia 02es-like", "Ia-02cx like", "TDE He", "Ca-Ia",
"Ia-CSM-(ambigious)", "II", "super_chandra", "SLSN-II", "IIn", "FBOT", "Ibn",
"SLSN-IIn", "Ia 91T-like", "IIb", "TDE H", "SN - Imposter", "II-flash", "ILRT",
"Ia 99aa-like", "Ic", "SLSN-I", "Ia-pec", "Ib", "Ia-CSM", "Ia-norm", "SLSN-Ib",
"TDE H+He", "Ia 91bg-like", "Ca-Ib", "Ia-rapid", "Ic-BL", "Ic-pec", "SLSN-IIb"],
"temp_gal_tr" : ["E","S0","Sa","Sb","SB1","SB2","SB3","SB4","SB5","SB6","Sc"],
"saving_results_path" : "placehold/",
"lower_lam": 4000,
"upper_lam": 9500,
"error_spectrum" : "sg",
"show_plot" : 0,
"how_many_plots" : 3,
"show_plot_png": 1,
"verbose": 0,
"mask_galaxy_lines":0,
"mask_telluric":1,
"minimum_overlap": 0.7,
"epoch_high": 0,
"epoch_low" : 0,
"Alam_high": 2,
"Alam_low": -2,
"Alam_interval":0.2,
"pkg_dir": "/Users/samrose/Research/superfit_for_fritz/NGSF/",
"bank_dir": "/Users/samrose/Research/superfit_for_fritz/bank/",
"fritz_token": "your_fritz_token"
"object_to_fit" : the object to analyze, default only. This is written when the wrapper script is run.
"use_exact_z": can be 1 (yes) or 0 (no). Determines weather the redshift will be an exact number or an array.
"z_exact" : exact redshift value that will be used if "use_exact_z" = 1
"z_range_begin","z_range_end","z_int": redshift values from which to build an array over which to look for the best fit.
"resolution": the resolution of the fit, the default for SEDM is 30Å, however, if the spectra is of higher resolution then 10Å can be specified.
"temp_gal_tr", "temp_sn_tr": template library folders over which to look in order to find the fit. It is recommended that the user uses the full library as is.
"lower_lam": Lower bound for wavelength over which to perform the fit
"upper_lam": Upper bound for wavelength over which to perform the fit, if this is equal to "lower_lam" then the wavelength range will be chosen automatically as that of the object to fit ± 300Å
"error_spectrum" : refers to the type of routine used to perform the calculation of the error spectrum. The recommended one is sg Savitzky-Golay, there is also the option of linear estimation and the option included in which the user can use the error spectrum that comes with an object if he wants to, however, this is not recommended.
"saving_results_path": path in which to save the performed fits.
"show_plot" : to show the plotted fit or no, the default being 1, to show.
"how_many_plots": number of plots to show if the user wants to show, if the "show" is zero then "n" has no effect.
"show_plot_png": set to 1 to output a png plot, a zero value or no parameter defaults to a pdf plot.
"verbose": set to 1 for more output to screen.
"mask_galaxy_lines" : Either 1 or 0, masks the galaxy lines for both the template bank and the object of interest. For this option to work the redshift must be one defined values and not at array of values, meaning "z_int" must be equal to zero and "z_start" must be the redshift of choice.
"mask_telluric": Either 1 or 0, masks the flux within the wavelength range from 7594 to 7680 in the observer's frame.
"minimum_overlap": minimum percentage overlap between the template and the object of interest. Recommendation is for this to stay near 0.7
"epoch_high": Upper bound epoch for phase truncation. If this equals the "epoch_low" parameter then there is no phase truncation.
"epoch_low": Lower bound epoch for phase truncation.
"Alam_high": High value for the extinction law constant
"Alam_low": Lower value for the extinction law constant
"Alam_interval": size of interval
"pkg_dir": Full path to the top level of the software package
"bank_dir": Full path to the template bank
"fritz_token": Your Fritz token. Can be generated from your profile page on Fritz.
The improved Superfit template bank contains major subclasses such as: calcium rich supernovae, type II flashers, TDEs, SLSN-I and II, among others, separated in different folders for more accurate classification. The default option for binning in 10A. The user must make sure to have this template bank or some alternative template bank of his own in order to run NGSF, and please be mindful that NGSF is only as good as the template bank it uses.
The user has the option to create a bank with masked lines, meaning to mask host
galaxy lines that could be in the templates, this option is default to False.
If the user is interested in seeing which lines are being masked he can access
the mask_lines_bank function within the Header_binnings.py file.
It is important to note that when you open the folder of the bank there are two main subfolders, one named "original_resolution" and one named "binnings". The "original_resolution" folder contains the raw spectra from the bank, with the wavelengths in observed frame. In the "binnings" folder we have the binned and redshift-corrected spectra from the "original_resolution" folder, and so the fits are done using the "binnings" folder. Within the object subfolders inside the "original_resolution" folder we will find the wiserep files containing the metadata for each object (name,redshift, observational date, etc.) we use this metadata during the fit, and so we keep the folder.
In the sf_class.py file we find the main function which looks like this:
all_parameter_space(self.int_obj,Parameters.redshift,Parameters.extconstant,Parameters.templates_sn_trunc,
Parameters.templates_gal_trunc, Parameters.lam, Parameters.resolution,Parameters.iterations,
kind=Parameters.kind, original= self.binned_name, save=self.results_name, show=show,
minimum_overlap=Parameters.minimum_overlap)The inputs of the function are called from the Parameters class within the params.py file, and are as follows:
self.int_obj: interpolated object to fitredshift:Can be an array or an individual number. These are the redshift values over which to optimize.extconstant: Array of values over which to optimize for the extinction constant. The user does not change this.templates_sn_trunc:Truncated library of supernovae, aka: which SN types to look at when optimizing.templates_gal_trunc:Truncated library of host galaxies, aka: which HG types to look at when optimizing.lam:Lambda array over which to perform the fit. The default is from 3000 A to 10500 A.resolution:Resolution at which to bin and perform the fit. The default for SEDM is 30 A.kind:Corresponds to the type of error spectrum the user prefers, the options areSG:Savitsky Golay,linear: for obtaining the error of the spectrum by making linear fit every 10 points, andincluded: if the user wants to use the error that comes with the object itself. The default issgsave:Name of results fileminimum_overlap:Corresponds to minimum percentage overlap between the template and the object of interest
The results are: an astropy table that is saved as a csv file, and the best fit
plots saved as pdf or png files (they both save to the folder where you execute
the ngsf_run script or to the specified saving_results_path)
The plot shows the input object in red, the SN and Host Galaxy combined templates in green. The legend shows the SN type, HG type and percentage contribution from the SN template to the fit. On top of the plot the redshift value is indicated.