Remove the (unused) valid bit from trajectories.

src/kbmod/filters/sigma_g_filter.py

@@ -10,6 +10,7 @@
 from scipy.special import erfinv
 
 from kbmod.results import Results
+from kbmod.search import DebugTimer
 
 logger = logging.getLogger(__name__)
 
@@ -177,7 +178,9 @@ def apply_clipped_sigma_g(clipper, result_data):
         logger.info("SigmaG Clipping : skipping, nothing to filter.")
         return
 
+    filter_timer = DebugTimer("sigma-g filtering", logger)
     lh = result_data.compute_likelihood_curves(filter_obs=True, mask_value=np.nan)
     obs_valid = clipper.compute_clipped_sigma_g_matrix(lh)
     result_data.update_obs_valid(obs_valid)
+    filter_timer.stop()
     return

src/kbmod/results.py

@@ -139,9 +139,8 @@ def from_trajectories(cls, trajectories, track_filtered=False):
         input_d = {}
         for col in cls.required_cols:
             input_d[col[0]] = []
-        valid_mask = []
 
-        # Add the valid trajectories to the table.
+        # Add the trajectories to the table.
         for trj in trajectories:
             input_d["x"].append(trj.x)
             input_d["y"].append(trj.y)
@@ -150,17 +149,14 @@ def from_trajectories(cls, trajectories, track_filtered=False):
             input_d["likelihood"].append(trj.lh)
             input_d["flux"].append(trj.flux)
             input_d["obs_count"].append(trj.obs_count)
-            valid_mask.append(trj.valid)
 
         # Check for any missing columns and fill in the default value.
         for col in cls.required_cols:
             if col[0] not in input_d:
-                input_d[col[0]] = [col[2]] * num_valid
-                invalid_d[col[0]] = [col[2]] * num_invalid
+                input_d[col[0]] = [col[2]] * len(trajectories)
 
         # Create the table and add the unfiltered (and filtered) results.
         results = Results(input_d, track_filtered=track_filtered)
-        results.filter_rows(np.array(valid_mask, dtype=bool), "invalid_trajectory")
         return results
 
     @classmethod

src/kbmod/search/common.h

@@ -55,8 +55,6 @@ struct Trajectory {
     int y = 0;
     // Number of images summed
     int obs_count;
-    // Whether the trajectory is valid. Used for on-GPU filtering.
-    bool valid = true;
 
     // Get pixel positions from a zero-shifted time. Centered indicates whether
     // the prediction starts from the center of the pixel (which it does in the search)
@@ -79,14 +77,13 @@ struct Trajectory {
     const std::string to_string() const {
         return "lh: " + std::to_string(lh) + " flux: " + std::to_string(flux) + " x: " + std::to_string(x) +
                " y: " + std::to_string(y) + " vx: " + std::to_string(vx) + " vy: " + std::to_string(vy) +
-               " obs_count: " + std::to_string(obs_count) + " valid: " + std::to_string(valid);
+               " obs_count: " + std::to_string(obs_count);
     }
 
     // This is a hack to provide a constructor with non-default arguments in Python. If we include
     // the constructor as a method in the Trajectory struct CUDA will complain when creating new objects
     // because it cannot call out to a host function.
-    static Trajectory make_trajectory(int x, int y, float vx, float vy, float flux, float lh, int obs_count,
-                                      bool valid) {
+    static Trajectory make_trajectory(int x, int y, float vx, float vy, float flux, float lh, int obs_count) {
         Trajectory trj;
         trj.x = x;
         trj.y = y;
@@ -95,7 +92,6 @@ struct Trajectory {
         trj.flux = flux;
         trj.lh = lh;
         trj.obs_count = obs_count;
-        trj.valid = valid;
         return trj;
     }
 };
@@ -199,16 +195,14 @@ static void trajectory_bindings(py::module &m) {
 
     py::class_<tj>(m, "Trajectory", pydocs::DOC_Trajectory)
             .def(py::init(&tj::make_trajectory), py::arg("x") = 0, py::arg("y") = 0, py::arg("vx") = 0.0f,
-                 py::arg("vy") = 0.0f, py::arg("flux") = 0.0f, py::arg("lh") = 0.0f, py::arg("obs_count") = 0,
-                 py::arg("valid") = true)
+                 py::arg("vy") = 0.0f, py::arg("flux") = 0.0f, py::arg("lh") = 0.0f, py::arg("obs_count") = 0)
             .def_readwrite("vx", &tj::vx)
             .def_readwrite("vy", &tj::vy)
             .def_readwrite("lh", &tj::lh)
             .def_readwrite("flux", &tj::flux)
             .def_readwrite("x", &tj::x)
             .def_readwrite("y", &tj::y)
             .def_readwrite("obs_count", &tj::obs_count)
-            .def_readwrite("valid", &tj::valid)
             .def("get_x_pos", &tj::get_x_pos, py::arg("time"), py::arg("centered") = true,
                  pydocs::DOC_Trajectory_get_x_pos)
             .def("get_y_pos", &tj::get_y_pos, py::arg("time"), py::arg("centered") = true,
@@ -220,13 +214,13 @@ static void trajectory_bindings(py::module &m) {
             .def("__str__", &tj::to_string)
             .def(py::pickle(
                     [](const tj &p) {  // __getstate__
-                        return py::make_tuple(p.vx, p.vy, p.lh, p.flux, p.x, p.y, p.obs_count, p.valid);
+                        return py::make_tuple(p.vx, p.vy, p.lh, p.flux, p.x, p.y, p.obs_count);
                     },
                     [](py::tuple t) {  // __setstate__
                         if (t.size() != 8) throw std::runtime_error("Invalid state!");
                         tj trj = {t[0].cast<float>(), t[1].cast<float>(), t[2].cast<float>(),
                                   t[3].cast<float>(), t[4].cast<int>(),   t[5].cast<int>(),
-                                  t[6].cast<int>(),   t[7].cast<bool>()};
+                                  t[6].cast<int>()};
                         return trj;
                     }));
 }

src/kbmod/search/pydocs/common_docs.h

@@ -22,9 +22,6 @@ static const auto DOC_Trajectory = R"doc(
     flux : `float`
         Flux (accumulated?)
     obs_count : `int`
-        Number of observations trajectory was seen in.
-    valid : `bool`
-        Whether the trajectory is valid. Used for filtering.
   )doc";
 
 static const auto DOC_Trajectory_get_x_pos = R"doc(

src/kbmod/search/pydocs/trajectory_list_docs.h

@@ -179,15 +179,6 @@ static const auto DOC_TrajectoryList_filter_by_obs_count = R"doc(
   Raises a ``RuntimeError`` the data is on GPU.
   )doc";
 
-static const auto DOC_TrajectoryList_filter_by_valid = R"doc(
-  Filter out all trajectories with the ``valid`` attribute set to ``False``.
-  Ordering is not preserved. The data must reside on the CPU.
-      
-  Raises
-  ------
-  Raises a ``RuntimeError`` the data is on GPU.
-  )doc";
-
 }  // namespace pydocs
 
 #endif /* TRAJECTORY_LIST_DOCS_ */

