Added redshiftErrs as output of classification.list_best_matches() an…

…d have updated documentation examples appropriately.
daniel-muthukrishna · Mar 27, 2019 · bfbd2b7 · bfbd2b7
1 parent 8dfa9b7
commit bfbd2b7
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -99,7 +99,7 @@ Use the following example code:
     import astrodash
 
     classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=False, knownZ=True, smooth=6, rlapScores=False)
-    bestFits, redshifts, bestTypes, rejectionLabels, reliableFlags = classification.list_best_matches(n=5, saveFilename='DASH_matches.txt')
+    bestFits, redshifts, bestTypes, rejectionLabels, reliableFlags, redshiftErrs = classification.list_best_matches(n=5, saveFilename='DASH_matches.txt')
     classification.plot_with_gui(indexToPlot=2)
 
 astrodash.Classify() takes the following arguments:
@@ -184,7 +184,7 @@ This example automatically classifies 10 spectra. The last line plots the fifth
 
     # Classify all spectra
     classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=False)
-    bestFits, redshifts, bestTypes, rlapFlag, matchesFlag = classification.list_best_matches(n=5, saveFilename='ATEL_best_fits.txt')
+    bestFits, redshifts, bestTypes, rlapFlag, matchesFlag, redshiftErrs = classification.list_best_matches(n=5, saveFilename='ATEL_best_fits.txt')
 
     # Plot DES16C3bq
     classification.plot_with_gui(indexToPlot=4)

diff --git a/astrodash/classify_DES_Y4_spectra_DASH.py b/astrodash/classify_DES_Y4_spectra_DASH.py
@@ -130,8 +130,8 @@
 filenames = [os.path.join(directory, i[0]) for i in atels]
 knownRedshifts = [i[1] for i in atels]
 
-classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=False, rlapScores=True)
-bestFits, redshifts, bestTypes, rejectionLabels, reliableFlags = classification.list_best_matches(n=5)
+classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=True, rlapScores=True, knownZ=True)
+bestFits, redshifts, bestTypes, rejectionLabels, reliableFlags, redshiftErrs = classification.list_best_matches(n=5)
 
 # SAVE BEST MATCHES
 print(bestFits)

diff --git a/astrodash/classify_OzDES_ATELs.py b/astrodash/classify_OzDES_ATELs.py
@@ -81,7 +81,7 @@
 filenames = [os.path.join(directoryPath, i[0]) for i in atels]
 knownRedshifts = [i[1] for i in atels]
 
-classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=False, smooth=5, knownZ=False)
+classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=False, smooth=5, knownZ=True)
 bestFits, redshifts, bestTypes, rejectionLabels, reliableFlags, redshiftErrs = classification.list_best_matches(n=5)
 
 # SAVE BEST MATCHES

diff --git a/docs/example.rst b/docs/example.rst
@@ -22,7 +22,7 @@ This example automatically classifies 4 spectra. The last line plots the second
 
     # Classify all spectra
     classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=False, knownZ=True, smooth=6)
-    bestFits, redshifts, bestTypes, rlapFlag, matchesFlag = classification.list_best_matches(n=5, saveFilename='example_best_fits.txt')
+    bestFits, redshifts, bestTypes, rlapFlag, matchesFlag, redshiftErrs = classification.list_best_matches(n=5, saveFilename='example_best_fits.txt')
 
     # Plot sn2013fs from open supernova catalog (2nd spectrum)
     classification.plot_with_gui(indexToPlot=1)
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -77,7 +77,7 @@ Use the following example code:
     import astrodash
 
     classification = astrodash.Classify(filenames, knownRedshifts, classifyHost=False, knownZ=True, smooth=6, rlapScores=False)
-    bestFits, redshifts, bestTypes, rejectionLabels, reliableFlags = classification.list_best_matches(n=5, saveFilename='DASH_matches.txt')
+    bestFits, redshifts, bestTypes, rejectionLabels, reliableFlags, redshiftErrs = classification.list_best_matches(n=5, saveFilename='DASH_matches.txt')
     classification.plot_with_gui(indexToPlot=2)
 
 dash.Classify() takes the following arguments: