.. py:currentmodule:: lsst.cp.pipe

.. _lsst.cp.pipe:

############
lsst.cp.pipe
############

.. This module is used to produce the calibration products required to perform `instrument signal removal </modules/lsst.ip.isr/index>`_ for a camera. It currently can produce master bias, dark, fringe, and flat frames; bad pixel and column masks; the photon transfer curve and the child products of that, linearity models and brighter-fatter kernels; and the intra-detector crosstalk coefficients.

.. _lsst.cp.pipe-using:

Using lsst.cp.pipe
==================

.. toctree::
   :maxdepth: 1

   constructing-calibrations

.. _lsst.cp.pipe-contributing:

Contributing
============

``lsst.cp.pipe`` is developed at https://github.com/lsst/cp_pipe.
You can find Jira issues for this module under the `cp_pipe <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20cp_pipe>`_ component.

.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.

.. .. toctree::
..    :maxdepth: 1

Task reference
==============

.. _lsst.cp.pipe-pipeline-tasks:

Pipeline tasks
--------------

.. lsst-pipelinetasks::
   :root: lsst.cp.pipe

.. _lsst.cp.pipe-command-line-tasks:

Command-line tasks
------------------

.. lsst-cmdlinetasks::
   :root: lsst.cp.pipe

Tasks
-----

.. lsst-tasks::
   :root: lsst.cp.pipe
   :toctree: tasks

.. _lsst.cp.pipe-scripts:

Script reference
================

.. toctree::
   :maxdepth: 1

   scripts/plotPhotonTransferCurve.py

.. _lsst.cp.pipe-pyapi:

Python API reference
====================

.. automodapi:: lsst.cp.pipe
   :no-main-docstr:
   :no-inheritance-diagram:

.. automodapi:: lsst.cp.pipe.cpFlatNormTask
   :no-main-docstr:
   :no-inheritance-diagram:

.. automodapi:: lsst.cp.pipe.cpDarkTask
   :no-main-docstr:
   :no-inheritance-diagram:

.. automodapi:: lsst.cp.pipe.cpFringeTask
   :no-main-docstr:
   :no-inheritance-diagram:

.. automodapi:: lsst.cp.pipe.utils
   :no-main-docstr:
   :no-inheritance-diagram: