Merge remote-tracking branch 'origin/gaussian-fit' into pyramid-smart…

…-pyramid-selection

.gitignore

@@ -8,6 +8,13 @@
 *.txt
 *.bin
 
+*.out.*
+*.lisp
+*.org
+*.py
+*.json
+/.gdb_history
+
 BSC5
 
 /documentation/man-*.h

Makefile

@@ -1,15 +1,15 @@
 # Copyright (c) 2020 Mark Polyakov, Karen Haining (If you edit the file, add your name here!)
-# 
+#
 # 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
@@ -57,9 +57,6 @@ release: CXXFLAGS := $(RELEASE_CXXFLAGS)
 release: LDFLAGS := $(RELEASE_LDFLAGS)
 release: all
 
-$(BSC): download-bsc.sh
-	./download-bsc.sh
-
 $(BIN): $(OBJS)
 	$(CXX) $(LDFLAGS) -o $(BIN) $(OBJS) $(LIBS)
 

documentation/pipeline.man

@@ -92,6 +92,13 @@ The field of view of the camera that took the picture (in degrees). Defaults to
 \fB--centroid-mag-filter\fP \fImin-mag\fP
 Will not consider centroids with magnitude below \fImin-mag\fP.
 
+.TP
+\fB--centroid-filter-brightest\fP \fInum-stars\fP
+Remove all but the brightest \fInum-stars\fP many stars from the list of centroids before sending to
+star-id. Often a better choice than \fB--centroid-mag-filter\fP, because you can ensure that you
+keep enough stars to do star-id. If both this option and \fB--centroid-mag-filter\fP are provided,
+then all stars satisfying both criteria are kept (intersection).
+
 .TP
 \fB--database\fP \fIfilename\fP
 Chooses \fIfilename\fP as the database to use during star identification.
@@ -149,8 +156,14 @@ Sets the horizontal resolution of the generated image(s) to \fIpixels\fP. Defaul
 Sets the vertical resolution of the generated image(s) to \fIpixels\fP. Defaults to 1024.
 
 .TP
-\fB--generate-reference-brightness\fP \fIobserved-brightness\fP
-A star with magnitude 0 in the generated image will have have brightness \fIobserved-brightness\fP. An observed brightness of 1 fully saturates the pixel at the center of the star (completely white). Defaults to 100.
+\fB--generate-zero-mag-photons\fP \fInum-photoelectrons\fP
+A star with magnitude 0 will cause \fInum-photoelectrons\fP many photoelectrons to be received by
+the sensor. A default value of 20,000 is chosen. See Liebe's, "tutorial on star tracker accuracy" for theoretical information on how to calculate this.
+
+.TP
+\fB--generate-saturation-photons\fP \fIsaturation-photoelectrons\fP
+
+When a pixel receives at least this many photoelectrons, it will appear completely white (at least before other noise is applied). Note that, because of noise, a pixel may still appear completely white if it receives less than \fIsaturation-photoelectrons\fP many photoelectrons.
 
 .TP
 \fB--generate-spread-stddev\fP \fIstddev\fP
@@ -164,10 +177,6 @@ Enables or disables shot noise simulation in generated images. Defaults to true.
 \fB--generate-dark-current\fP \fInoise-level\fP
 Set observed brightness of dark current in the image, from 0 (no dark noise) to 1 (whole image pure white). Defaults to 0.1. cf \fB--generate-sensitivity\fP to control shot noise intensity.
 
-.TP
-\fB--generate-sensitivity\fP \fIsensitivity\fP
-Controls the simulated camera sensitivity for generated images. This only has an observable effect when shot noise is enabled (cf \fB--generate-shot-noise\fP). A higher sensitivity means that fewer photons can cause the same observed brightness on the sensor, so variation in number of photons causes more shot noise. Brightness is normalized according to \fB--generate-reference-brightness\fP so that adjusting sensitivity does not change observed brightness.
-
 .TP
 \fB--generate-read-noise-stddev\fP \fIstddev\fP
 Sets the standard deviation of Gaussian noise in the generated image(s) to \fIstddev\fP. Noise is measured in observed brightness, where 1 is the difference between pure white and pure black. Defaults to 0.05.