Skip to content

Commit

Permalink
Update formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
bsmartradio authored and parejkoj committed Mar 2, 2023
1 parent 9982873 commit 9883baa
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Pipe-task that removes the neighboring-pixel covariance in an
image difference that are added when the template image is
convolved with the Alard-Lupton PSF matching kernel.

##########################
.. _lsst.ip.diffim.DecorrelateALKernelSpatialTask-description:

Description
##########################
==================

This task is a simple wrapper around @ref DecorrelateALKernelTask,
which takes a `spatiallyVarying` parameter in its `run` method. If
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Pipe-task that removes the neighboring-pixel covariance in an
image difference that are added when the template image is
convolved with the Alard-Lupton PSF matching kernel.

##########################
.. _lsst.ip.diffim.DecorrelateALKernelTask-description:

Description
##########################
==================

The image differencing pipeline task @link
ip.diffim.psfMatch.PsfMatchTask PSFMatchTask@endlink and @link
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,18 @@ DiaCatalogSourceSelectorTask

A task that selects sources for Kernel candidates.

###########
.. _lsst.ip.diffim.DiaCatalogSourceSelectorTask-description:

Description
###########
==================

A naive star selector based on second moments. Use with caution.

#################
.. _lsst.ip.diffim.DiaCatalogSourceSelectorTask-debug:


Debug Variables
#################
==================

DiaCatalogSourceSelectorTask has a debug dictionary with the following keys:

Expand All @@ -25,9 +28,10 @@ displayExposure : `bool`
pauseAtEnd `bool`
if True wait after displaying everything and wait for user input

#########
.. _lsst.ip.diffim.DiaCatalogSourceSelectorTask-examples:

Examples
#########
==================

For example, put something like:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ DipoleMeasurementTask
The list of badFlags will be used to make a list of keys to check for measurement flags on. By
default the centroid keys are added to this list

##########################
.. _lsst.ip.diffim.DipoleMeasurementTask-description:

Description
##########################
==================

This class provides a default configuration for running Source measurement on image differences.

Expand Down Expand Up @@ -77,9 +78,8 @@ manually editing the config and running SingleFrameMeasurementTask. For example:
schema = afwTable.SourceTable.makeMinimalSchema()
task = SingleFrameMeasurementTask(schema, config=config)-
##########################
Debug variables
##########################
The ``pipetask`` command line interface supports a
flag ``--debug`` to import ref: supports a flag `--debug`` to import debug.py from your PYTHONPATH; see :ref:`lsstDebug`
Expand Down
22 changes: 14 additions & 8 deletions doc/lsst.ip.diffim/tasks/lsst.ip.diffim.ImagePsfMatchTask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ A schema for the selection and measurement of candidate lsst.ip.diffim.KernelCan
defined, and used to initize subTasks selectDetection (for candidate detection) and selectMeasurement
(for candidate measurement).

##########################
.. _lsst.ip.diffim.ImagePsfMatchTask-description:

Description
##########################
==================

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
Expand Down Expand Up @@ -52,9 +53,10 @@ Finally, a spatial model is built using all currently-acceptable candidates,
and the spatial model used to derive a second set of (spatial) residuals
which are again used to reject bad candidates, using the same thresholds as above.

##########################
.. _lsst.ip.diffim.ImagePsfMatchTask-invoke:

Invoking the Task
##########################
==================

There is no run() method for this Task. Instead there are 4 methods that
may be used to invoke the Psf-matching. These are
Expand All @@ -72,9 +74,10 @@ return a Psf-matched and template subtracted image.

See each method's returned lsst.pipe.base.Struct for more details.

##########################
Debug variables
##########################
.. _lsst.ip.diffim.ImagePsfMatchTask--debug:

Debug Variables
==================

The ``pipetask`` command line interface supports a
flag ``--debug`` to import ref: supports a flag `--debug`` to import debug.py from your PYTHONPATH; see :ref:`lsstDebug`
Expand Down Expand Up @@ -120,8 +123,11 @@ Note that if you want addional logging info, you may add to your scripts:
import lsst.utils.logging as logUtils
logUtils.trace_set_at("lsst.ip.diffim", 4)
.. _lsst.ip.diffim.ImagePsfMatchTask-examples:

Examples
--------
==================

A complete example of using ImagePsfMatchTask

Create a subclass of ImagePsfMatchTask that allows us to either match exposures, or subtract exposures:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It is important to note that in the code, the "template" Psf is the Psf
that the science image gets matched to. In this sense the order of template and science image are
reversed, compared to ImagePsfMatchTask, which operates on the template image.

.. _lsst.ip.diffim.ModelsPsfMatchTask-debug
.. _lsst.ip.diffim.ModelPsfMatchTask-debug:

Debug variables
===============
Expand Down Expand Up @@ -67,6 +67,8 @@ Note that if you want additional logging info, you may add to your scripts:
import lsst.utils.logging as logUtils
logUtils.trace_set_at("lsst.ip.diffim", 4)
.. _lsst.ip.diffim.ModelPsfMatchTask-examples:

Examples
=========
A complete example of using ModelPsfMatchTask
Expand Down

0 comments on commit 9883baa

Please sign in to comment.