Changeset 9744 for trunk/doc/modules/CameraImages.tex

Timestamp:

Oct 24, 2006, 3:48:17 PM (20 years ago)

Author:

Paul Price

Message:

Major changes to bring spec up to date with code, mainly for stuff written by PAP.

File:

• trunk/doc/modules/CameraImages.tex (modified) (2 diffs)

trunk/doc/modules/CameraImages.tex

@@ -951 +951 @@
 \subsection{FPA Files}
 
-\tbd{EAM to provide from the following files:
-pmFPAfileDefine.h
-pmFPAfileFitsIO.h
-pmFPAfile.h
-pmFPAfileIO.h
-pmFPA_MANAPLOT.h
-pmFPA_JPEG.h
-}
+\tbd{Below is the old text (it just stops suddenly).  EAM to provide
+from the following files: pmFPAfileDefine.h pmFPAfileFitsIO.h
+pmFPAfile.h pmFPAfileIO.h pmFPA\_MANAPLOT.h pmFPA\_JPEG.h }
+
+The FPA structure defines the layout of the data read from a camera.
+It contains elements to specify the location of the pixels within the
+focal plane structure.  It also provides the relationship between a
+specific hardware layout of the pixels (readouts, cells, chips, etc)
+and a specific organization model for the data (headers and pixel
+array sections, etc).  Depending on the needs of the users or the
+desires of the instrument builders, the data read out from a single
+camera may be stored in a number of different ways.  For example,
+multiple cells within the same chip may be stored within the same
+pixel array in different locations, within separate arrays in the same
+FITS file in different extensions, or as separate files.  Multple
+chips may be written to the same file or different files.  Multiple
+readouts may be separate files or slices of an image cube.  
+
+The pmFPA structure does not (and should not) define the relationship
+between the pixel data and the actual files files on disk.  
+
+The pmFPAfile structure defines a relationship between the data stored
+in a pmFPA structure and an external (file) representation of that
+data.  The purpose of this structure and its supporting functions is
+to allow the application designer to easily add or changes the data
+sources and the data destinations used by an application.  The
+pmFPAfile defines the input and output data formats.  A single
+pmFPAfile may represent FITS image data files, jpeg image files,
+photometric measurements, astrometric calibrations, etc.  Each
+instance of a pmFPAfile is identified with a particular data format.
+It is defined as a data source (file from which to read data) or a
+data destination (file to be written).  The pmFPAfile also defines the
+naming conventions to be used for the particular type of file or set
+of files.  A single pmFPAfile may be used to represent data coming
+from or going to a single file on disk or a collection of files on
+disk.  The pmFPAfile also defines anciliary data which is needed for
+some file formats and not for others.  For example, FITS file
+extensions need to be given particular EXTNAME values.  Or, jpeg
+images require a colormap and clipping rules. 
+
+The pmFPAfile system also lets the application designer have
+flexibility with which types of files are required within a particular
+program.  Consider an application which performs some manipulation of
+an image.  The program may call several analysis modules as it
+operates on the data.  For example, it may perform a bias subtraction
+on the image pixels data.  Or, it may detect objects within another
+module.  The pmFPAfile system allows the author of a module to refer tperform The program may have a few 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -1351 +1390 @@
 psArray pmAstromFitDistortion (pmFPA *fpa, psArray *gradients, psMetadata *config);
 \end{prototype}
-
-\section{FPA Files}
-
-The FPA structure defines the layout of the data read from a camera.
-It contains elements to specify the location of the pixels within the
-focal plane structure.  It also provides the relationship between a
-specific hardware layout of the pixels (readouts, cells, chips, etc)
-and a specific organization model for the data (headers and pixel
-array sections, etc).  Depending on the needs of the users or the
-desires of the instrument builders, the data read out from a single
-camera may be stored in a number of different ways.  For example,
-multiple cells within the same chip may be stored within the same
-pixel array in different locations, within separate arrays in the same
-FITS file in different extensions, or as separate files.  Multple
-chips may be written to the same file or different files.  Multiple
-readouts may be separate files or slices of an image cube.  
-
-The pmFPA structure does not (and should not) define the relationship
-between the pixel data and the actual files files on disk.  
-
-The pmFPAfile structure defines a relationship between the data stored
-in a pmFPA structure and an external (file) representation of that
-data.  The purpose of this structure and its supporting functions is
-to allow the application designer to easily add or changes the data
-sources and the data destinations used by an application.  The
-pmFPAfile defines the input and output data formats.  A single
-pmFPAfile may represent FITS image data files, jpeg image files,
-photometric measurements, astrometric calibrations, etc.  Each
-instance of a pmFPAfile is identified with a particular data format.
-It is defined as a data source (file from which to read data) or a
-data destination (file to be written).  The pmFPAfile also defines the
-naming conventions to be used for the particular type of file or set
-of files.  A single pmFPAfile may be used to represent data coming
-from or going to a single file on disk or a collection of files on
-disk.  The pmFPAfile also defines anciliary data which is needed for
-some file formats and not for others.  For example, FITS file
-extensions need to be given particular EXTNAME values.  Or, jpeg
-images require a colormap and clipping rules. 
-
-The pmFPAfile system also lets the application designer have
-flexibility with which types of files are required within a particular
-program.  Consider an application which performs some manipulation of
-an image.  The program may call several analysis modules as it
-operates on the data.  For example, it may perform a bias subtraction
-on the image pixels data.  Or, it may detect objects within another
-module.  The pmFPAfile system allows the author of a module to refer tperform The program may have a few