[Swift-commit] r4867 - SwiftApps/SwiftMontage/docs
jonmon at ci.uchicago.edu
jonmon at ci.uchicago.edu
Fri Jul 29 10:33:39 CDT 2011
Author: jonmon
Date: 2011-07-29 10:33:39 -0500 (Fri, 29 Jul 2011)
New Revision: 4867
Added:
SwiftApps/SwiftMontage/docs/SwiftMontageAPI.adoc
Removed:
SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt
Modified:
SwiftApps/SwiftMontage/docs/updateAPI.sh
Log:
o added content and minor changes to the SwiftMontage documentation
Added: SwiftApps/SwiftMontage/docs/SwiftMontageAPI.adoc
===================================================================
--- SwiftApps/SwiftMontage/docs/SwiftMontageAPI.adoc (rev 0)
+++ SwiftApps/SwiftMontage/docs/SwiftMontageAPI.adoc 2011-07-29 15:33:39 UTC (rev 4867)
@@ -0,0 +1,460 @@
+SwiftMontage API
+=================
+:toc:
+:icons:
+:numbered:
+:pygments:
+
+== Overview
+This is the API for the SwiftMontage wrappers. Montage is a toolkit for
+generating science grade astronomical mosaics. The image file format for
+Montage is Flexible Image Transport System or FITS.
+
+Swift is a dataflow parallel scripting language. The language allows the user
+to parallelize a workflow that has been represented as a swiftscript. Swift
+implements the site execution model to allow for efficient use of available
+resources for the user's application.
+
+Images are one of the key sources of data for astronomers. Montage is a
+toolkit that takes a set of images and generates science grade astronomical
+mosaics for analysis. The number of these images can be in the thousands or
+greater depending on how big of a portion of the sky has been
+scanned. Applications with such large datasets are normally executed on the
+grid (the TeraGrid or the Open Science Grid) to allow for multiple parallel
+resources to be used to decrease the overall runtime of the application. Swift
+allows for this type of remote execution as well as detecting data
+dependencies allowing certain tasks to be executed in parallel. Using Swift
+allows for efficient use of all parallel resources that are available to the
+user, which in turn decreases the runtime of large-scale problems.
+
+[NOTE]
+========================================================================
+Both the Montage binaries as well as the Swift binaries must be included
+in your PATH environment variable for the wrappers to function properly.
+========================================================================
+
+== SwiftMontage API
+
+=== Types
+These are all the Types that are declared for Swift. They are located in the
+file SwiftMontage_Types.swift.
+
+==== Image
+------
+type Image;
+------
+This is the Image type. It is used to declare the raw images, projected
+images, difference images, rectified images, and the mosaic.
+
+==== Header
+------
+type Header;
+------
+This is the Header type. It is used to declare and map to the FITS header
+file.
+
+==== Table
+------
+type Table;
+------
+This is the Table type. During the execution of the workflow several files of
+metadata is generated. These are tables that the Montage functions use to read
+for the next stage of the workflow.
+
+==== JPEG
+------
+type JPEG
+------
+This is the JPEG type. This is used to map to the jpeg version of the mosaic.
+
+==== Status
+------
+type Status;
+------
+This is the status type. During the difference stage of the workflow status
+file are generated that have the information about the coefficients that will
+be used to rectify the image.
+
+==== BackgroundStruct
+------
+type BackgroundStruct
+{
+ string fname;
+ float a;
+ float b;
+ float c;
+};
+------
+This is a struct type. The entries are a string for the name of the image and
+three coefficients to rectify this portion of the mosaic of all floating point
+types.
+
+==== DiffStruct
+------
+type DiffStruct
+{
+ int cntr1;
+ int cntr2;
+ Image plus;
+ Image minus;
+ Image diff;
+};
+------
+This is a struct type. The entries are two control integers that make this
+entry unique, the two images that overlapped which are name plus and minus,
+and the name of the difference image that they produced.
+
+=== App Procedures
+These are all the app procedures for SwiftMontage. They are located in the
+file SwiftMontage_Apps.swift
+[NOTE]
+===========================================================================
+Currently the options to the Montage functions are hard coded and the
+user cannot choose which options to run.
+===========================================================================
+
+==== mAdd
+------
+app ( Image mos ) mAdd( Image imgs[], Table img_tbl, Header hdr )
+------
+
+This app procedure will call the mAdd fucntion from the Montage toolkit. This
+procedure takes
+in a list of images to be added together, the img_tbl for these images, and
+the FITS header file for the mosaic being created. The procedure then outputs
+a single FITS file that represents the mosaic. All the images that will be
+part of this mosaic must reside in the same directory.
+
+==== mBackground
+------
+app ( Image bg_img ) mBackground( Image img, float a, float b, float c )
+------
+
+This app procedure will call the mBackground_wrap function written in
+python. This procedure takes in a single image along with the three
+coefficients. The procedure then output the background rectified image after
+the coefficients have been applied.
+
+==== mBgModel
+------
+app ( Table rect_tbl ) mBgModel( Table img_tbl, Table fits_tbl )
+------
+
+This app procedure will call the mBgModel function from the Montage
+toolkit. This procedure takes in an image table that represents the list of images that
+will be added into a mosaic and a table of the information that is required to
+fit them together. The procedure will then output a rectification table of the
+coefficients that must be applied to the images.
+
+==== mConcatFit
+------
+app ( Table fits_tbl ) mConcatFit( Table status_tbl, Status stats[] )
+------
+
+This app procedure will call the mConcatFit function from the Montage
+toolkit. This procedure takes in a table representing the status files that were generated
+from either mFitplane or mDiffFit and a list of these status files as
+input. The procedure will then output a table of all the status files
+together. The status files must all reside in the same directory.
+
+==== mDiff
+------
+app ( Image diff_img ) mDiff( Image proj_img_1, Image proj_img_2, Header hdr )
+------
+
+This app procedure will call the mDiff function from the Montage toolkit. This
+procedure takes in two images and the FITS header file for the mosaic. The procedure will then output a
+difference image representing the information of where the two images overlap.
+
+==== mDiffFit
+------
+app ( Image diff_img, Status stat ) mDiffFit( Image img_1, Image img_2, Header hdr )
+------
+
+This app procedure will call the mDiffFit_wrap that has been written in
+python. The mDiffFit function in Montage is the combination of the mDiff and
+mFitplane functions.
+
+==== mFitplane
+------
+app ( Status stat ) mFitplane( Image diff_img )
+------
+
+This app procedure will call the mFitplane function from the Montage
+toolkit. This procedure takes in as input the difference image that was the output from
+the mDiff procedure. The procedure will then output a status file that
+contains the information on how to fit these two images together.
+
+==== mImgtbl
+------
+app ( Table img_tbl ) mImgtbl( Image imgs[] )
+------
+
+This app procedure will call the mImgtbl function from the Montage
+toolkit. This procedure takes in as input a list of images to create a table
+from. The output is an image table that represents these images. All the
+images that will be part of this table must reside in the same directory.
+
+==== mMakeHdr
+------
+app ( Header hdr ) mMakeHdr( Table img_tbl )
+------
+
+This app procedure will call the mMakeHdr function from the Montage
+toolkit. This procedure will take in as input an image table representing the
+images that will be combined into a single mosaic. The procedure will then output the
+FITS header file for the mosaic.
+
+==== mJPEG
+------
+app ( JPEG mos_img_jpg ) mJPEG( Image mos_img )
+------
+
+This app procedure will call the mJPEG function from the Montage toolkit. This
+procedure will take in as input as input a FITS image. The procedure will
+then ouput the same image in jpeg format.
+
+==== mOverlaps
+------
+app ( Table diff_tbl ) mOverlaps( Table img_tbl )
+------
+
+This app procedure will call the mOverlaps function from the Montage
+toolkit. This procedure takes in as input an image table of the images that
+will be combined into a single mosaic. The procedure will then output a table
+of all the images that overlap with each other in the mosaic.
+
+==== mProject
+------
+app ( Image proj_img ) mProject( Image raw_img, Header hdr )
+------
+
+This app procedure will call the mProject_wrap function writtin in
+python. This procedure takes in as input a FITS image file and the FITS header
+file that for the mosaic. The output is the projected image.
+
+[NOTE]
+=============================================================================
+The mProject app procedure is for general projection. There are some cases in
+which the faster mProjectPP procedure should be used.
+=============================================================================
+
+==== mProjectPP
+------
+app ( Image proj_img ) mProjectPP( Image raw_img, Header hdr )
+------
+
+This app procedure will call the mProjectPP_wrap function written in
+python. This procedure takes in as input a FITS image file and the FITS header
+file that for the mosaic. The output is the projected image.
+
+[NOTE]
+=============================================================================
+The mProjectPP app procedure is a "special case" version of mProject
+and can be used only where the input and output images have tangent-plane
+projections (e.g. TAN, SIN) or where they can be approximated with acceptable
+error.
+=============================================================================
+
+==== mShrink
+------
+app ( Image shrunk ) mShrink( Image original, int factor )
+------
+
+This app procedure will call the mShrink function in the Montage toolkit. This
+procedure takes in as input a single image and an re-sizing factor represented
+as an integer. The procedure will then output the re-sized image.
+
+==== Backgound_list
+------
+app ( Table back_tbl ) Background_list( Table imgs_tbl, Table rect_tbl )
+------
+
+This app procedure will call the Background_list python script that is included in
+the scripts directory for the SwiftMontage wrappers. This procedure takes in as input an image table of the
+images that are being combined into a single mosaic and the table of
+coefficients to rectify the mosaic. The procedure will then output a file in a
+format that can be read in by the Swift readData2 function into the
+Background_struct declared type.
+
+==== create_status_table
+------
+app ( Table stat_tbl ) create_status_table( Table diff_tbl )
+------
+
+This app procedure will call the create_status_table python script that is
+included in the scripts directory for the SwiftMontage wrappers. This
+procedure takes in as input the difference table that has been generated by
+the mOverlaps procedure. The procedure will the output a table that can be
+used as input to the mConcatFit app procedure.
+
+=== Batch Wrappers
+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
+SwiftMontage_Batch.swift
+
+==== mBackgroundBatch
+------
+( Image rect_imgs[] ) mBackgroundBatch( string dest, Image imgs[], Table img_tbl,
+ Table rect_tbl )
+------
+
+This batch swift script takes in as input a destination directory for the
+rectified images, a list of images that will be combined into a
+mosaic, an image table representing the images for the mosaic, and a table of
+the coefficients that must be applied to each image. The script will then
+output a list of the images after the coefficients have been applied. The
+application of the coefficients to each image is done in parallel.
+
+==== mDiffBatch
+------
+( Image diff_imgs[] ) mDiffBatch( string src, string dest, string filenames[],
+ Table diff_tbl, Header hdr )
+------
+
+This batch script takes in as input a source directory of where the images to calculate
+overlaps are located, a destination directory of where to store these
+difference images, a list of the file names for the images that will be
+combined into the mosaic, a difference table that contains which images overlap with
+each other, and the FITS header file for the mosaic. This script will then
+output the difference images. The calculation each difference image are
+done in parallel.
+
+[WARNING]
+======
+The images that are in the source directory must be projected images.
+======
+
+[NOTE]
+======
+mDiffBatch calls the mDiff app procedure.
+======
+
+==== mDiffFitBatch
+------
+( Image diff_imgs[], Table fits_tbl ) mDiffFitBatch( string src, string dest, string stat,
+ string filenames[],
+ Table diff_tbl, Header hdr )
+------
+
+This batch script takes in as input a source directory of where the images to
+calculate overlaps are located, a destination directory of where to store
+these difference images, a status directory of where to store the status files
+for each image, a list of the file names for the images that will be
+combined into the mosaic, a difference table that contains which images overlap
+with each other and the FITS header file for the mosaic. This script will then
+output a list of difference images and a table of information on how to fit
+the images together. The calculation of each difference image and the fitting
+table is done in parallel.
+
+[WARNING]
+======
+The images that are in the source directory must be projected images.
+======
+
+[NOTE]
+======
+mDiffFitBatch calls the mDiffFit app procedure.
+======
+
+==== mFitBatch
+------
+( Table fits_tbl ) mFitBatch( string stat, Image diff_imgs[], Table diff_tbl )
+------
+
+This batch script takes in as input a directory for which the status files
+will be put in, the list of difference images that has
+been generated and the table that contains which images overlap with each
+other. The script then generates a table containing describing how to fit the
+two overalpping images together.
+
+[NOTE]
+======
+mFitBatch calls the mFitplane app procedure.
+======
+
+==== mProjectBatch
+------
+( Image proj_imgs[] ) mProjectBatch( string dest, Image raw_imgs[], Header hdr )
+------
+
+This batch script takes in as input the destination directory for the
+projected images, a list of raw image files and the FITS header file
+and projects each image. When projecting each image the function will decide
+if it is possible to use the fast image projetion algorithm or to just use
+standard projection.
+
+[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
+[source,python]
+------
+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
+[source,python]
+------
+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 );
+------
Deleted: SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt
===================================================================
--- SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt 2011-07-28 21:47:42 UTC (rev 4866)
+++ SwiftApps/SwiftMontage/docs/SwiftMontageAPI.txt 2011-07-29 15:33:39 UTC (rev 4867)
@@ -1,436 +0,0 @@
-SwiftMontage API
-=================
-:toc:
-:icons:
-:numbered:
-
-Overview
---------
-
-This is the API for the SwiftMontage wrappers. Montage is a toolkit for
-generating science grade astronomical mosaics. The image file format for
-Montage is Flexible Image Transport System or FITS.
-
-Swift is a dataflow parallel scripting language. The language allows the user
-to parallelize a workflow that has been represented as a swiftscript. Swift
-implements the site execution model to allow for efficient use of available
-resources for the user's application.
-
-NOTE: Both the Montage binaries as well as the Swift binaries must be included
-in your PATH environment variable for the wrappers to function properly.
-
-
-SwiftMontage API
------------------
-
-Types
-~~~~~
-These are all the Types that are declared for Swift. They are located in the
-file SwiftMontage_Types.swift.
-
-Image
-^^^^^
-----
-type Image;
-----
-This is the Image type. It is used to declare the raw images, projected
-images, difference images, rectified images, and the mosaic.
-
-Header
-^^^^^^
-----
-type Header;
-----
-This is the Header type. It is used to declare and map to the FITS header
-file.
-
-Table
-^^^^^
-----
-type Table;
-----
-This is the Table type. During the execution of the workflow several files of
-metadata is generated. These are tables that the Montage functions use to read
-for the next stage of the workflow.
-
-JPEG
-^^^^
-----
-type JPEG
-----
-This is the JPEG type. This is used to map to the jpeg version of the mosaic.
-
-Status
-^^^^^^
-----
-type Status;
-----
-This is the status type. During the difference stage of the workflow status
-file are generated that have the information about the coefficients that will
-be used to rectify the image.
-
-BackgroundStruct
-^^^^^^^^^^^^^^^^
-----
-type BackgroundStruct
-{
- string fname;
- float a;
- float b;
- float c;
-};
-----
-This is a struct type. The entries are a string for the name of the image and
-three coefficients to rectify this portion of the mosaic of all floating point
-types.
-
-DiffStruct
-^^^^^^^^^^
-----
-type DiffStruct
-{
- int cntr1;
- int cntr2;
- Image plus;
- Image minus;
- Image diff;
-};
-----
-This is a struct type. The entries are two control integers that make this
-entry unique, the two images that overlapped which are name plus and minus,
-and the name of the difference image that they produced.
-
-App Procedures
-~~~~~~~~~~~~~~
-These are all the app procedures for SwiftMontage. They are located in the
-file SwiftMontage_Apps.swift
-
-NOTE: Currently the options to the Montage functions are hard coded and the
-user cannot choose which options to run.
-
-mAdd
-^^^^
-----
-app ( Image mos ) mAdd( Image imgs[], Table img_tbl, Header hdr )
-----
-This app procedure will call the mAdd fucntion from the Montage toolkit. This
-procedure takes
-in a list of images to be added together, the img_tbl for these images, and
-the FITS header file for the mosaic being created. The procedure then outputs
-a single FITS file that represents the mosaic. All the images that will be
-part of this mosaic must reside in the same directory.
-
-mBackground
-^^^^^^^^^^^
-----
-app ( Image bg_img ) mBackground( Image img, float a, float b, float c )
-----
-This app procedure will call the mBackground function from the Montage
-toolkit. This procedure takes in a single image along with the
-three coefficients. The procedure then output the background rectified image
-after the coefficients have been applied.
-
-mBgModel
-^^^^^^^^
-----
-app ( Table rect_tbl ) mBgModel( Table img_tbl, Table fits_tbl )
-----
-This app procedure will call the mBgModel function from the Montage
-toolkit. This procedure takes in an image table that represents the list of images that
-will be added into a mosaic and a table of the information that is required to
-fit them together. The procedure will then output a rectification table of the
-coefficients that must be applied to the images.
-
-mConcatFit
-^^^^^^^^^^
-----
-app ( Table fits_tbl ) mConcatFit( Table status_tbl, Status stats[] )
-----
-This app procedure will call the mConcatFit function from the Montage
-toolkit. This procedure takes in a table representing the status files that were generated
-from either mFitplane or mDiffFit and a list of these status files as
-input. The procedure will then output a table of all the status files
-together. The status files must all reside in the same directory.
-
-mDiff
-^^^^^
-----
-app ( Image diff_img ) mDiff( Image proj_img_1, Image proj_img_2, Header hdr )
-----
-This app procedure will call the mDiff function from the Montage toolkit. This
-procedure takes in two images and the FITS header file for the mosaic. The procedure will then output a
-difference image representing the information of where the two images overlap.
-
-mDiffFit
-^^^^^^^^
-----
-app ( Image diff_img, Status stat ) mDiffFit( Image img_1, Image img_2, Header hdr )
-----
-This app procedure will call the mDiffFit function from the Montage
-toolkit. The mDiffFit function in Montage is the combination of the mDiff and
-mFitplane functions.
-
-mFitplane
-^^^^^^^^^
-----
-app ( Status stat ) mFitplane( Image diff_img )
-----
-This app procedure will call the mFitplane function from the Montage
-toolkit. This procedure takes in as input the difference image that was the output from
-the mDiff procedure. The procedure will then output a status file that
-contains the information on how to fit these two images together.
-
-mImgtbl
-^^^^^^^
-----
-app ( Table img_tbl ) mImgtbl( Image imgs[] )
-----
-This app procedure will call the mImgtbl function from the Montage
-toolkit. This procedure takes in as input a list of images to create a table
-from. The output is an image table that represents these images. All the
-images that will be part of this table must reside in the same directory.
-
-mMakeHdr
-^^^^^^^^
-----
-app ( Header hdr ) mMakeHdr( Table img_tbl )
-----
-This app procedure will call the mMakeHdr function from the Montage
-toolkit. This procedure will take in as input an image table representing the
-images that will be combined into a single mosaic. The procedure will then output the
-FITS header file for the mosaic.
-
-mJPEG
-^^^^^
-----
-app ( JPEG mos_img_jpg ) mJPEG( Image mos_img )
-----
-This app procedure will call the mJPEG function from the Montage toolkit. This
-procedure will take in as input as input a FITS image. The procedure will
-then ouput the same image in jpeg format.
-
-mOverlaps
-^^^^^^^^^
-----
-app ( Table diff_tbl ) mOverlaps( Table img_tbl )
-----
-This app procedure will call the mOverlaps function from the Montage
-toolkit. This procedure takes in as input an image table of the images that
-will be combined into a single mosaic. The procedure will then output a table
-of all the images that overlap with each other in the mosaic.
-
-mProject
-^^^^^^^^
-----
-app ( Image proj_img ) mProject( Image raw_img, Header hdr )
-----
-This app procedure will call the mProject function from the Montage
-toolkit. This procedure takes in as input a FITS image file and the FITS header file
-that for the mosaic. The output is the projected image.
-
-NOTE: The mProject app procedure is for general projection. There are some cases in
-which the faster mProjectPP procedure should be used.
-
-mProjectPP
-^^^^^^^^^^
-----
-app ( Image proj_img ) mProjectPP( Image raw_img, Header hdr )
-----
-This app procedure will call the mProjectPP function from the Montage
-toolkit. This procedure takes in as input a FITS image file and the FITS header file
-that for the mosaic. The output is the projected image.
-
-NOTE: The mProjectPP app procedure is a "special case" version of mProject
-and can be used only where the input and output images have tangent-plane
-projections (e.g. TAN, SIN) or where they can be approximated with acceptable
-error.
-
-
-mShrink
-^^^^^^^
-----
-app ( Image shrunk ) mShrink( Image original, int factor )
-----
-This app procedure will call the mShrink function in the Montage toolkit. This
-procedure takes in as input a single image and an re-sizing factor represented
-as an integer. The procedure will then output the re-sized image.
-
-Backgound_list
-^^^^^^^^^^^^^^
-----
-app ( Table back_tbl ) Background_list( Table imgs_tbl, Table rect_tbl )
-----
-This app procedure will call the Background_list python script that is included in
-the scripts directory for the SwiftMontage wrappers. This procedure takes in as input an image table of the
-images that are being combined into a single mosaic and the table of
-coefficients to rectify the mosaic. The procedure will then output a file in a
-format that can be read in by the Swift readData2 function into the
-Background_struct declared type.
-
-create_status_table
-^^^^^^^^^^^^^^^^^^^
-----
-app ( Table stat_tbl ) create_status_table( Table diff_tbl )
-----
-This app procedure will call the create_status_table python script that is
-included in the scripts directory for the SwiftMontage wrappers. This
-procedure takes in as input the difference table that has been generated by
-the mOverlaps procedure. The procedure will the output a table that can be
-used as input to the mConcatFit app procedure.
-
-Batch Wrappers
-~~~~~~~~~~~~~~
-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
-SwiftMontage_Batch.swift
-
-mBackgroundBatch
-^^^^^^^^^^^^^^^^
-----
-( Image rect_imgs[] ) mBackgroundBatch( string dest, Image imgs[], Table img_tbl,
- Table rect_tbl )
-----
-This batch swift script takes in as input a destination directory for the
-rectified images, a list of images that will be combined into a
-mosaic, an image table representing the images for the mosaic, and a table of
-the coefficients that must be applied to each image. The script will then
-output a list of the images after the coefficients have been applied. The
-application of the coefficients to each image is done in parallel.
-
-NOTE: mBackgroundBatch calls the mBackground app procedure.
-
-mDiffBatch
-^^^^^^^^^^
-----
-( Image diff_imgs[] ) mDiffBatch( string src, string dest, string filenames[],
- Table diff_tbl, Header hdr )
-----
-This batch script takes in as input a source directory of where the images to calculate
-overlaps are located, a destination directory of where to store these
-difference images, a list of the file names for the images that will be
-combined into the mosaic, a difference table that contains which images overlap with
-each other, and the FITS header file for the mosaic. This script will then
-output the difference images. The calculation each difference image are
-done in parallel.
-
-WARNING: The images that are in the source directory must be projected images.
-
-NOTE: mDiffBatch calls the mDiff app procedure.
-
-mDiffFitBatch
-^^^^^^^^^^^^^
-----
-( Image diff_imgs[], Table fits_tbl ) mDiffFitBatch( string src, string dest, string stat,
- string filenames[],
- Table diff_tbl, Header hdr )
-----
-This batch script takes in as input a source directory of where the images to
-calculate overlaps are located, a destination directory of where to store
-these difference images, a status directory of where to store the status files
-for each image, a list of the file names for the images that will be
-combined into the mosaic, a difference table that contains which images overlap
-with each other and the FITS header file for the mosaic. This script will then
-output a list of difference images and a table of information on how to fit
-the images together. The calculation of each difference image and the fitting
-table is done in parallel.
-
-WARNING: The images that are in the source directory must be projected images.
-
-NOTE: mDiffFitBatch calls the mDiffFit app procedure.
-
-mFitBatch
-^^^^^^^^^
-----
-( Table fits_tbl ) mFitBatch( string stat, Image diff_imgs[], Table diff_tbl )
-----
-This batch script takes in as input a directory for which the status files
-will be put in, the list of difference images that has
-been generated and the table that contains which images overlap with each
-other. The script then generates a table containing describing how to fit the
-two overalpping images together.
-
-NOTE: mFitBatch calls the mFitplane app procedure.
-
-mProjectBatch
-^^^^^^^^^^^^^
-----
-( Image proj_imgs[] ) mProjectBatch( string dest, Image raw_imgs[], Header hdr )
-----
-This batch script takes in as input the destination directory for the
-projected images, a list of raw image files and the FITS header file
-and projects each image. When projecting each image the function will decide
-if it is possible to use the fast image projetion algorithm or to just use
-standard projection.
-
-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 );
-----
Modified: SwiftApps/SwiftMontage/docs/updateAPI.sh
===================================================================
--- SwiftApps/SwiftMontage/docs/updateAPI.sh 2011-07-28 21:47:42 UTC (rev 4866)
+++ SwiftApps/SwiftMontage/docs/updateAPI.sh 2011-07-29 15:33:39 UTC (rev 4867)
@@ -1,5 +1,6 @@
#!/bin/bash
echo "Generating SwiftMontageAPI html file"
-asciidoc -a toc -a toclevels=3 -a numbered -a max-width=750px -a icons SwiftMontageAPI.txt
+asciidoc -a toclevels=3 SwiftMontageAPI.adoc
+
echo "Generating SwiftMontageAPI pdf file"
-a2x --format=pdf --icons --no-xmllint --dblatex-opts "-P doc.publisher.show=0 -P latex.output.revhistory=0" SwiftMontageAPI.txt
+a2x --format=pdf --icons --no-xmllint --dblatex-opts "-P doc.publisher.show=0 -P latex.output.revhistory=0" SwiftMontageAPI.adoc
More information about the Swift-commit
mailing list