[Swift-commit] r4596 - in SwiftApps/Montage: . docs docs/images docs/images/icons exec
jonmon at ci.uchicago.edu
jonmon at ci.uchicago.edu
Thu Jun 9 14:02:18 CDT 2011
Author: jonmon
Date: 2011-06-09 14:02:18 -0500 (Thu, 09 Jun 2011)
New Revision: 4596
Added:
SwiftApps/Montage/docs/
SwiftApps/Montage/docs/API.html
SwiftApps/Montage/docs/API.txt
SwiftApps/Montage/docs/images/
SwiftApps/Montage/docs/images/icons/
SwiftApps/Montage/docs/images/icons/note.png
SwiftApps/Montage/docs/images/icons/warning.png
SwiftApps/Montage/docs/updateAPI.sh
Modified:
SwiftApps/Montage/exec/montage.sh
Log:
o Added asciidoc documentation for the Swift Montage wrappers.
o Updated the montage.sh execution script
Added: SwiftApps/Montage/docs/API.html
===================================================================
--- SwiftApps/Montage/docs/API.html (rev 0)
+++ SwiftApps/Montage/docs/API.html 2011-06-09 19:02:18 UTC (rev 4596)
@@ -0,0 +1,1108 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.5" />
+<title>Swift Montage API</title>
+<style type="text/css">
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
+
+/* Default font. */
+body {
+ font-family: Georgia,serif;
+}
+
+/* Title font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+#toctitle,
+#author, #revnumber, #revdate, #revremark,
+#footer {
+ font-family: Arial,Helvetica,sans-serif;
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a {
+ color: blue;
+ text-decoration: underline;
+}
+a:visited {
+ color: fuchsia;
+}
+
+em {
+ font-style: italic;
+ color: navy;
+}
+
+strong {
+ font-weight: bold;
+ color: #083194;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1, h2, h3 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ padding-top: 0.5em;
+}
+h3 {
+ float: left;
+}
+h3 + * {
+ clear: left;
+}
+h5 {
+ font-size: 1.0em;
+}
+
+div.sectionbody {
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+ul, ol, li > p {
+ margin-top: 0;
+}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
+
+pre {
+ padding: 0;
+ margin: 0;
+}
+
+#author {
+ color: #527bbd;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+#email {
+}
+#revnumber, #revdate, #revremark {
+}
+
+#footer {
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+#preamble {
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.0em;
+ margin-bottom: 2.0em;
+ margin-right: 10%;
+ color: #606060;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ color: #527bbd;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
+ padding: 0.5em;
+}
+
+div.quoteblock, div.verseblock {
+ padding-left: 1.0em;
+ margin-left: 1.0em;
+ margin-right: 10%;
+ border-left: 5px solid #f0f0f0;
+ color: #777777;
+}
+
+div.quoteblock > div.attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
+}
+div.verseblock > div.attribution {
+ padding-top: 0.75em;
+ text-align: left;
+}
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
+div.verseblock + div.attribution {
+ text-align: left;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 3px solid #dddddd;
+}
+
+div.exampleblock > div.content {
+ border-left: 3px solid #dddddd;
+ padding-left: 0.5em;
+}
+
+div.imageblock div.content { padding-left: 0; }
+span.image img { border-style: none; }
+a.image:visited { color: white; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: normal;
+ color: navy;
+}
+dd > *:first-child {
+ margin-top: 0.1em;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.arabic {
+ list-style-type: decimal;
+}
+ol.loweralpha {
+ list-style-type: lower-alpha;
+}
+ol.upperalpha {
+ list-style-type: upper-alpha;
+}
+ol.lowerroman {
+ list-style-type: lower-roman;
+}
+ol.upperroman {
+ list-style-type: upper-roman;
+}
+
+div.compact ul, div.compact ol,
+div.compact p, div.compact p,
+div.compact div, div.compact div {
+ margin-top: 0.1em;
+ margin-bottom: 0.1em;
+}
+
+tfoot {
+ font-weight: bold;
+}
+td > div.verse {
+ white-space: pre;
+}
+
+div.hdlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+div.hdlist tr {
+ padding-bottom: 15px;
+}
+dt.hdlist1.strong, td.hdlist1.strong {
+ font-weight: bold;
+}
+td.hdlist1 {
+ vertical-align: top;
+ font-style: normal;
+ padding-right: 0.8em;
+ color: navy;
+}
+td.hdlist2 {
+ vertical-align: top;
+}
+div.hdlist.compact tr {
+ margin: 0;
+ padding-bottom: 0;
+}
+
+.comment {
+ background: yellow;
+}
+
+.footnote, .footnoteref {
+ font-size: 0.8em;
+}
+
+span.footnote, span.footnoteref {
+ vertical-align: super;
+}
+
+#footnotes {
+ margin: 20px 0 20px 0;
+ padding: 7px 0 0 0;
+}
+
+#footnotes div.footnote {
+ margin: 0 0 5px 0;
+}
+
+#footnotes hr {
+ border: none;
+ border-top: 1px solid silver;
+ height: 1px;
+ text-align: left;
+ margin-left: 0;
+ width: 20%;
+ min-width: 100px;
+}
+
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
+
+ at media print {
+ #footer-badges { display: none; }
+}
+
+#toc {
+ margin-bottom: 2.5em;
+}
+
+#toctitle {
+ color: #527bbd;
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 1.0em;
+ margin-bottom: 0.1em;
+}
+
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+div.toclevel2 {
+ margin-left: 2em;
+ font-size: 0.9em;
+}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
+
+span.aqua { color: aqua; }
+span.black { color: black; }
+span.blue { color: blue; }
+span.fuchsia { color: fuchsia; }
+span.gray { color: gray; }
+span.green { color: green; }
+span.lime { color: lime; }
+span.maroon { color: maroon; }
+span.navy { color: navy; }
+span.olive { color: olive; }
+span.purple { color: purple; }
+span.red { color: red; }
+span.silver { color: silver; }
+span.teal { color: teal; }
+span.white { color: white; }
+span.yellow { color: yellow; }
+
+span.aqua-background { background: aqua; }
+span.black-background { background: black; }
+span.blue-background { background: blue; }
+span.fuchsia-background { background: fuchsia; }
+span.gray-background { background: gray; }
+span.green-background { background: green; }
+span.lime-background { background: lime; }
+span.maroon-background { background: maroon; }
+span.navy-background { background: navy; }
+span.olive-background { background: olive; }
+span.purple-background { background: purple; }
+span.red-background { background: red; }
+span.silver-background { background: silver; }
+span.teal-background { background: teal; }
+span.white-background { background: white; }
+span.yellow-background { background: yellow; }
+
+span.big { font-size: 2em; }
+span.small { font-size: 0.6em; }
+
+span.underline { text-decoration: underline; }
+span.overline { text-decoration: overline; }
+span.line-through { text-decoration: line-through; }
+
+
+/*
+ * xhtml11 specific
+ *
+ * */
+
+tt {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
+div.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead, p.table.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+p.table {
+ margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
+ border-style: none;
+}
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
+}
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
+}
+
+
+/*
+ * html5 specific
+ *
+ * */
+
+.monospaced {
+ font-family: monospace;
+ font-size: inherit;
+ color: navy;
+}
+
+table.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+thead, p.tableblock.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+p.tableblock {
+ margin-top: 0;
+}
+table.tableblock {
+ border-width: 3px;
+ border-spacing: 0px;
+ border-style: solid;
+ border-color: #527bbd;
+ border-collapse: collapse;
+}
+th.tableblock, td.tableblock {
+ border-width: 1px;
+ padding: 4px;
+ border-style: solid;
+ border-color: #527bbd;
+}
+
+table.tableblock.frame-topbot {
+ border-left-style: hidden;
+ border-right-style: hidden;
+}
+table.tableblock.frame-sides {
+ border-top-style: hidden;
+ border-bottom-style: hidden;
+}
+table.tableblock.frame-none {
+ border-style: hidden;
+}
+
+th.tableblock.halign-left, td.tableblock.halign-left {
+ text-align: left;
+}
+th.tableblock.halign-center, td.tableblock.halign-center {
+ text-align: center;
+}
+th.tableblock.halign-right, td.tableblock.halign-right {
+ text-align: right;
+}
+
+th.tableblock.valign-top, td.tableblock.valign-top {
+ vertical-align: top;
+}
+th.tableblock.valign-middle, td.tableblock.valign-middle {
+ vertical-align: middle;
+}
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {
+ vertical-align: bottom;
+}
+</style>
+<script type="text/javascript">
+/*<+'])');
+ // Function that scans the DOM tree for header elements (the DOM2
+ // nodeIterator API would be a better technique but not supported by all
+ // browsers).
+ var iterate = function (el) {
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {
+ if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
+ var mo = re.exec(i.tagName);
+ if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
+ result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
+ }
+ iterate(i);
+ }
+ }
+ }
+ iterate(el);
+ return result;
+ }
+
+ var toc = document.getElementById("toc");
+ if (!toc) {
+ return;
+ }
+
+ // Delete existing TOC entries in case we're reloading the TOC.
+ var tocEntriesToRemove = [];
+ var i;
+ for (i = 0; i < toc.childNodes.length; i++) {
+ var entry = toc.childNodes[i];
+ if (entry.nodeName == 'DIV'
+ && entry.getAttribute("class")
+ && entry.getAttribute("class").match(/^toclevel/))
+ tocEntriesToRemove.push(entry);
+ }
+ for (i = 0; i < tocEntriesToRemove.length; i++) {
+ toc.removeChild(tocEntriesToRemove[i]);
+ }
+
+ // Rebuild TOC entries.
+ var entries = tocEntries(document.getElementById("content"), toclevels);
+ for (var i = 0; i < entries.length; ++i) {
+ var entry = entries[i];
+ if (entry.element.id == "")
+ entry.element.id = "_toc_" + i;
+ var a = document.createElement("a");
+ a.href = "#" + entry.element.id;
+ a.appendChild(document.createTextNode(entry.text));
+ var div = document.createElement("div");
+ div.appendChild(a);
+ div.className = "toclevel" + entry.toclevel;
+ toc.appendChild(div);
+ }
+ if (entries.length == 0)
+ toc.parentNode.removeChild(toc);
+},
+
+
+/////////////////////////////////////////////////////////////////////
+// Footnotes generator
+/////////////////////////////////////////////////////////////////////
+
+/* Based on footnote generation code from:
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
+ */
+
+footnotes: function () {
+ // Delete existing footnote entries in case we're reloading the footnodes.
+ var i;
+ var noteholder = document.getElementById("footnotes");
+ if (!noteholder) {
+ return;
+ }
+ var entriesToRemove = [];
+ for (i = 0; i < noteholder.childNodes.length; i++) {
+ var entry = noteholder.childNodes[i];
+ if (entry.nodeName == 'DIV' && entry.getAttribute("class") == "footnote")
+ entriesToRemove.push(entry);
+ }
+ for (i = 0; i < entriesToRemove.length; i++) {
+ noteholder.removeChild(entriesToRemove[i]);
+ }
+
+ // Rebuild footnote entries.
+ var cont = document.getElementById("content");
+ var spans = cont.getElementsByTagName("span");
+ var refs = {};
+ var n = 0;
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnote") {
+ n++;
+ var note = spans[i].getAttribute("data-note");
+ if (!note) {
+ // Use [\s\S] in place of . so multi-line matches work.
+ // Because JavaScript has no s (dotall) regex flag.
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ spans[i].innerHTML =
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ spans[i].setAttribute("data-note", note);
+ }
+ noteholder.innerHTML +=
+ "<div class='footnote' id='_footnote_" + n + "'>" +
+ "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
+ n + "</a>. " + note + "</div>";
+ var id =spans[i].getAttribute("id");
+ if (id != null) refs["#"+id] = n;
+ }
+ }
+ if (n == 0)
+ noteholder.parentNode.removeChild(noteholder);
+ else {
+ // Process footnoterefs.
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnoteref") {
+ var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
+ href = href.match(/#.*/)[0]; // Because IE return full URL.
+ n = refs[href];
+ spans[i].innerHTML =
+ "[<a href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ }
+ }
+ }
+},
+
+install: function(toclevels) {
+ var timerId;
+
+ function reinstall() {
+ asciidoc.footnotes();
+ if (toclevels) {
+ asciidoc.toc(toclevels);
+ }
+ }
+
+ function reinstallAndRemoveTimer() {
+ clearInterval(timerId);
+ reinstall();
+ }
+
+ timerId = setInterval(reinstall, 500);
+ if (document.addEventListener)
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
+ else
+ window.onload = reinstallAndRemoveTimer;
+}
+
+}
+asciidoc.install(2);
+/*]]>*/
+</script>
+</head>
+<body class="article" style="max-width:1100px">
+<div id="header">
+<h1>Swift Montage API</h1>
+<div id="toc">
+ <div id="toctitle">Table of Contents</div>
+ <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
+</div>
+</div>
+<div id="content">
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph"><p>This is the API for the Swift Montage wrappers. Montage is a toolkit for
+generating science grade astronomical mosaics. The image file format for
+Montage is Flexible Image Transport System or FITS.</p></div>
+<div class="paragraph"><p>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 users application.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="X1">Swift Montage API</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="_types">Types</h3>
+<div class="paragraph"><p>These are all the Types that are declared for Swift</p></div>
+<div class="listingblock">
+<div class="title">Image</div>
+<div class="content">
+<pre><tt>type Image;</tt></pre>
+</div></div>
+<div class="paragraph"><p>This is the Image type. It is used to declare the raw images, projected
+images, difference images, rectified images, and the mosaic.</p></div>
+<div class="listingblock">
+<div class="title">MosaicData</div>
+<div class="content">
+<pre><tt>type MosaicData;</tt></pre>
+</div></div>
+<div class="paragraph"><p>This is the MosaicData type. It is used to declare and map to the FITS header
+file.</p></div>
+<div class="listingblock">
+<div class="title">Table</div>
+<div class="content">
+<pre><tt>type Table;</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="listingblock">
+<div class="title">JPEG</div>
+<div class="content">
+<pre><tt>type JPEG</tt></pre>
+</div></div>
+<div class="paragraph"><p>This is the JPEG type. This is used to map to the jpeg version of the mosaic.</p></div>
+<div class="listingblock">
+<div class="title">Status</div>
+<div class="content">
+<pre><tt>type Status;</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="listingblock">
+<div class="title">BackgroundStruct</div>
+<div class="content">
+<pre><tt>type BackgroundStruct
+{
+ string fname;
+ float a;
+ float b;
+ float c;
+};</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="listingblock">
+<div class="title">DiffStruct</div>
+<div class="content">
+<pre><tt>type DiffStruct
+{
+ int cntr1;
+ int cntr2;
+ Image plus;
+ Image minus;
+ Image diff;
+};</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+</div>
+<div class="sect2">
+<h3 id="_app_procedures">App Procedures</h3>
+<div class="paragraph"><p>These are all the app procedures for Swift Montage. Currently the options to
+the Montage functions are hard coded and the user cannot choose which options
+to run.</p></div>
+<div class="listingblock">
+<div class="title">mAdd</div>
+<div class="content">
+<pre><tt>app ( Image mos ) mAdd( Image imgs[], Table img_tbl, MosaicData hdr )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<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>
+</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
+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>
+</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
+coefficients that must be applied to the images.</p></div>
+<div class="listingblock">
+<div class="title">mConcatFit</div>
+<div class="content">
+<pre><tt>app ( Table fits_tbl ) mConcatFit( Table status_tbl, Status stats[] )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<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>
+</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
+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>
+</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
+mFitplane functions.</p></div>
+<div class="listingblock">
+<div class="title">mFitplane</div>
+<div class="content">
+<pre><tt>app ( Status stat ) mFitplane( Image diff_img )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="listingblock">
+<div class="title">mImgtbl</div>
+<div class="content">
+<pre><tt>app ( Table img_tbl ) mImgtbl( Image imgs[] )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="listingblock">
+<div class="title">mMakeHdr</div>
+<div class="content">
+<pre><tt>app ( MosaicData hdr ) mMakeHdr( Table img_tbl )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="listingblock">
+<div class="title">mJPEG</div>
+<div class="content">
+<pre><tt>app ( JPEG mos_img_jpg ) mJPEG( Image mos_img )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<div class="listingblock">
+<div class="title">mOverlaps</div>
+<div class="content">
+<pre><tt>app ( Table diff_tbl ) mOverlaps( Table img_tbl )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<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>
+</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>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">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.</td>
+</tr></table>
+</div>
+<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>
+</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>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">The mProject app procedure is for general projection. There are some cases in
+which the faster mProjectPP procedure should be used.</td>
+</tr></table>
+</div>
+<div class="listingblock">
+<div class="title">mShrink</div>
+<div class="content">
+<pre><tt>app ( Image shrunk ) mShrink( Image original, int factor )</tt></pre>
+</div></div>
+<div class="paragraph"><p>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.</p></div>
+<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>
+</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
+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.</p></div>
+<div class="listingblock">
+<div class="title">create_status_table</div>
+<div class="content">
+<pre><tt>app ( Table stat_tbl ) create_status_table( Table diff_tbl )</tt></pre>
+</div></div>
+<div class="paragraph"><p>This app procedure will call the create_status_table python script that is
+included in the scripts directory for the Swift Montage 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.</p></div>
+</div>
+<div class="sect2">
+<h3 id="_batch_wrappers">Batch Wrappers</h3>
+<div class="paragraph"><p>These are the Batch scripts. These scripts do most of the file mapping
+and is where the parallelization is taking place.</p></div>
+<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>
+</div></div>
+<div class="paragraph"><p>This batch swift script takes in 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.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">mBackgroundBatch calls the mBackground app procedure.</td>
+</tr></table>
+</div>
+<div class="listingblock">
+<div class="title">mDiffBatch</div>
+<div class="content">
+<pre><tt>( Image diff_imgs[] ) mDiffBatch( string src_dir, string dest_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
+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.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<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>
+</tr></table>
+</div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">mDiffBatch calls the mDiff app procedure.</td>
+</tr></table>
+</div>
+<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>
+</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
+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.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<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>
+</tr></table>
+</div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">mDiffFitBatch calls the mDiffFit app procedure.</td>
+</tr></table>
+</div>
+<div class="listingblock">
+<div class="title">mFitBatch</div>
+<div class="content">
+<pre><tt>( Table fits_tbl ) mFitBatch( Image diff_imgs[], Table diff_tbl )</tt></pre>
+</div></div>
+<div class="paragraph"><p>This batch script takes in as input 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.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">mFitBatch calls the mFitplane app procedure.</td>
+</tr></table>
+</div>
+<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>
+</div></div>
+<div class="paragraph"><p>This batch script takes in 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>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">mProjectBatch calls the faster mProjectPP app procedure if the image allows
+it. If mProjectPP cannot be used then the app procedure mProject is called.</td>
+</tr></table>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div id="footnotes"><hr /></div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2011-06-09 10:53:27 CDT
+</div>
+</div>
+</body>
+</html>
Added: SwiftApps/Montage/docs/API.txt
===================================================================
--- SwiftApps/Montage/docs/API.txt (rev 0)
+++ SwiftApps/Montage/docs/API.txt 2011-06-09 19:02:18 UTC (rev 4596)
@@ -0,0 +1,324 @@
+Swift Montage API
+=================
+
+This is the API for the Swift Montage 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 users application.
+
+[[X1]]
+
+Swift Montage API
+-----------------
+
+Types
+~~~~~
+These are all the Types that are declared for 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.
+
+.MosaicData
+----
+type MosaicData;
+----
+This is the MosaicData 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 Swift Montage. 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, MosaicData 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, Image area_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
+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 )
+----
+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
+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 area_img_1, Image proj_img_2, Image area_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
+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 )
+----
+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 ( MosaicData 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.
+
+.mProjectPP
+----
+app ( Image proj_img, Image area_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.
+
+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.
+
+.mProject
+----
+app ( Image proj_img, Image area_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.
+
+NOTE: The mProject app procedure is for general projection. There are some cases in
+which the faster mProjectPP procedure should be used.
+
+.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 corrs_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
+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 Swift Montage 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.
+
+.mBackgroundBatch
+----
+( Image corr_imgs[] ) mBackgroundBatch( Image bg_imgs[], Table img_tbl, Table corr_tbl )
+----
+This batch swift script takes in 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_dir, string dest_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
+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
+and the area files for these images must also reside in the source directory.
+
+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 )
+----
+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 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.
+
+NOTE: mDiffFitBatch calls the mDiffFit app procedure.
+
+.mFitBatch
+----
+( Table fits_tbl ) mFitBatch( Image diff_imgs[], Table diff_tbl )
+----
+This batch script takes in as input 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[], Image area_imgs[] ) mProjectBatch( Image raw_imgs[], MosaicData hdr )
+----
+This batch script takes in 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.
+
+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.
Added: SwiftApps/Montage/docs/images/icons/note.png
===================================================================
(Binary files differ)
Property changes on: SwiftApps/Montage/docs/images/icons/note.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: SwiftApps/Montage/docs/images/icons/warning.png
===================================================================
(Binary files differ)
Property changes on: SwiftApps/Montage/docs/images/icons/warning.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: SwiftApps/Montage/docs/updateAPI.sh
===================================================================
--- SwiftApps/Montage/docs/updateAPI.sh (rev 0)
+++ SwiftApps/Montage/docs/updateAPI.sh 2011-06-09 19:02:18 UTC (rev 4596)
@@ -0,0 +1,2 @@
+#!/bin/bash
+asciidoc -a toc -a max-width=1100px -a icons API.txt
Property changes on: SwiftApps/Montage/docs/updateAPI.sh
___________________________________________________________________
Added: svn:executable
+ *
Modified: SwiftApps/Montage/exec/montage.sh
===================================================================
--- SwiftApps/Montage/exec/montage.sh 2011-06-09 03:45:00 UTC (rev 4595)
+++ SwiftApps/Montage/exec/montage.sh 2011-06-09 19:02:18 UTC (rev 4596)
@@ -71,6 +71,6 @@
cp $4 ${WORK_DIRECTORY}
cp -r $5 ${WORK_DIRECTORY}
cd ${WORK_DIRECTORY}
-echo "swift -tc.file tc.data -sites.file sites.xml -config ${SWIFT_MONTAGE}/etc/swift_montage.properties ${SWIFT_MONTAGE}/scripts/montage.swift | tee -a swift.out"
+echo "clear ; swift -tc.file tc.data -sites.file sites.xml -config ${SWIFT_MONTAGE}/etc/swift_montage.properties ${SWIFT_MONTAGE}/scripts/montage.swift | tee -a swift.out"
#clear ; swiftrun -sites localhost pads -input raw_dir header.hdr -script m101_montage.swift
More information about the Swift-commit
mailing list