src/kbmod/search/trajectory_list.cpp

@@ -105,15 +105,6 @@ void TrajectoryList::filter_by_obs_count(int min_obs_count) {
     resize(index);
 }
 
-void TrajectoryList::filter_by_valid() {
-    if (data_on_gpu) throw std::runtime_error("Data on GPU");
-
-    auto new_end =
-            std::partition(cpu_list.begin(), cpu_list.end(), [](const Trajectory& x) { return x.valid; });
-    uint64_t new_size = std::distance(cpu_list.begin(), new_end);
-    resize(new_size);
-}
-
 void TrajectoryList::move_to_gpu() {
     if (data_on_gpu) return;  // Nothing to do.
 
@@ -165,7 +156,6 @@ static void trajectory_list_binding(py::module& m) {
                  pydocs::DOC_TrajectoryList_filter_by_likelihood)
             .def("filter_by_obs_count", &trjl::filter_by_obs_count,
                  pydocs::DOC_TrajectoryList_filter_by_obs_count)
-            .def("filter_by_valid", &trjl::filter_by_valid, pydocs::DOC_TrajectoryList_filter_by_valid)
             .def("move_to_cpu", &trjl::move_to_cpu, pydocs::DOC_TrajectoryList_move_to_cpu)
             .def("move_to_gpu", &trjl::move_to_gpu, pydocs::DOC_TrajectoryList_move_to_gpu);
 }

src/kbmod/search/trajectory_list.h

@@ -63,7 +63,6 @@ class TrajectoryList {
     void sort_by_obs_count();
     void filter_by_likelihood(float min_likelihood);
     void filter_by_obs_count(int min_obs_count);
-    void filter_by_valid();
 
     // Data allocation functions.
     inline bool on_gpu() const { return data_on_gpu; }

src/kbmod/trajectory_utils.py

@@ -107,10 +107,6 @@ def trajectory_from_np_object(result):
     trj.flux = float(result["flux"][0])
     trj.lh = float(result["lh"][0])
     trj.obs_count = int(result["num_obs"][0])
-    if "valid" in result.dtype.names:
-        trj.valid = bool(result["valid"][0])
-    else:
-        trj.valid = True
     return trj
 
 
@@ -135,10 +131,6 @@ def trajectory_from_dict(trj_dict):
     trj.flux = float(trj_dict["flux"])
     trj.lh = float(trj_dict["lh"])
     trj.obs_count = int(trj_dict["obs_count"])
-    if "valid" in trj_dict:
-        trj.valid = bool(trj_dict["valid"])
-    else:
-        trj.valid = True
     return trj
 
 
@@ -181,6 +173,5 @@ def trajectory_to_yaml(trj):
         "flux": trj.flux,
         "lh": trj.lh,
         "obs_count": trj.obs_count,
-        "valid": trj.valid,
     }
     return dump(yaml_dict)

