Ignore:
Timestamp:
Oct 16, 2015 11:13:04 AM (7 years ago)
Author:
toby
Message:

update docs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sphinxdocs/build/html/imports.html

    r1998 r2010  
    342342<a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ImportPowderData" title="GSASIIIO.ImportPowderData"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIIO.ImportPowderData</span></tt></a>.
    343343They must be found in files named <cite>G2pwd*.py</cite> that are in the Python path
    344 and the class must override the <tt class="docutils literal"><span class="pre">__init__</span></tt> method and add a <tt class="docutils literal"><span class="pre">Reader</span></tt> method.
    345 The distributed routines are:</p>
     344and the class must override the <tt class="docutils literal"><span class="pre">__init__</span></tt> method and add a
     345<tt class="docutils literal"><span class="pre">Reader</span></tt> method.</p>
     346<p>The distributed routines are:</p>
    346347<span class="target" id="module-G2pwd_GPX"></span><div class="section" id="module-g2pwd-gpx-gsas-ii-projects">
    347348<h3><em>Module G2pwd_GPX: GSAS-II projects</em><a class="headerlink" href="#module-g2pwd-gpx-gsas-ii-projects" title="Permalink to this headline">¶</a></h3>
    … …  
    679680</dd></dl>
    680681
     682</div>
     683</div>
     684<div class="section" id="image-import-routines">
     685<h2>Image Import Routines<a class="headerlink" href="#image-import-routines" title="Permalink to this headline">¶</a></h2>
     686<p>Image import routines are classes derived from
     687, <a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ImportImage" title="GSASIIIO.ImportImage"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIIO.ImportImage</span></tt></a>.
     688They must be found in files named <cite>G2img*.py</cite> that are in the Python path
     689and the class must override the <tt class="docutils literal"><span class="pre">__init__</span></tt> method and add a <tt class="docutils literal"><span class="pre">Reader</span></tt> method.
     690The distributed routines are:</p>
     691<span class="target" id="module-G2img_ADSC"></span><div class="section" id="module-g2img-adsc-img-image-file">
     692<h3><em>Module G2img_ADSC: .img image file</em><a class="headerlink" href="#module-g2img-adsc-img-image-file" title="Permalink to this headline">¶</a></h3>
     693<p>Routine to read an ADSC .img file</p>
     694</div>
     695<span class="target" id="module-G2img_EDF"></span><div class="section" id="module-g2img-edf-edf-image-file">
     696<h3><em>Module G2img_EDF: .edf image file</em><a class="headerlink" href="#module-g2img-edf-edf-image-file" title="Permalink to this headline">¶</a></h3>
     697<p>Routine to read a Read European detector data edf file</p>
     698</div>
     699<span class="target" id="module-G2img_SumG2"></span><div class="section" id="module-g2img-g2-python-pickled-image">
     700<h3><em>Module G2img_G2: Python pickled image</em><a class="headerlink" href="#module-g2img-g2-python-pickled-image" title="Permalink to this headline">¶</a></h3>
     701<p>Routine to read an image that has been pickled in Python. Images
     702in this format are created by the &#8220;Sum image data&#8221; command.</p>
     703</div>
     704<span class="target" id="module-G2img_GE"></span><div class="section" id="module-g2img-ge-summed-ge-image-file">
     705<h3><em>Module G2img_GE: summed GE image file</em><a class="headerlink" href="#module-g2img-ge-summed-ge-image-file" title="Permalink to this headline">¶</a></h3>
     706<p>Routine to read a summed GE image from APS Sector 1</p>
     707</div>
     708<span class="target" id="module-G2img_MAR"></span><div class="section" id="module-g2img-mar-mar-image-files">
     709<h3><em>Module G2img_MAR: MAR image files</em><a class="headerlink" href="#module-g2img-mar-mar-image-files" title="Permalink to this headline">¶</a></h3>
     710<p>Routine to read several MAR formats, .mar3450,.mar2300,.mar2560</p>
     711</div>
     712<span class="target" id="module-G2img_Rigaku"></span><div class="section" id="module-g2img-rigaku-stl-image-file">
     713<h3><em>Module G2img_Rigaku: .stl image file</em><a class="headerlink" href="#module-g2img-rigaku-stl-image-file" title="Permalink to this headline">¶</a></h3>
     714<p>Routine to read a Rigaku R-Axis IV image file</p>
     715</div>
     716<span class="target" id="module-G2img_1TIF"></span><div class="section" id="module-g2img-tif-tif-image-file">
     717<h3><em>Module G2img_TIF: .tif image file</em><a class="headerlink" href="#module-g2img-tif-tif-image-file" title="Permalink to this headline">¶</a></h3>
     718<p>Routine to read an image in Tagged-image file (TIF) format as well as a variety
     719of slightly incorrect pseudo-TIF formats used at instruments around the world.</p>
     720<dl class="class">
     721<dt id="G2img_1TIF.TIF_ReaderClass">
     722<em class="property">class </em><tt class="descclassname">G2img_1TIF.</tt><tt class="descname">TIF_ReaderClass</tt><a class="reference internal" href="_modules/G2img_1TIF.html#TIF_ReaderClass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#G2img_1TIF.TIF_ReaderClass" title="Permalink to this definition">¶</a></dt>
     723<dd><p>Routine to read an image in Tagged-image file (TIF) format as well as a variety
     724of slightly incorrect pseudo-TIF formats</p>
     725<dl class="method">
     726<dt id="G2img_1TIF.TIF_ReaderClass.ContentsValidator">
     727<tt class="descname">ContentsValidator</tt><big>(</big><em>filepointer</em><big>)</big><a class="reference internal" href="_modules/G2img_1TIF.html#TIF_ReaderClass.ContentsValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#G2img_1TIF.TIF_ReaderClass.ContentsValidator" title="Permalink to this definition">¶</a></dt>
     728<dd><p>Does the header match the required TIF header?</p>
     729</dd></dl>
     730
     731<dl class="method">
     732<dt id="G2img_1TIF.TIF_ReaderClass.Reader">
     733<tt class="descname">Reader</tt><big>(</big><em>filename</em>, <em>filepointer</em>, <em>ParentFrame=None</em>, <em>**unused</em><big>)</big><a class="reference internal" href="_modules/G2img_1TIF.html#TIF_ReaderClass.Reader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#G2img_1TIF.TIF_ReaderClass.Reader" title="Permalink to this definition">¶</a></dt>
     734<dd><p>Read the TIF file using Bob&#8217;s routine</p>
     735</dd></dl>
     736
     737</dd></dl>
     738
     739</div>
     740<span class="target" id="module-G2img_CheMin"></span><div class="section" id="module-g2img-png-png-image-file">
     741<h3><em>Module G2img_png: png image file</em><a class="headerlink" href="#module-g2img-png-png-image-file" title="Permalink to this headline">¶</a></h3>
     742<p>Routine to read an image in .png (Portable Network Graphics) format.
     743For now, the only known use of this is with converted CheMin tif files
     744so default parameters are that machine.</p>
    681745</div>
    682746</div>
    … …  
    732796<li><a class="reference internal" href="#small-angle-scattering-data-import-routines">Small Angle Scattering Data Import Routines</a><ul>
    733797<li><a class="reference internal" href="#module-g2sad-xye-read-small-angle-data"><em>Module G2sad_xye: read small angle data</em></a></li>
     798</ul>
     799</li>
     800<li><a class="reference internal" href="#image-import-routines">Image Import Routines</a><ul>
     801<li><a class="reference internal" href="#module-g2img-adsc-img-image-file"><em>Module G2img_ADSC: .img image file</em></a></li>
     802<li><a class="reference internal" href="#module-g2img-edf-edf-image-file"><em>Module G2img_EDF: .edf image file</em></a></li>
     803<li><a class="reference internal" href="#module-g2img-g2-python-pickled-image"><em>Module G2img_G2: Python pickled image</em></a></li>
     804<li><a class="reference internal" href="#module-g2img-ge-summed-ge-image-file"><em>Module G2img_GE: summed GE image file</em></a></li>
     805<li><a class="reference internal" href="#module-g2img-mar-mar-image-files"><em>Module G2img_MAR: MAR image files</em></a></li>
     806<li><a class="reference internal" href="#module-g2img-rigaku-stl-image-file"><em>Module G2img_Rigaku: .stl image file</em></a></li>
     807<li><a class="reference internal" href="#module-g2img-tif-tif-image-file"><em>Module G2img_TIF: .tif image file</em></a></li>
     808<li><a class="reference internal" href="#module-g2img-png-png-image-file"><em>Module G2img_png: png image file</em></a></li>
    734809</ul>
    735810</li>
Note: See TracChangeset for help on using the changeset viewer.