[Swift-commit] r4717 - SwiftApps/SwiftMontage/docs

[jonmon at ci.uchicago.edu]

Author: jonmon
Date: 2011-06-30 11:49:23 -0500 (Thu, 30 Jun 2011)
New Revision: 4717

Modified:
   SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt
Log:
o changes to the documentaton. Added examples for rectification and not rectifying the final mosaic.


Modified: SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt
===================================================================
--- SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt	2011-06-30 02:52:02 UTC (rev 4716)
+++ SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt	2011-06-30 16:49:23 UTC (rev 4717)
@@ -26,7 +26,7 @@
 Types
 ~~~~~
 These are all the Types that are declared for Swift. They are located in the
-file Swift_Montage_types.swift.
+file SwiftMontage_Types.swift.
 
 Image
 ^^^^^
@@ -103,7 +103,7 @@
 App Procedures
 ~~~~~~~~~~~~~~
 These are all the app procedures for SwiftMontage. They are located in the
-file Swift_Montage_Apps.swift
+file SwiftMontage_Apps.swift
 
 NOTE: Currently the options to the Montage functions are hard coded and the
 user cannot choose which options to run.
@@ -282,7 +282,7 @@
 ~~~~~~~~~~~~~~
 These are the Batch scripts. These scripts do most of the file mapping
 and is where the parallelization is taking place. They are located in the file
-Swift_Montage_Batch.swift
+SwiftMontage_Batch.swift
 
 mBackgroundBatch
 ^^^^^^^^^^^^^^^^
@@ -364,3 +364,73 @@
 
 WARNING: mProjectBatch currently only calls the general mProject app
 procedure. It does not check to see if the faster projection mProjectPP can be used.
+
+Examples
+~~~~~~~~
+Below are two examples.  The first will create an unrectified gray-scale image
+and the second will create a rectified gray-scale image.
+
+Unrectified gray-scale image
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----
+import "SwiftMontage_Types";
+import "SwiftMontage_Apps";
+import "SwiftMontage_Batch";
+
+Header header <"header.hdr">;
+Table images_tbl <"images.tbl">;
+Image rectified_mos <"final/unrectified.fits">;
+JPEG rectified_jpg_img <"final/unrectified.jpg">;
+Image projected_images[];
+
+Image raw_image_files[] <filesys_mapper; location = "raw_dir", suffix = ".fits">;
+
+projected_images = mProjectBatch( "proj_dir", raw_image_files, header );
+
+images_tbl = mImgtbl( projected_images );
+
+unrectified_mos = mAdd( projected_images, images_tbl, header );
+
+unrectified_jpg_img = mJPEG( unrectified_mos );
+----
+
+Rectified gray-scale image
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----
+import "SwiftMontage_Types";
+import "SwiftMontage_Apps";
+import "SwiftMontage_Batch";
+
+Header header <"header.hdr">;
+Table images_tbl <"images.tbl">;
+Table difference_tbl <"diffs.tbl">;
+Table fits_images_tbl <"fits.tbl">;
+Table rectification_tbl <"rectification.tbl">;
+Table stat_tbl <"stats.tbl">;
+Image rectified_mos <"final/rectified.fits">;
+JPEG rectified_jpg_img <"final/rectified.jpg">;
+Image projected_images[];
+Image difference_images[];
+Image rectified_images[];
+
+Image raw_image_files[] <filesys_mapper; location = "raw_dir", suffix = ".fits">;
+
+projected_images = mProjectBatch( "proj_dir", raw_image_files, header );
+
+images_tbl = mImgtbl( projected_images );
+
+difference_tbl = mOverlaps( images_tbl );
+
+( difference_images, fits_images_tbl ) = mDiffFitBatch( "proj_dir","diff_dir", "stat_dir",
+                                                        @filenames(projected_images),
+                                                        difference_tbl, header );
+
+rectification_tbl = mBgModel( images_tbl, fits_images_tbl );
+
+rectified_images = mBackgroundBatch( "rect_dir",
+                                     projected_images, images_tbl, rectification_tbl );
+
+rectified_mos = mAdd( rectified_images, images_tbl, header );
+
+rectified_jpg_img = mJPEG( rectified_mos );
+----