[Swift-commit] r4606 - SwiftApps/Montage/docs
jonmon at ci.uchicago.edu
jonmon at ci.uchicago.edu
Mon Jun 13 15:08:54 CDT 2011
Author: jonmon
Date: 2011-06-13 15:08:54 -0500 (Mon, 13 Jun 2011)
New Revision: 4606
Modified:
SwiftApps/Montage/docs/API.html
SwiftApps/Montage/docs/API.txt
Log:
updates to the documentation. Removed the staging in/out of the area files.
Modified: SwiftApps/Montage/docs/API.html
===================================================================
--- SwiftApps/Montage/docs/API.html 2011-06-13 19:46:32 UTC (rev 4605)
+++ SwiftApps/Montage/docs/API.html 2011-06-13 20:08:54 UTC (rev 4606)
@@ -839,22 +839,21 @@
<div class="listingblock">
<div class="title">mBackground</div>
<div class="content">
-<pre><tt>app ( Image bg_img ) mBackground( Image img, Image area_img, float a, float b, float c )</tt></pre>
+<pre><tt>app ( Image bg_img ) mBackground( Image img, float a, float b, float c )</tt></pre>
</div></div>
<div class="paragraph"><p>This app procedure will call the mBackground function from the Montage
-toolkit. This procedure takes in a single image along with the area image file that has
-been generated by either mProject or the faster mProjectPP along with the
+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.</p></div>
<div class="listingblock">
<div class="title">mBgModel</div>
<div class="content">
-<pre><tt>app ( Table corr_tbl ) mBgModel( Table img_tbl, Table fits_tbl )</tt></pre>
+<pre><tt>app ( Table rect_tbl ) mBgModel( Table img_tbl, Table fits_tbl )</tt></pre>
</div></div>
<div class="paragraph"><p>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 corrections table of the
+fit them together. The procedure will then output a rectification table of the
coefficients that must be applied to the images.</p></div>
<div class="listingblock">
<div class="title">mConcatFit</div>
@@ -869,16 +868,15 @@
<div class="listingblock">
<div class="title">mDiff</div>
<div class="content">
-<pre><tt>app ( Image diff_img ) mDiff( Image proj_img_1, Image area_img_1, Image proj_img_2, Image area_img_2, MosaicData hdr )</tt></pre>
+<pre><tt>app ( Image diff_img ) mDiff( Image proj_img_1, Image proj_img_2, MosaicData hdr )</tt></pre>
</div></div>
<div class="paragraph"><p>This app procedure will call the mDiff function from the Montage toolkit. This
-procedure takes in two images along with their associated area image files and
-the FITS header file for the mosaic. The procedure will then output a
+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.</p></div>
<div class="listingblock">
<div class="title">mDiffFit</div>
<div class="content">
-<pre><tt>app ( Image diff_img, Status stat ) mDiffFit( Image img_1, Image area_img_1, Image img_2, Image area_img_2, MosaicData hdr )</tt></pre>
+<pre><tt>app ( Image diff_img, Status stat ) mDiffFit( Image img_1, Image img_2, MosaicData hdr )</tt></pre>
</div></div>
<div class="paragraph"><p>This app procedure will call the mDiffFit function from the Montage
toolkit. The mDiffFit function in Montage is the combination of the mDiff and
@@ -930,12 +928,11 @@
<div class="listingblock">
<div class="title">mProjectPP</div>
<div class="content">
-<pre><tt>app ( Image proj_img, Image area_img ) mProjectPP( Image raw_img, MosaicData hdr )</tt></pre>
+<pre><tt>app ( Image proj_img ) mProjectPP( Image raw_img, MosaicData hdr )</tt></pre>
</div></div>
<div class="paragraph"><p>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 and the area image file
-associated with the projected image.</p></div>
+that for the mosaic. The output is the projected image.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
@@ -950,12 +947,11 @@
<div class="listingblock">
<div class="title">mProject</div>
<div class="content">
-<pre><tt>app ( Image proj_img, Image area_img ) mProject( Image raw_img, MosaicData hdr )</tt></pre>
+<pre><tt>app ( Image proj_img ) mProject( Image raw_img, MosaicData hdr )</tt></pre>
</div></div>
<div class="paragraph"><p>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 and the area image file
-associated with the projected image.</p></div>
+that for the mosaic. The output is the projected image.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
@@ -976,7 +972,7 @@
<div class="listingblock">
<div class="title">Backgound_list</div>
<div class="content">
-<pre><tt>app ( Table back_tbl ) Background_list( Table imgs_tbl, Table corrs_tbl )</tt></pre>
+<pre><tt>app ( Table back_tbl ) Background_list( Table imgs_tbl, Table rect_tbl )</tt></pre>
</div></div>
<div class="paragraph"><p>This app procedure will call the Background_list python script that is included in
the scripts directory for the Swift Montage wrappers. This procedure takes in as input an image table of the
@@ -1003,9 +999,10 @@
<div class="listingblock">
<div class="title">mBackgroundBatch</div>
<div class="content">
-<pre><tt>( Image corr_imgs[] ) mBackgroundBatch( Image bg_imgs[], Table img_tbl, Table corr_tbl )</tt></pre>
+<pre><tt>( Image rect_imgs[] ) mBackgroundBatch( string dest_dir, Image proj_imgs[], Table img_tbl, Table rect_tbl )</tt></pre>
</div></div>
-<div class="paragraph"><p>This batch swift script takes in a list of images that will be combined into a
+<div class="paragraph"><p>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
@@ -1035,8 +1032,7 @@
<td class="icon">
<img src="./images/icons/warning.png" alt="Warning" />
</td>
-<td class="content">The images that are in the source directory must be projected images
-and the area files for these images must also reside in the source directory.</td>
+<td class="content">The images that are in the source directory must be projected images.</td>
</tr></table>
</div>
<div class="admonitionblock">
@@ -1050,11 +1046,13 @@
<div class="listingblock">
<div class="title">mDiffFitBatch</div>
<div class="content">
-<pre><tt>( Image diff_imgs[], Table fits_tbl ) mDiffFitBatch( string src_dir, string dest_dir, string files[], Table diff_tbl, MosaicData hdr )</tt></pre>
+<pre><tt>( Image diff_imgs[], Table fits_tbl ) mDiffFitBatch( string src_dir, string dest_dir, string stat_dir,
+ string files[], Table diff_tbl, MosaicData hdr )</tt></pre>
</div></div>
<div class="paragraph"><p>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
+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
@@ -1065,8 +1063,7 @@
<td class="icon">
<img src="./images/icons/warning.png" alt="Warning" />
</td>
-<td class="content">The images that are in the source directory must be projected images
-and the area files for these images must also reside in the source directory.</td>
+<td class="content">The images that are in the source directory must be projected images.</td>
</tr></table>
</div>
<div class="admonitionblock">
@@ -1097,13 +1094,13 @@
<div class="listingblock">
<div class="title">mProjectBatch</div>
<div class="content">
-<pre><tt>( Image proj_imgs[], Image area_imgs[] ) mProjectBatch( Image raw_imgs[], MosaicData hdr )</tt></pre>
+<pre><tt>( Image proj_imgs[] ) mProjectBatch( string dest_dir, Image raw_imgs[], MosaicData hdr )</tt></pre>
</div></div>
-<div class="paragraph"><p>This batch script takes in list of raw image files and the FITS header file
+<div class="paragraph"><p>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. Also, an area image file is generated for each projected
-image that is used in later functions.</p></div>
+standard projection.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
@@ -1120,7 +1117,7 @@
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2011-06-09 16:29:55 CDT
+Last updated 2011-06-13 15:05:50 CDT
</div>
</div>
</body>
Modified: SwiftApps/Montage/docs/API.txt
===================================================================
--- SwiftApps/Montage/docs/API.txt 2011-06-13 19:46:32 UTC (rev 4605)
+++ SwiftApps/Montage/docs/API.txt 2011-06-13 20:08:54 UTC (rev 4606)
@@ -109,22 +109,21 @@
.mBackground
----
-app ( Image bg_img ) mBackground( Image img, Image area_img, float a, float b, float c )
+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 area image file that has
-been generated by either mProject or the faster mProjectPP along with the
+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 corr_tbl ) mBgModel( Table img_tbl, Table fits_tbl )
+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 corrections table of the
+fit them together. The procedure will then output a rectification table of the
coefficients that must be applied to the images.
.mConcatFit
@@ -139,16 +138,15 @@
.mDiff
----
-app ( Image diff_img ) mDiff( Image proj_img_1, Image area_img_1, Image proj_img_2, Image area_img_2, MosaicData hdr )
+app ( Image diff_img ) mDiff( Image proj_img_1, Image proj_img_2, MosaicData hdr )
----
This app procedure will call the mDiff function from the Montage toolkit. This
-procedure takes in two images along with their associated area image files and
-the FITS header file for the mosaic. The procedure will then output a
+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 area_img_1, Image img_2, Image area_img_2, MosaicData hdr )
+app ( Image diff_img, Status stat ) mDiffFit( Image img_1, Image img_2, MosaicData 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
@@ -200,12 +198,11 @@
.mProjectPP
----
-app ( Image proj_img, Image area_img ) mProjectPP( Image raw_img, MosaicData hdr )
+app ( Image proj_img ) mProjectPP( Image raw_img, MosaicData 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 and the area image file
-associated with the projected image.
+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
@@ -214,12 +211,11 @@
.mProject
----
-app ( Image proj_img, Image area_img ) mProject( Image raw_img, MosaicData hdr )
+app ( Image proj_img ) mProject( Image raw_img, MosaicData 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 and the area image file
-associated with the projected image.
+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.
@@ -234,7 +230,7 @@
.Backgound_list
----
-app ( Table back_tbl ) Background_list( Table imgs_tbl, Table corrs_tbl )
+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 Swift Montage wrappers. This procedure takes in as input an image table of the
@@ -261,9 +257,10 @@
.mBackgroundBatch
----
-( Image corr_imgs[] ) mBackgroundBatch( Image bg_imgs[], Table img_tbl, Table corr_tbl )
+( Image rect_imgs[] ) mBackgroundBatch( string dest_dir, Image proj_imgs[], Table img_tbl, Table rect_tbl )
----
-This batch swift script takes in a list of images that will be combined into a
+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
@@ -283,26 +280,26 @@
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
-and the area files for these images must also reside in the source directory.
+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_dir, string dest_dir, string files[], Table diff_tbl, MosaicData hdr )
+( Image diff_imgs[], Table fits_tbl ) mDiffFitBatch( string src_dir, string dest_dir, string stat_dir,
+ string files[], Table diff_tbl, MosaicData 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
+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
-and the area files for these images must also reside in the source directory.
+WARNING: The images that are in the source directory must be projected images.
NOTE: mDiffFitBatch calls the mDiffFit app procedure.
@@ -319,13 +316,13 @@
.mProjectBatch
----
-( Image proj_imgs[], Image area_imgs[] ) mProjectBatch( Image raw_imgs[], MosaicData hdr )
+( Image proj_imgs[] ) mProjectBatch( string dest_dir, Image raw_imgs[], MosaicData hdr )
----
-This batch script takes in list of raw image files and the FITS header file
+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. Also, an area image file is generated for each projected
-image that is used in later functions.
+standard projection.
NOTE: mProjectBatch calls the faster mProjectPP app procedure if the image allows
it. If mProjectPP cannot be used then the app procedure mProject is called.
More information about the Swift-commit
mailing list