source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/inverse_binary.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.2 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>inverse_binary.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="inverse_binary.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/LECTURE//inverse_binary.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="changeread.html">&lt;&lt;prev file</a> | <a href="litchamp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="inverse_binary.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/LECTURE/</a></h1>
82      <h2 class="pro_file">inverse_binary.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Inverse function of the <a href="../..//ToBeReviewed/LECTURE/binary.html">binary</a> function => given a
91 input array of 0/1, return its corresponding byte/integer/long
92 representation
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_inverse_binary">
107
108          <h2><a class="top" href="#container">top</a>inverse_binary <span class="categories">
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>inverse_binary(<span class="result"><a href="#_inverse_binary_param_binnumb">binnumb</a></span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 A byte/integer/long array with (d1, d2...) dimensions
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_inverse_binary_param_binnumb">binnumb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 Must be a binary type array containing only 0 and 1.
138 According to <a href="../..//ToBeReviewed/LECTURE/binary.html">binary</a> outputs, binnum array must have the
139 following dimensions values: (8, t, d1, d2...)
140 t gives the output type: t = 1 -> byte
141                             t = 2 -> integer
142                             t = 4 -> long
143
144  (d1, d2...) are the output dimensions
145
146</div>
147           
148
149         
150
151         
152
153          <h3>Examples</h3><div class="preformat">
154
155     IDL> a=indgen(5)
156     IDL> b=binary(a)
157     IDL> help, b
158     B               BYTE      = Array[8, 2, 5]
159     IDL> print, b
160        0   0   0   0   0   0   0   0
161        0   0   0   0   0   0   0   0
162
163        0   0   0   0   0   0   0   0
164        0   0   0   0   0   0   0   1
165
166        0   0   0   0   0   0   0   0
167        0   0   0   0   0   0   1   0
168
169        0   0   0   0   0   0   0   0
170        0   0   0   0   0   0   1   1
171
172        0   0   0   0   0   0   0   0
173        0   0   0   0   0   1   0   0
174     IDL> help, inverse_binary(b)
175     <Expression>    INT       = Array[5]
176     IDL> print, inverse_binary(b)
177            0       1       2       3       4
178</div>
179          <h3>Version history</h3>
180         
181          <h4>Version</h4><div class="preformat">
182 $Id: inverse_binary.pro 325 2007-12-06 10:04:53Z pinsard $
183</div>
184          <h4>History</h4><div class="preformat">
185      Sebastien Masson (smasson@jamstec.go.jp)
186      July 2004
187</div>
188         
189         
190          <h3>Known issues</h3>
191         
192         
193         
194          <h4>Restrictions</h4><div class="preformat">
195 The binary number can represent only byte/integer/long
196</div>
197       
198         
199         
200         
201         
202         
203         
204         
205       
206          <h3>Statistics</h3>
207          <table class="statistics">
208            <tr><td>McCabe cyclic</td><td>           9</td></tr>
209            <tr><td>McCabe essential</td><td>           1</td></tr>
210            <tr><td>McCabe modular design</td><td>           1</td></tr>
211          </table>
212         
213       
214        </div>
215       
216      </div>
217
218     
219
220      <div id="tagline">Produced by IDLdoc 2.0.</div>
221
222    </div>
223
224  </body>
225</html>
Note: See TracBrowser for help on using the repository browser.