source: fact/tools/pyscripts/doc/_build/html/classes.html@ 13316

Last change on this file since 13316 was 13316, checked in by lusterma, 13 years ago
worked on doc
File size: 6.5 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7 <head>
8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
10 <title>Classes &mdash; pyfact v0.1 documentation</title>
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13 <script type="text/javascript">
14 var DOCUMENTATION_OPTIONS = {
15 URL_ROOT: '',
16 VERSION: '0.1',
17 COLLAPSE_INDEX: false,
18 FILE_SUFFIX: '.html',
19 HAS_SOURCE: true
20 };
21 </script>
22 <script type="text/javascript" src="_static/jquery.js"></script>
23 <script type="text/javascript" src="_static/underscore.js"></script>
24 <script type="text/javascript" src="_static/doctools.js"></script>
25 <link rel="top" title="pyfact v0.1 documentation" href="index.html" />
26 <link rel="next" title="Examples" href="examples.html" />
27 <link rel="prev" title="Introduction" href="introduction.html" />
28 </head>
29 <body>
30 <div class="related">
31 <h3>Navigation</h3>
32 <ul>
33 <li class="right" style="margin-right: 10px">
34 <a href="genindex.html" title="General Index"
35 accesskey="I">index</a></li>
36 <li class="right" >
37 <a href="examples.html" title="Examples"
38 accesskey="N">next</a> |</li>
39 <li class="right" >
40 <a href="introduction.html" title="Introduction"
41 accesskey="P">previous</a> |</li>
42 <li><a href="index.html">pyfact v0.1 documentation</a> &raquo;</li>
43 </ul>
44 </div>
45
46 <div class="document">
47 <div class="documentwrapper">
48 <div class="bodywrapper">
49 <div class="body">
50
51 <div class="section" id="classes">
52<h1>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h1>
53<div class="section" id="pyfact-py">
54<h2>pyfact.py<a class="headerlink" href="#pyfact-py" title="Permalink to this headline">¶</a></h2>
55<div class="section" id="rawdata-access">
56<h3>rawdata access<a class="headerlink" href="#rawdata-access" title="Permalink to this headline">¶</a></h3>
57</div>
58<div class="section" id="fnames-of-a-data-run">
59<h3>fnames of a data run<a class="headerlink" href="#fnames-of-a-data-run" title="Permalink to this headline">¶</a></h3>
60<dl class="class">
61<dt id="pyfact.fnames">
62<em class="property">class </em><tt class="descclassname">pyfact.</tt><tt class="descname">fnames</tt><big>(</big><em>specifier=['012', '023', '2011', '11', '24'], rpath='/scratch_nfs/res/bsl/', zipped=True</em><big>)</big><a class="headerlink" href="#pyfact.fnames" title="Permalink to this definition">¶</a></dt>
63<dd><p>organize file names of a FACT data run</p>
64<dl class="docutils">
65<dt>specifier <span class="classifier-delimiter">:</span> <span class="classifier">list of strings defined as:</span></dt>
66<dd>[ &#8216;DRS calibration file&#8217;, &#8216;Data file&#8217;, &#8216;YYYY&#8217;, &#8216;MM&#8217;, &#8216;DD&#8217;]</dd>
67</dl>
68<p>rpath : directory path for the results; YYYYMMDD will be appended to rpath
69zipped : use zipped (True) or unzipped (Data)</p>
70<dl class="method">
71<dt id="pyfact.fnames.info">
72<tt class="descname">info</tt><big>(</big><big>)</big><a class="headerlink" href="#pyfact.fnames.info" title="Permalink to this definition">¶</a></dt>
73<dd><p>print complete filenames</p>
74</dd></dl>
75
76<dl class="method">
77<dt id="pyfact.fnames.make">
78<tt class="descname">make</tt><big>(</big><em>specifier</em>, <em>rpath</em>, <em>zipped</em><big>)</big><a class="headerlink" href="#pyfact.fnames.make" title="Permalink to this definition">¶</a></dt>
79<dd><p>create (make) the filenames</p>
80<p>names : dictionary of filenames, tags { &#8216;data&#8217;, &#8216;drscal&#8217;, &#8216;results&#8217; }
81data : name of the data file
82drscal : name of the drs calibration file
83results : radikal of file name(s) for results (to be completed by suffixes)</p>
84</dd></dl>
85
86</dd></dl>
87
88</div>
89</div>
90<div class="section" id="fir-filter-functions">
91<h2>FIR filter functions<a class="headerlink" href="#fir-filter-functions" title="Permalink to this headline">¶</a></h2>
92</div>
93</div>
94
95
96 </div>
97 </div>
98 </div>
99 <div class="sphinxsidebar">
100 <div class="sphinxsidebarwrapper">
101 <h3><a href="index.html">Table Of Contents</a></h3>
102 <ul>
103<li><a class="reference internal" href="#">Classes</a><ul>
104<li><a class="reference internal" href="#pyfact-py">pyfact.py</a><ul>
105<li><a class="reference internal" href="#rawdata-access">rawdata access</a></li>
106<li><a class="reference internal" href="#fnames-of-a-data-run">fnames of a data run</a></li>
107</ul>
108</li>
109<li><a class="reference internal" href="#fir-filter-functions">FIR filter functions</a></li>
110</ul>
111</li>
112</ul>
113
114 <h4>Previous topic</h4>
115 <p class="topless"><a href="introduction.html"
116 title="previous chapter">Introduction</a></p>
117 <h4>Next topic</h4>
118 <p class="topless"><a href="examples.html"
119 title="next chapter">Examples</a></p>
120 <h3>This Page</h3>
121 <ul class="this-page-menu">
122 <li><a href="_sources/classes.txt"
123 rel="nofollow">Show Source</a></li>
124 </ul>
125<div id="searchbox" style="display: none">
126 <h3>Quick search</h3>
127 <form class="search" action="search.html" method="get">
128 <input type="text" name="q" size="18" />
129 <input type="submit" value="Go" />
130 <input type="hidden" name="check_keywords" value="yes" />
131 <input type="hidden" name="area" value="default" />
132 </form>
133 <p class="searchtip" style="font-size: 90%">
134 Enter search terms or a module, class or function name.
135 </p>
136</div>
137<script type="text/javascript">$('#searchbox').show(0);</script>
138 </div>
139 </div>
140 <div class="clearer"></div>
141 </div>
142 <div class="related">
143 <h3>Navigation</h3>
144 <ul>
145 <li class="right" style="margin-right: 10px">
146 <a href="genindex.html" title="General Index"
147 >index</a></li>
148 <li class="right" >
149 <a href="examples.html" title="Examples"
150 >next</a> |</li>
151 <li class="right" >
152 <a href="introduction.html" title="Introduction"
153 >previous</a> |</li>
154 <li><a href="index.html">pyfact v0.1 documentation</a> &raquo;</li>
155 </ul>
156 </div>
157 <div class="footer">
158 &copy; Copyright 2012, Werner Lustermann.
159 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.
160 </div>
161 </body>
162</html>
Note: See TracBrowser for help on using the repository browser.