Skip to content

Commit

Permalink
Doc. changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Pica4x6 committed Sep 24, 2015
1 parent fb74569 commit 5a9f9ad
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 47 deletions.
4 changes: 2 additions & 2 deletions doc/creation/environ.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

Numina Pipeline Environment
##############################
###########################

This guide is intended as an introductory overview of pipeline creation
with Numina. For detailed reference documentation of the functions and
Expand Down Expand Up @@ -33,7 +33,7 @@ Users of the DFP shall interact with the software
through the GTC Inspector.

Recipe Requirements and Products
---------------------------------
--------------------------------
Recipes based on Numina have a list of requirements needed to
properly configure the Recipe.
Recipes also provide a list of products created by the recipe.
Expand Down
13 changes: 6 additions & 7 deletions doc/creation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@
Numina Pipeline Creation Guide
##############################

This guide is intended as an introductory overview of pipeline creation
with Numina. For detailed reference documentation of the functions and
classes contained in the package, see the :ref:`reference`.
This guide is intended as an introductory overview of pipeline creation with
Numina. For detailed reference documentation of the functions and classes
contained in the package, see the :ref:`reference`.

.. warning::

This "Pipeline Creation Guide" is still a work in progress; some of
the material
is not organized, and several aspects of Numina are not yet covered
sufficient detail.
This "Pipeline Creation Guide" is still a work in progress; some of the
material is not organized, and several aspects of Numina are not covered
in sufficient detail yet.

.. toctree::

Expand Down
74 changes: 36 additions & 38 deletions doc/creation/pipelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,85 +4,83 @@ Numina Pipeline Concepts
========================

Instrument
-----------
----------


Observing Modes
---------------
Each instrument has a list of predefined types of observations tha can
be carried out with it. Some types of observations provide calibrations
needed by other types of observations.
Each instrument has a list of predefined types of observations that can be
carried out with it. Some types of observations provide calibrations needed by
other types of observations.

Pipelines
---------
A pipeline represents a particular mapping between the observing modes
and the reduction algorithms that process each mode. Each instrument has
at least one pipeline.
A pipeline represents a particular mapping between the observing modes and the
reduction algorithms that process each mode. Each instrument has at least one
pipeline.

Recipes
-------
A recipe is a method to process the images obtained in a particular observing
mode. Recipes in general require (as inputs) the list of raw images obtained
during the observation. Recipes can require other inputs (calibrations), and
this inputs can the the outputs of other recipes.
those inputs can be the outputs of other recipes.

Products, Requirements and Data Types
--------------------------------------
A recipes announces its required inputs as Requirements and
its outputs as Products.
-------------------------------------
A recipe announces its required inputs as Requirements and its outputs as
Products.

Products and Requirements both have a name and a type. Types can be
plain Python types or defined by the developer.
Both products and requirements have a name and a type. Types can be plain
Python types or defined by the developer.

Numina Pipeline Example
========================
=======================

This is a Numina Pipeline for an instrument called CLODIA.

Observing Modes
----------------

CLODIA is a simple CCD camera, so it has only three modes, called
BIAS, FLAT and SCIENCE.
---------------

BIAS is used to obtain pedestal images, FLAT is used to obtain flat-field
images and SCIENCE is used to obtain images of scientific targets.
CLODIA is a simple CCD camera, so it has only three modes called BIAS, FLAT
and SCIENCE. BIAS is used to obtain pedestal images, FLAT is used to obtain
flat-field images and SCIENCE is used to obtain images of scientific targets.

Pipelines
----------
In this simple example, there is only one pipeline, called 'default'. It
is a mapping between BIAS and its recipe (BiasRecipe),
FLAT and FlatRecipe and SCIENCE and ScienceRecipe.
---------
In this simple example, there is only one pipeline, called 'default'. It is a
mapping between BIAS and its recipe (BiasRecipe), FLAT and FlatRecipe and
SCIENCE and ScienceRecipe.

Recipes
--------
-------
We have three recipes: BiasRecipe, FlatRecipe, ScienceRecipe. Next we define
its inputs and outputs.
theirs inputs and outputs.

BiasRecipe
...........
..........

This recipe requires the images obtained in BIAS mode. In a very simple
instrument without overscan, the recipe will just combine the raw images
to create a master bias image, so no other inputs are required.
instrument without overscan, the recipe will just combine the raw images to
create a master bias image, so no other inputs are required.

This recipe produces an image. There is a predefined data type for images,
but we can add more information to the recipe by defining a type MasterBias.
This recipe produces an image. There is a predefined data type for images, but
we can add more information to the recipe by defining a type MasterBias.

FlatRecipe
----------
This recipe requires the images obtained in FLAT mode. It also requires
a image produced by BiasRecipe (to correct the pedestal in FLAT images),
so we add a requirement in MasterBias.
..........
This recipe requires the images obtained in FLAT mode. It also requires an
image produced by BiasRecipe (to correct the pedestal in FLAT images), so we
add a requirement in MasterBias.

This recipes produces an image, but in this case is a MasterFlat. We define
again a new type called MasterFlat.


ScienceRecipe
--------------
This recipe requires the images obtained in SCIENCE mode and two calibrations,
a MasterBias image and a MasterFlat image.
.............
This recipe requires the images obtained in SCIENCE mode and two calibrations:
a MasterBias and a MasterFlat images.

This recipe produces an image, we can define a type for it, such as
ScienceImage.

0 comments on commit 5a9f9ad

Please sign in to comment.