Skip to content

Commit

Permalink
Update dev guide with pairing tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
jmeyers314 committed Apr 23, 2024
1 parent fb64507 commit ba7e5cd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/developer-guide/developer-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@ This module has the tasks to run WEP as a pipeline with Gen 3 LSST DM middleware
* **GenerateDonutFromRefitWcsTaskConnections**: Connections setup for GenerateDonutFromRefitWcsTask.
* **GenerateDonutFromRefitWcsTaskConfig**: Configuration setup for GenerateDonutFromRefitWcsTask.
* **GenerateDonutCatalogUtils**: Common utility functions for the GenerateDonutCatalog...Tasks.
* **ExposurePairer**: Subtask to pair intra- and extra-focal exposures heuristically.
* **TablePairer**: Subtask to pair intra- and extra-focal exposures manually from a table. Use generatePairTable.py script as a useful starting point.

.. _WEP_modules_wep_utils:

Expand All @@ -160,7 +162,7 @@ This module contains utility functions that are used elsewhere in WEP.
* **ioUtils**: Functions for reading and writing files.
* **maskUtils**: Functions for generating a mask model for an instrument.
* **taskUtils**: Functions for running command line tasks from a python script.
* **zernikeUtils**: Functions for evaluating and fitting Zernike polynomials.
* **zernikeUtils**: Functions for evaluating and fitting Zernike polynomials.
* **plotUtils**: Functions for plotting results.
* **miscUtils**: Miscellaneous utility functions.

Expand Down
3 changes: 3 additions & 0 deletions doc/uml/taskClass.uml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ CutOutDonutsScienceSensorTaskConfig *-- CutOutDonutsBaseTaskConnections
CutOutDonutsScienceSensorTask *-- CutOutDonutsScienceSensorTaskConfig
CutOutDonutsBaseTaskConnections <|-- CutOutDonutsScienceSensorTaskConnections
CutOutDonutsScienceSensorTaskConfig *-- CutOutDonutsScienceSensorTaskConnections
CutOutDonutsScienceSensorTaskConfig *-- ExposurePairer
CutOutDonutsScienceSensorTask ..> DonutStamps
CutOutDonutsBaseTaskConfig *-- CutOutDonutsBaseTaskConnections
CutOutDonutsBaseTask *-- CutOutDonutsBaseTaskConfig
Expand All @@ -42,4 +43,6 @@ GenerateDonutFromRefitWcsTaskConfig *-- GenerateDonutFromRefitWcsTaskConnections
GenerateDonutCatalogWcsTaskConfig <|-- GenerateDonutFromRefitWcsTaskConfig
GenerateDonutFromRefitWcsTask *-- GenerateDonutFromRefitWcsTaskConfig
GenerateDonutCatalogWcsTask <|-- GenerateDonutFromRefitWcsTask
ExposurePairer *-- ExposurePairerConfig
TablePairer *-- TablePairerConfig
@enduml

0 comments on commit ba7e5cd

Please sign in to comment.