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

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 4.6 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_inverse_binary">
103
104          <h2><a class="top" href="#container">top</a>inverse_binary </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>inverse_binary(<span class="result"><a href="#_inverse_binary_param_binnumb">binnumb</a></span>)</p>
108       
109          <div class="comments">
110 NAME: inverse_binary
111
112 PURPOSE: inverse function of the binary.pro function => given a
113 input array of 0/1, return its corresponding byte/integer/long
114 representation
115
116 CATEGORY:
117
118 CALLING SEQUENCE: res = inverse_binary(binnum)
119
120 INPUTS:
121    binnum must be a binary type array containing only 0 and 1.
122    According to binary.pro outputs, binnum array must have the
123    following dimensions values: (8, t, d1, d2...)
124    t gives the output type: t = 1 -> byte
125                             t = 2 -> integer
126                             t = 4 -> long
127   
128     (d1, d2...) are the output dimensions
129
130 KEYWORD PARAMETERS: no
131
132 OUTPUTS: a byte/integer/long array with (d1, d2...) dimensions
133
134 COMMON BLOCKS: no
135
136 RESTRICTIONS:the binary number can represent only byte/integer/long
137
138 EXAMPLE:
139
140     IDL> a=indgen(5)
141     IDL> b=binary(a)
142     IDL> help, b
143     B               BYTE      = Array[8, 2, 5]
144     IDL> print, b
145        0   0   0   0   0   0   0   0
146        0   0   0   0   0   0   0   0
147     
148        0   0   0   0   0   0   0   0
149        0   0   0   0   0   0   0   1
150     
151        0   0   0   0   0   0   0   0
152        0   0   0   0   0   0   1   0
153     
154        0   0   0   0   0   0   0   0
155        0   0   0   0   0   0   1   1
156     
157        0   0   0   0   0   0   0   0
158        0   0   0   0   0   1   0   0
159     IDL> help, inverse_binary(b)
160     <Expression>    INT       = Array[5]
161     IDL> print, inverse_binary(b)
162            0       1       2       3       4
163
164 MODIFICATION HISTORY:</div>
165
166         
167
168         
169            <h3>Parameters</h3>
170       
171           
172            <h4 id="_inverse_binary_param_binnumb">binnumb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173             
174             
175             
176             
177             
178             
179             
180             
181            </h4>
182       
183          <div class="comments"></div>
184           
185
186         
187
188         
189
190         
191         
192         
193         
194         
195         
196         
197         
198         
199         
200         
201         
202       
203         
204         
205         
206         
207         
208         
209         
210       
211         
212       
213        </div>
214       
215      </div>
216
217     
218
219      <div id="tagline">Produced by IDLdoc 2.0.</div>
220
221    </div>
222
223  </body>
224</html>
Note: See TracBrowser for help on using the repository browser.