source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/LECTURE/inverse_binary.html @ 187

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

introducing hyperlinks in idldoc outputs (2/2)
File size: 3.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>inverse_binary.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="changeread.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="litchamp.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/LECTURE/</font></h1>
58    <h2>inverse_binary.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Inverse function of the binary.pro function => given a
65 input array of 0/1, return its corresponding byte/integer/long
66 representation
67
68
69   
70
71     
72      <a name="#_inverse_binary"></a>
73
74      <h2>inverse_binary  <font size="-1" color="#006633">
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>inverse_binary(<i><a href="#_inverse_binary_keyword_binnumb">binnumb</a></i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3> 
83 A byte/integer/long array with (d1, d2...) dimensions
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_inverse_binary_keyword_binnumb"></a>
91    <h4>binnumb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97     
98     
99     
100    </h4>
101
102   
103 Must be a binary type array containing only 0 and 1.
104 According to binary.pro outputs, binnum array must have the
105 following dimensions values: (8, t, d1, d2...)
106 t gives the output type: t = 1 -> byte
107                             t = 2 -> integer
108                             t = 4 -> long
109   
110  (d1, d2...) are the output dimensions
111
112
113   
114   
115
116   
117
118    <h3>Examples</h3>
119
120     IDL> a=indgen(5)
121     IDL> b=binary(a)
122     IDL> help, b
123     B               BYTE      = Array[8, 2, 5]
124     IDL> print, b
125        0   0   0   0   0   0   0   0
126        0   0   0   0   0   0   0   0
127     
128        0   0   0   0   0   0   0   0
129        0   0   0   0   0   0   0   1
130     
131        0   0   0   0   0   0   0   0
132        0   0   0   0   0   0   1   0
133     
134        0   0   0   0   0   0   0   0
135        0   0   0   0   0   0   1   1
136     
137        0   0   0   0   0   0   0   0
138        0   0   0   0   0   1   0   0
139     IDL> help, inverse_binary(b)
140     <Expression>    INT       = Array[5]
141     IDL> print, inverse_binary(b)
142            0       1       2       3       4
143
144    <h3>Version history</h3>
145   
146    <h4>Version</h4>
147 $Id: inverse_binary.pro 157 2006-08-21 09:01:50Z navarro $
148
149    <h4>History</h4>
150      Sebastien Masson (smasson@jamstec.go.jp)
151      July 2004
152
153   
154
155    <h3>Known issues</h3>
156   
157   
158   
159    <h4>Restrictions</h4>
160 The binary number can represent only byte/integer/long
161
162
163   
164   
165   
166   
167   
168   
169   
170
171    <font size="-3"><p>&nbsp;</p></font>
172    <hr size="1" color="#CCCCCC"/>
173     
174
175   
176
177    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
178
179  </body>
180</html>
Note: See TracBrowser for help on using the repository browser.