DM-37555: Update pipeline documentation for image differencing #294
Conversation
|
Please fix the PR title. See here: |
BrunoSanchez
changed the title
BrunoSanchez
force-pushed
the
tickets/DM-37555
branch
from
c1ab664 to
1a686d3
Compare
There was a problem hiding this comment.
One suggestion: please use the "one sentence per line" format described here in the overview:
https://developer.lsst.io/restructuredtext/style.html#text-wrapping
instead of breaking your lines at ~80chars. It makes future modifications easier, and makes parsing the raw ReST easier. I'll look at the overview file after it's refactored, so it's easier to comment on.
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.AlardLuptonSubtractTask.rst
Outdated
Show resolved
Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.AlardLuptonSubtractTask.rst
Outdated
Show resolved
Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.AlardLuptonSubtractTask.rst
Outdated
Show resolved
Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DetectAndMeasureTask.rst
Outdated
Show resolved
Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DetectAndMeasureTask.rst
Outdated
Show resolved
Hide resolved
BrunoSanchez
force-pushed
the
tickets/DM-37555
branch
from
1a686d3 to
eedf54b
Compare
|
OK, all changes implemented. |
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.AlardLuptonPreconvolveSubtractTask.rst
Outdated
Show resolved
Hide resolved
doc/lsst.ip.diffim/tasks/lsst.ip.diffim.DetectAndMeasureScoreTask.rst
Outdated
Show resolved
Hide resolved
| and measurement of candidate `~lsst.ip.diffim.KernelCandidates` is defined, and | ||
| used to initize subTasks selectDetection (for candidate detection) and | ||
| selectMeasurement(for candidate measurement). | ||
| Build a Psf-matching kernel using two input images, either as MaskedImages (in which case they need to be astrometrically aligned) or Exposures (in which case astrometric alignment will happen by default but may be turned off). |
There was a problem hiding this comment.
I don't believe this Task can handle Exposures that are not astrometrically aligned any more. It was certainly my intention to remove that functionality, so if it is still there we should disable it.
There was a problem hiding this comment.
I took a look and it seems this functionality is not there anymore. I couldn't find it at least. Changed the docs to reflect this.
BrunoSanchez
force-pushed
the
tickets/DM-37555
branch
from
ce6ce43 to
a3c4e4a
Compare
Remove documentation pages with outdated information. Include new tasks doc pages and fix docstrings. Add a new overview page for ip.diffim Adding the examples in the landing page Fix bug on docstring Fix review comments Update doc/lsst.ip.diffim/index.rst Co-authored-by: Ian Sullivan <[email protected]> Update doc/lsst.ip.diffim/overview_ipdiffim.rst Co-authored-by: Ian Sullivan <[email protected]> Fix review comments Fix review comments
BrunoSanchez
force-pushed
the
tickets/DM-37555
branch
from
a3c4e4a to
2d2d4af
Compare
Big documentation update, removed old docs and added basic help info.