tests/test_common.py

@@ -28,7 +28,6 @@ def test_trajectory_create(self):
         self.assertEqual(trj1.flux, 0.0)
         self.assertEqual(trj1.lh, 0.0)
         self.assertEqual(trj1.obs_count, 0)
-        self.assertEqual(trj1.valid, True)
 
         # All specified
         trj2 = Trajectory(x=1, y=2, vx=3.0, vy=4.0, flux=5.0, lh=6.0, obs_count=7)
@@ -39,7 +38,6 @@ def test_trajectory_create(self):
         self.assertEqual(trj2.flux, 5.0)
         self.assertEqual(trj2.lh, 6.0)
         self.assertEqual(trj2.obs_count, 7)
-        self.assertEqual(trj2.valid, True)
 
         # Some specified, some defaults
         trj3 = Trajectory(y=2, vx=3.0, vy=-4.0, obs_count=7)
@@ -50,7 +48,6 @@ def test_trajectory_create(self):
         self.assertEqual(trj3.flux, 0.0)
         self.assertEqual(trj3.lh, 0.0)
         self.assertEqual(trj3.obs_count, 7)
-        self.assertEqual(trj3.valid, True)
 
         # Four specified by order
         trj4 = Trajectory(4, 3, 2.0, 1.0)
@@ -61,7 +58,6 @@ def test_trajectory_create(self):
         self.assertEqual(trj4.flux, 0.0)
         self.assertEqual(trj4.lh, 0.0)
         self.assertEqual(trj4.obs_count, 0)
-        self.assertEqual(trj4.valid, True)
 
     def test_trajectory_predict(self):
         trj = Trajectory(x=5, y=10, vx=2.0, vy=-1.0)

tests/test_results.py

@@ -59,19 +59,6 @@ def test_from_trajectories(self):
         self.assertEqual(len(table.colnames), 7)
         self._assert_results_match_dict(table, self.input_dict)
 
-        # Test that we ignore invalid results, but track them in the filtered table.
-        self.trj_list[2].valid = False
-        self.trj_list[7].valid = False
-        table2 = Results.from_trajectories(self.trj_list, track_filtered=True)
-        self.assertEqual(len(table2), self.num_entries - 2)
-        for i in range(self.num_entries - 2):
-            self.assertFalse(table2["x"][i] == 2 or table2["x"][i] == 7)
-
-        filtered = table2.get_filtered()
-        self.assertEqual(len(filtered), 2)
-        self.assertEqual(filtered["x"][0], 2)
-        self.assertEqual(filtered["x"][1], 7)
-
     def test_from_dict(self):
         self.input_dict["something_added"] = [i for i in range(self.num_entries)]
 
@@ -507,12 +494,10 @@ def test_write_filter_stats(self):
             data = FileUtils.load_csv_to_list(file_path)
             self.assertEqual(data[0][0], "unfiltered")
             self.assertEqual(data[0][1], "5")
-            self.assertEqual(data[1][0], "invalid_trajectory")
-            self.assertEqual(data[1][1], "0")
-            self.assertEqual(data[2][0], "filter1")
-            self.assertEqual(data[2][1], "2")
-            self.assertEqual(data[3][0], "filter2")
-            self.assertEqual(data[3][1], "3")
+            self.assertEqual(data[1][0], "filter1")
+            self.assertEqual(data[1][1], "2")
+            self.assertEqual(data[2][0], "filter2")
+            self.assertEqual(data[2][1], "3")
 
     def test_mask_based_on_invalid_obs(self):
         num_times = 5

tests/test_trajectory_list.py

@@ -127,24 +127,6 @@ def test_filter_on_obs_count(self):
             self.assertTrue(idx in expected)
             expected.remove(idx)
 
-    def test_filter_on_valid(self):
-        vals = [True, False, False, True, True, False, True, True, False]
-        trjs = TrajectoryList(len(vals))
-        for i in range(len(vals)):
-            trj = Trajectory(x=i)
-            trj.valid = vals[i]
-            trjs.set_trajectory(i, trj)
-
-        trjs.filter_by_valid()
-        expected = set([0, 3, 4, 6, 7])
-
-        # Test that each remaining result appears once in the expected set.
-        self.assertEqual(len(trjs), len(expected))
-        for i in range(len(trjs)):
-            idx = trjs.get_trajectory(i).x
-            self.assertTrue(idx in expected)
-            expected.remove(idx)
-
     @unittest.skipIf(not HAS_GPU, "Skipping test (no GPU detected)")
     def test_move_to_from_gpu(self):
         for i in range(self.max_size):