Ticket #9715: GatherWorkspaces-v1.html

File GatherWorkspaces-v1.html, 7.7 KB (added by Vickie Lynch, 6 years ago)
Line 
1<!DOCTYPE html>
2
3
4<html xmlns="http://www.w3.org/1999/xhtml">
5  <head>
6    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7   
8    <title>GatherWorkspaces v1 &mdash; MantidProject 3.1.20140617.1756 documentation</title>
9   
10    <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
11    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap.min.css" type="text/css" />
13    <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap-theme.min.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
15    <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
16   
17    <script type="text/javascript">
18      var DOCUMENTATION_OPTIONS = {
19        URL_ROOT:    '../',
20        VERSION:     '3.1.20140617.1756',
21        COLLAPSE_INDEX: false,
22        FILE_SUFFIX: '.html',
23        HAS_SOURCE:  true
24      };
25    </script>
26    <script type="text/javascript" src="../_static/jquery.js"></script>
27    <script type="text/javascript" src="../_static/underscore.js"></script>
28    <script type="text/javascript" src="../_static/doctools.js"></script>
29    <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
30    <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
31    <script type="text/javascript" src="../_static/bootstrap-3.1.0/js/bootstrap.min.js"></script>
32    <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
33    <link rel="top" title="MantidProject 3.1.20140617.1756 documentation" href="../index.html" />
34    <link rel="next" title="GeneralisedSecondDifference v1" href="GeneralisedSecondDifference-v1.html" />
35    <link rel="prev" title="FuryFitMultiple v1" href="FuryFitMultiple-v1.html" />
36<meta charset='utf-8'>
37<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
38<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
39<meta name="apple-mobile-web-app-capable" content="yes">
40
41  </head>
42  <body>
43
44  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
45    <div class="container">
46      <div class="navbar-header">
47        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
48        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
49          <span class="icon-bar"></span>
50          <span class="icon-bar"></span>
51          <span class="icon-bar"></span>
52        </button>
53        <a class="navbar-brand" href="../index.html"><img class="logo" src="../_static/Mantid_Logo_Transparent_Cropped.png" alt="Logo" width=113 height=24/></a>
54           </a>
55        <span class="navbar-text navbar-version pull-left"><b>3.1</b></span>
56      </div>
57
58        <div class="collapse navbar-collapse nav-collapse">
59          <ul class="nav navbar-nav">
60            <li class="divider-vertical"></li>
61           
62                <li><a href="/.html">Home</a></li>
63                <li><a href="http://download.mantidproject.org">Download</a></li>
64                <li><a href="/documentation.html">Documentation</a></li>
65                <li><a href="/contact-us.html">Contact Us</a></li>
66           
67           
68             
69             
70           
71           
72           
73           
74           
75          </ul>
76
77         
78           
79<form class="navbar-form navbar-right" action="../search.html" method="get">
80 <div class="form-group">
81  <input type="text" name="q" class="form-control" placeholder="Search" />
82 </div>
83  <input type="hidden" name="check_keywords" value="yes" />
84  <input type="hidden" name="area" value="default" />
85</form>
86         
87        </div>
88    </div>
89  </div>
90
91<div class="container">
92  <div class="row">
93    <div class="col-md-12">
94     
95  <div class="section" id="gatherworkspaces-v1">
96<span id="algm-gatherworkspaces"></span><span id="algm-gatherworkspaces-v1"></span><h1>GatherWorkspaces v1<a class="headerlink" href="#gatherworkspaces-v1" title="Permalink to this headline">¶</a></h1>
97<div class="figure align-right">
98<a class="screenshot reference internal image-reference" href="../_images/GatherWorkspaces-v1_dlg.png"><img alt="../_images/GatherWorkspaces-v1_dlg.png" class="screenshot" src="../_images/GatherWorkspaces-v1_dlg.png" style="width: 382px;" /></a>
99<p class="caption"><strong>GatherWorkspaces</strong> dialog.</p>
100</div>
101<div class="contents local topic" id="table-of-contents">
102<p class="topic-title first">Table of Contents</p>
103<ul class="simple">
104<li><a class="reference internal" href="#summary" id="id1">Summary</a></li>
105<li><a class="reference internal" href="#properties" id="id2">Properties</a></li>
106<li><a class="reference internal" href="#description" id="id3">Description</a></li>
107</ul>
108</div>
109<div class="section" id="summary">
110<h2><a class="toc-backref" href="#id1">Summary</a><a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
111<p>Stitches together the input workspaces provided by each of the processes into a single workspace.</p>
112</div>
113<div class="section" id="properties">
114<h2><a class="toc-backref" href="#id2">Properties</a><a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2>
115<table border="1" class="docutils">
116<colgroup>
117<col width="7%" />
118<col width="2%" />
119<col width="5%" />
120<col width="3%" />
121<col width="82%" />
122</colgroup>
123<thead valign="bottom">
124<tr class="row-odd"><th class="head">Name</th>
125<th class="head">Direction</th>
126<th class="head">Type</th>
127<th class="head">Default</th>
128<th class="head">Description</th>
129</tr>
130</thead>
131<tbody valign="top">
132<tr class="row-even"><td>InputWorkspace</td>
133<td>Input</td>
134<td>MatrixWorkspace</td>
135<td>Mandatory</td>
136<td>&nbsp;</td>
137</tr>
138<tr class="row-odd"><td>OutputWorkspace</td>
139<td>Output</td>
140<td>MatrixWorkspace</td>
141<td>&nbsp;</td>
142<td>&nbsp;</td>
143</tr>
144<tr class="row-even"><td>PreserveEvents</td>
145<td>Input</td>
146<td>boolean</td>
147<td>False</td>
148<td>Keep the output workspace as an EventWorkspace, if the input has events (default). If false, then the workspace gets converted to a Workspace2D histogram.</td>
149</tr>
150<tr class="row-odd"><td>AccumulationMethod</td>
151<td>Input</td>
152<td>string</td>
153<td>Append</td>
154<td>Method to use for accumulating each chunk from mpi processorss.  - Add: the processed chunk will be summed to the previous output (default).  - Append: the spectra of the chunk will be appended to the output workspace, increasing its size.</td>
155</tr>
156</tbody>
157</table>
158</div>
159<div class="section" id="description">
160<h2><a class="toc-backref" href="#id3">Description</a><a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
161<p>GatherWorkspaces is only availble for MPI builds.
162It stitches together the input workspaces provided by each of the processes into a single workspace in the root process.
163The spectra in the output workspace will be ordered by the rank of the input processes.
164It is up to the caller to ensure this results in the required ordering.
165Furthermore, there are all sorts of things that ought to be consistent for this algorithm to make sense (e.g. the instrument). The general philosophy, though, is to leave the responsibility for this to the user and only check the vital things (i.e. that the number of bins is consistent).</p>
166<p><strong>Categories</strong>: <a class="reference external" href="../categories/Algorithms.html">Algorithms</a> | <a class="reference external" href="../categories/MPI.html">MPI</a></p>
167</div>
168</div>
169
170
171    </div>
172     
173  </div>
174</div>
175<footer class="footer">
176  <div class="container">
177    <p class="pull-right">
178      <a href="#">Back to top</a>
179     
180    </p>
181    <p>
182        &copy; Copyright 2014, Mantid.<br/>
183    </p>
184  </div>
185</footer>
186  </body>
187</html>