Add pydoc comments

dirac-institute · Oct 24, 2023 · 4fb96be · 4fb96be
1 parent 614bad5
commit 4fb96be
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 4 deletions.
diff --git a/src/kbmod/search/pydocs/stamp_creator_docs.h b/src/kbmod/search/pydocs/stamp_creator_docs.h
@@ -30,7 +30,7 @@ namespace pydocs {
   
   Returns
   -------
-  `std::vector<RawImage>`
+  `list` of `RawImage`
       The stamps.
   )doc";
 
@@ -121,11 +121,50 @@ namespace pydocs {
   )doc";
 
   static const auto DOC_StampCreator_get_coadded_stamps = R"doc(
-  todo
+  Create a vector of co-added stamps centered on the predicted position
+  of trajectories at different times.
+
+  Parameters
+  ----------
+  stack : `ImageStack`
+      The stack of images to use.
+  trj : `list` of `Trajectory`
+      The list of trajectories to uses.
+  use_index : `list` of `list` of `bool`
+      A list of lists (vectors) of Booleans indicating whether or not to use each
+      time step. use_index[i][j] indicates whether we should use timestep j of
+      trajectory i. An empty (size=0) list for any trajectory will use all time
+      steps for that trajectory.
+  params : `StampParameters`
+      The parameters for stamp generation, such as radius and co-add type.
+  use_gpu : `bool`
+      A Boolean indicating whether to do the co-adds on the CPU (False) or
+      GPU (True).
+
+  Returns
+  -------
+  `list` of `RawImage`
+      The co-added stamps.
+
   )doc";
 
   static const auto DOC_StampCreator_filter_stamp = R"doc(
-  todo
+  Filters stamps based on the given parameters.
+      
+  Applies the following filters: peak position, percent flux at central pixel,
+  and image moments.
+
+  Parameters
+  ----------
+  img : `RawImage`
+      The image to test.
+  params : `StampParameters`
+      The parameters for stamp generation and filtering.
+
+  Returns
+  -------
+  `bool`
+      Whether or not to filter the stamp.
   )doc";
 
 } /* pydocs */

diff --git a/src/kbmod/search/stamp_creator.h b/src/kbmod/search/stamp_creator.h
@@ -41,7 +41,7 @@ class StampCreator {
     static std::vector<RawImage> get_coadded_stamps(ImageStack& stack,
                                                     std::vector<Trajectory>& t_array,
                                                     std::vector<std::vector<bool> >& use_index_vect,
-                                                    const StampParameters& params, bool use_cpu);
+                                                    const StampParameters& params, bool use_gpu);
 
     static std::vector<RawImage> get_coadded_stamps_gpu(ImageStack& stack,
                                                         std::vector<Trajectory>& t_array,