/usr/share/doc/python-imexam-doc/html/imexam/current_capability.html is in python-imexam-doc 0.8.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>imexam User Methods — imexam v0.8.0</title>
<link rel="stylesheet" href="../_static/imexam.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../_static/imexam.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Convenience functions for DS9’s (XPA) commands" href="xpa_commands.html" />
<link rel="prev" title="The imexam() method" href="imexam_command.html" />
<link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600' rel='stylesheet' type='text/css'/>
<script type="text/javascript" src="../_static/copybutton.js"></script>
</head>
<body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="../index.html"><span id="logotext1">im</span><span id="logotext2">exam</span><span id="logotext3">:docs</span></a>
<ul>
<li><a class="homelink" title="Astropy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="../genindex.html">Index</a></li>
<li><a title="Module Index" href="../py-modindex.html">Modules</a></li>
<li>
<form action="../search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<a href="xpa_commands.html" title="Convenience functions for DS9’s (XPA) commands">
next »
</a>
</li>
<li class="right">
<a href="imexam_command.html" title="The imexam() method">
« previous
</a>
|
</li>
<li>
<a href="../index.html">imexam v0.8.0</a>
»
</li>
<li>imexam User Methods</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="imexam-user-methods">
<h1>imexam User Methods<a class="headerlink" href="#imexam-user-methods" title="Permalink to this headline">¶</a></h1>
<p>These are methods particular to the <code class="docutils literal"><span class="pre">imexam</span></code> package which are meant to aid users
in their image analysis. They are called from the main object you created
with imexam.connect().</p>
<p>At the top library level, the follow commands are available::</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">imexam</span><span class="o">.</span><span class="n">connect</span><span class="p">():</span> <span class="n">connect</span> <span class="n">to</span> <span class="n">a</span> <span class="n">viewer</span> <span class="ow">and</span> <span class="k">return</span> <span class="n">a</span> <span class="n">control</span> <span class="nb">object</span>
<span class="n">imexam</span><span class="o">.</span><span class="n">display_help</span><span class="p">():</span> <span class="n">Takes</span> <span class="n">you</span> <span class="n">to</span> <span class="n">the</span> <span class="n">help</span> <span class="n">documents</span> <span class="k">for</span> <span class="n">your</span> <span class="n">installed</span> <span class="n">version</span> <span class="n">of</span> <span class="n">imexam</span>
<span class="n">imexam</span><span class="o">.</span><span class="n">defpars</span><span class="p">:</span> <span class="n">contains</span> <span class="n">the</span> <span class="n">default</span> <span class="n">plotting</span> <span class="n">function</span> <span class="n">dictionaries</span>
<span class="n">imexam</span><span class="o">.</span><span class="n">imexamine</span><span class="p">:</span> <span class="n">this</span> <span class="k">class</span> <span class="nc">contains</span> <span class="n">the</span> <span class="n">plotting</span> <span class="n">functions</span> <span class="ow">and</span> <span class="n">can</span> <span class="n">be</span> <span class="n">instantiated</span> <span class="n">by</span> <span class="n">itself</span>
<span class="n">imexam</span><span class="o">.</span><span class="n">set_logging</span><span class="p">():</span> <span class="nb">set</span> <span class="n">the</span> <span class="n">logging</span> <span class="n">parameters</span> <span class="k">for</span> <span class="n">your</span> <span class="n">session</span><span class="o">.</span>
</pre></div>
</div>
<p>Each object has access to it’s own logging which can be edited using viewer.setlog()
The following will also be available for those not on a Windows system, where the XPA and DS9 are installed::</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">imexam</span><span class="o">.</span><span class="n">display_xpa_help</span><span class="p">():</span> <span class="n">Takes</span> <span class="n">you</span> <span class="n">to</span> <span class="n">the</span> <span class="n">XPA</span> <span class="n">help</span> <span class="n">page</span> <span class="k">for</span> <span class="n">DS9</span>
<span class="n">imexam</span><span class="o">.</span><span class="n">list_active_ds9</span><span class="p">():</span> <span class="n">returns</span> <span class="n">a</span> <span class="n">dictionary</span> <span class="n">of</span> <span class="n">available</span> <span class="n">DS9</span> <span class="n">sessions</span> <span class="k">for</span> <span class="n">connection</span>
</pre></div>
</div>
<p>You can always get the commands available to your local viewer by asking the
control object for them directly. If you called your control object “viewer” then the following example will return the list::</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">viewer</span><span class="o">.</span><span class="n">show_window_commands</span><span class="p">()</span> <span class="c1"># will return a list of available commands</span>
</pre></div>
</div>
<p>Not all viewers have all commands implemented, commands which are available
but not yet fully implemented should return an error to that affect.</p>
<dl class="docutils">
<dt><strong>alignwcs</strong>(on=True):</dt>
<dd><p class="first">Align the images in the viewer using the WCS in their headers</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">viewer</span><span class="o">.</span><span class="n">alignwcs</span><span class="p">()</span>
</pre></div>
</div>
</dd>
<dt><strong>blink</strong>(blink=True, interval=None):</dt>
<dd>For viewers with multiple frames, blink the images</dd>
<dt><strong>clear_contour</strong>():</dt>
<dd>Clear contours from the screen</dd>
<dt><strong>close</strong>():</dt>
<dd><p class="first">close the image viewing window and end the connection.</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">viewer</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
</dd>
<dt><strong>cmap</strong>(color=None, load=None, invert=False, save=False,filename=’colormap.ds9’):</dt>
<dd>Set the colormap for the window</dd>
<dt><strong>colorbar</strong>(on=True):</dt>
<dd>Turn the colorbar in the window on or off</dd>
<dt><strong>contour</strong>(on=True, construct=True):</dt>
<dd>Show contours in the window</dd>
<dt><strong>crosshair</strong>(x=None, y=None, coordsys=”physical”, skyframe=”wcs”, skyformat=”fk5”, match=False, lock=False):</dt>
<dd>Control the position of the crosshair in the current frame</dd>
<dt><strong>cursor</strong>(x=None, y=None):</dt>
<dd>Move the cursor in the window to the specified pixel location</dd>
<dt><strong>disp_header</strong>():</dt>
<dd>Display the image header</dd>
<dt><strong>frame</strong>(n=None):</dt>
<dd>Convenience function to change or report the frame</dd>
<dt><strong>get_data</strong>():</dt>
<dd>Return a numpy array of the data displayed in the current frame</dd>
<dt><strong>get_filename</strong>():</dt>
<dd><p class="first">Return the filename for the data in the current window</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">get_data_filename</span><span class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="s1">'/Users/sosey/ssb/imexam/iabf01bzq_flt.fits'</span>
</pre></div>
</div>
</dd>
<dt><strong>get_frame_info</strong>():</dt>
<dd><p class="first">Return more explicit information about the data displayed in the current
frame. A dictionary of the information is returned.</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">get_frame_info</span><span class="p">()</span>
<span class="p">{</span><span class="s1">'extname'</span><span class="p">:</span> <span class="s1">'SCI'</span><span class="p">,</span>
<span class="s1">'extver'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s1">'filename'</span><span class="p">:</span> <span class="s1">'/Users/sosey/ssb/imexam/iabf01bzq_flt.fits'</span><span class="p">,</span>
<span class="s1">'iscube'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s1">'mef'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s1">'naxis'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'numaxis'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s1">'user_array'</span><span class="p">:</span> <span class="kc">None</span><span class="p">}</span>
</pre></div>
</div>
</dd>
<dt><strong>get_header</strong>():</dt>
<dd>Return the header of the dataset in the current frame</dd>
<dt><strong>get_image</strong>():</dt>
<dd>Return the full image object for the data in the current frame</dd>
<dt><strong>get_slice_info</strong>():</dt>
<dd>Return the slice tuple for the image currently displayed</dd>
<dt><strong>get_viewer_info</strong>():</dt>
<dd><p class="first">Return a dictionary which contains information about all frames which have
data loaded. This could be useful to users who are scripting an analysis
for polling what items are available, how many frames or displayed, what
type of data is hanging around, etc …</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">get_viewer_info</span><span class="p">()</span>
<span class="p">{</span><span class="s1">'1'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'extname'</span><span class="p">:</span> <span class="s1">'SCI'</span><span class="p">,</span>
<span class="s1">'extver'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s1">'filename'</span><span class="p">:</span> <span class="s1">'/Users/sosey/ssb/imexam/iabf01bzq_flt.fits'</span><span class="p">,</span>
<span class="s1">'iscube'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s1">'mef'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s1">'naxis'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'numaxis'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s1">'user_array'</span><span class="p">:</span> <span class="kc">None</span><span class="p">}}</span>
</pre></div>
</div>
</dd>
<dt><strong>grab</strong>():</dt>
<dd>Take a snapshop of the image view</dd>
<dt><strong>grid</strong>(on=True, param=False):</dt>
<dd>Turn a grid on and off in the window</dd>
<dt><strong>hideme</strong>():</dt>
<dd>Reduce the precedence of the window</dd>
<dt><strong>iscube</strong>():</dt>
<dd>Boolean return if the image is multidimensional cube</dd>
<dt><strong>load_fits</strong>(fname=”“, extver=1, extname=None):</dt>
<dd>Load a fits image into the current frame</dd>
<dt><strong>load_mef_as_cube</strong>(filename=None):</dt>
<dd>Load a Mult-Extension-Fits image into one frame as an image cube</dd>
<dt><strong>load_mef_as_multi</strong>(filename=None):</dt>
<dd>Load a Mult-Extension-Fits image into multiple frames</dd>
<dt><strong>load_region</strong>(filename):</dt>
<dd>Load regions from a file which uses standard formatting</dd>
<dt><strong>load_rgb</strong>(red, green, blue, scale=False, lockwcs=False):</dt>
<dd>Load three images into an RGB colored frame</dd>
<dt><strong>make_region</strong>(infile,doLabels=False):</dt>
<dd><p class="first">Make an input reg file which contains rows with “x,y,comment” into a
region file that the DS9 viewer recognizes.</p>
<dl class="docutils">
<dt>infile: str</dt>
<dd>input filename</dd>
<dt>labels: bool</dt>
<dd>add labels to the regions</dd>
<dt>header: int</dt>
<dd>number of header lines in text file to skip</dd>
<dt>textoff: int</dt>
<dd>offset in pixels for labels</dd>
<dt>rtype: str</dt>
<dd>region type, one of the acceptable DS9 regions</dd>
<dt>size: int</dt>
<dd>size of the region type</dd>
</dl>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">Here</span><span class="s1">'s what the input file '</span><span class="n">test</span><span class="s1">' looks like:</span>
<span class="mi">100</span><span class="p">,</span><span class="mi">100</span><span class="p">,</span> <span class="mi">1</span>
<span class="mi">200</span><span class="p">,</span><span class="mi">200</span><span class="p">,</span> <span class="mi">2</span>
<span class="mi">300</span><span class="p">,</span><span class="mi">300</span><span class="p">,</span> <span class="n">comment</span> <span class="mi">3</span>
<span class="n">viewer</span><span class="o">.</span><span class="n">make_region</span><span class="p">(</span><span class="s1">'test'</span><span class="p">,</span><span class="n">labels</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">And</span> <span class="n">the</span> <span class="n">output</span> <span class="n">region</span> <span class="n">file</span><span class="p">:</span>
<span class="n">image</span><span class="p">;</span> <span class="n">circle</span><span class="p">(</span><span class="mi">100</span><span class="p">,</span><span class="mi">100</span><span class="p">,</span><span class="mi">5</span><span class="p">)</span>
<span class="n">image</span><span class="p">;</span><span class="n">text</span><span class="p">(</span><span class="mf">110.0</span><span class="p">,</span><span class="mf">110.0</span><span class="p">{</span> <span class="mi">1</span> <span class="p">})</span><span class="c1"># font="time 12 bold"</span>
<span class="n">image</span><span class="p">;</span> <span class="n">circle</span><span class="p">(</span><span class="mi">200</span><span class="p">,</span><span class="mi">200</span><span class="p">,</span><span class="mi">5</span><span class="p">)</span>
<span class="n">image</span><span class="p">;</span><span class="n">text</span><span class="p">(</span><span class="mf">210.0</span><span class="p">,</span><span class="mf">210.0</span><span class="p">{</span> <span class="mi">2</span> <span class="p">})</span><span class="c1"># font="time 12 bold"</span>
<span class="n">image</span><span class="p">;</span> <span class="n">circle</span><span class="p">(</span><span class="mi">300</span><span class="p">,</span><span class="mi">300</span><span class="p">,</span><span class="mi">5</span><span class="p">)</span>
<span class="n">image</span><span class="p">;</span><span class="n">text</span><span class="p">(</span><span class="mf">310.0</span><span class="p">,</span><span class="mf">310.0</span><span class="p">{</span> <span class="n">comment</span> <span class="mi">3</span> <span class="p">})</span><span class="c1"># font="time 12 bold"</span>
</pre></div>
</div>
</dd>
</dl>
<p>Now let’s load the region file into our image:</p>
<a class="reference internal image-reference" href="../_images/make_region.png"><img alt="image with regions plotted" src="../_images/make_region.png" style="width: 500px; height: 600px;" /></a>
<dl class="docutils">
<dt><strong>mark_region_from_array</strong>(input_points,rtype=”circle”,ptype=”image”,textoff=10,size=5):</dt>
<dd><p class="first">mark regions on the display given a list of tuples, a single tuple, or
a string, where each object has x,y,comment specified</p>
<dl class="docutils">
<dt>input_points: an iterable</dt>
<dd>contains: (x,y,comment) tuples</dd>
<dt>ptype: string</dt>
<dd>the reference system for the point locations, image|physical|fk5</dd>
<dt>rtype: string</dt>
<dd>the matplotlib style marker type to display</dd>
<dt>size: int</dt>
<dd>the size of the region marker</dd>
<dt>textoff: string</dt>
<dd>the offset for the comment text, if comment is empty it will not show</dd>
</dl>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">locations</span><span class="o">=</span><span class="nb">list</span><span class="p">()</span>
<span class="n">locations</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="mi">100</span><span class="p">,</span><span class="mi">100</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span> <span class="p">)</span>
<span class="n">locations</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="mi">200</span><span class="p">,</span><span class="mi">200</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span> <span class="p">)</span>
<span class="n">locations</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="mi">300</span><span class="p">,</span><span class="mi">300</span><span class="p">,</span><span class="s1">'comment 3'</span><span class="p">)</span> <span class="p">)</span>
<span class="n">viewer</span><span class="o">.</span><span class="n">mark_region_from_array</span><span class="p">(</span><span class="n">locations</span><span class="p">)</span>
</pre></div>
</div>
</dd>
</dl>
<a class="reference internal image-reference" href="../_images/mark_region.png"><img alt="image with regions plotted" src="../_images/mark_region.png" style="width: 500px; height: 600px;" /></a>
<dl class="docutils">
<dt><strong>match</strong>(coordsys=”wcs”, frame=True, crop=False, fslice=False,</dt>
<dd><blockquote class="first">
<div>scale=False, bin=False, colorbar=False, smooth=False,
crosshair=False):</div></blockquote>
<p class="last">Match all other frames to the current frame</p>
</dd>
<dt><strong>nancolor</strong>(color=’red’):</dt>
<dd>Set the not-a-number color</dd>
<dt><strong>panto_image</strong>(x, y):</dt>
<dd>Convenience function to change to x,y physical image coordinates</dd>
<dt><strong>panto_wcs</strong>(x, y, system=’fk5’):</dt>
<dd>Pan to the wcs location in the image</dd>
<dt><strong>readcursor</strong>():</dt>
<dd><p class="first">Returns image coordinate postion and key pressed as a tuple of the
for float(x), float(y), str(key).</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">readcursor</span><span class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="p">(</span><span class="mf">56.0</span><span class="p">,</span> <span class="mf">28.333333</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">)</span>
<span class="ow">or</span> <span class="k">with</span> <span class="n">a</span> <span class="n">click</span> <span class="n">of</span> <span class="n">the</span> <span class="n">first</span> <span class="n">mouse</span> <span class="n">button</span>
<span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">readcursor</span><span class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="p">(</span><span class="mf">67.333333</span><span class="p">,</span> <span class="mf">80.0</span><span class="p">,</span> <span class="s1">'<1>'</span><span class="p">)</span>
</pre></div>
</div>
</dd>
<dt><strong>reopen</strong>():</dt>
<dd>Reopen a closed viewing window, mostly used for ginga windows right now</dd>
<dt><strong>rotate</strong>(value=None, to=False):</dt>
<dd>Rotate the current frame (in degrees)</dd>
<dt><strong>save_regions</strong>(filename=None):</dt>
<dd>Save the regions currently displayed in the window to a regions file</dd>
<dt><strong>save_rgb</strong>(filename=None):</dt>
<dd>Save an rgbimage frame as an MEF fits file</dd>
<dt><strong>scale</strong>(scale=’zscale’):</dt>
<dd>Scale the pixel values in the window, zscale is the default</dd>
<dt><strong>set_region</strong>(region_string):</dt>
<dd>Use this to send the DS9 viewer a formatted region string it’s expecting</dd>
</dl>
<p>For example, in DS9:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">viewer</span><span class="o">.</span><span class="n">set_region</span><span class="p">(</span><span class="s2">"text 110.0 110.0 '1' #font=times"</span><span class="p">)</span>
<span class="n">See</span> <span class="n">the</span> <span class="n">DS9</span> <span class="n">XPA</span> <span class="n">documentation</span> <span class="k">for</span> <span class="n">more</span> <span class="n">examples</span><span class="o">.</span>
</pre></div>
</div>
<dl class="docutils">
<dt><strong>show_xpa_commands</strong>():</dt>
<dd>Print the available XPA commands (DS9 only)</dd>
<dt><strong>showme</strong>():</dt>
<dd>Raise the precedence of the viewing window</dd>
<dt><strong>showpix</strong>():</dt>
<dd>Display a pixel value table</dd>
<dt><strong>snapsave</strong>(filename=None, format=None, resolution=100):</dt>
<dd>Create a snapshot of the current window in the specified format</dd>
<dt><strong>valid_data_in_viewer</strong>():</dt>
<dd>Return bool if valid file or array is loaded into the viewer</dd>
<dt><strong>view</strong>(img, header=None, frame=None, asFits=False):</dt>
<dd><p class="first">Load an image array into the image viewing frame, if no frame is specified,
the current frame is used. If no frame exists, then a new one is created.
A basic header is created and sent to DS9. You can look at this header
with disp_header() but get_header() will return an error because it looks
for a filename, and no file was loaded, just the array.</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">image_array</span><span class="o">=</span><span class="n">fits</span><span class="o">.</span><span class="n">getdata</span><span class="p">(</span><span class="s1">'image.fits'</span><span class="p">)</span>
<span class="n">viewer</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="n">image_array</span><span class="p">)</span>
<span class="ow">or</span>
<span class="n">image_array</span><span class="o">=</span><span class="n">numpy</span><span class="o">.</span><span class="n">ones</span><span class="p">([</span><span class="mi">100</span><span class="p">,</span><span class="mi">100</span><span class="p">])</span><span class="o">*</span><span class="n">numpy</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>
<span class="n">viewer</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="n">image_array</span><span class="p">)</span>
</pre></div>
</div>
</dd>
<dt><strong>zoom</strong>(par=None):</dt>
<dd>Zoom using the specified command in par</dd>
<dt><strong>zoomtofit</strong>():</dt>
<dd>Zoom the image to fit the window</dd>
<dt><strong>setlog</strong>(self, filename=None, on=True, level=logging.DEBUG):</dt>
<dd><p class="first">Turn on and off <code class="docutils literal"><span class="pre">imexam</span></code> logging to the a file. You can set the filename to
something specific or let the package record to the default logfile.
Once you give the object a logfile name, it will continue to use that
file until you change it.</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span>In [5]: viewer.setlog()
Saving ``imexam`` commands to imexam_log.txt
</pre></div>
</div>
</dd>
</dl>
<p>This is what’s displayed in the terminal when you use imexam():</p>
<a class="reference internal image-reference" href="../_images/setlog1.png"><img alt="log information to terminal" src="../_images/setlog1.png" style="width: 600px; height: 500px;" /></a>
<p>and this is what shows up in the logfile:</p>
<a class="reference internal image-reference" href="../_images/setlog2.png"><img alt="log information to terminal" src="../_images/setlog2.png" style="width: 600px; height: 500px;" /></a>
<p>You can see there are some leftovers from a previous logging session to the
same file. You can toggle logging during a session too:</p>
<blockquote>
<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">viewer</span><span class="o">.</span><span class="n">setlog</span><span class="p">(</span><span class="n">on</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="c1">#and to turn off even messages to the screen:</span>
<span class="n">viewer</span><span class="o">.</span><span class="n">setlog</span><span class="p">(</span><span class="n">on</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span><span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">CRITICAL</span><span class="p">)</span>
</pre></div>
</div>
</div></blockquote>
<dl class="docutils">
<dt><strong>unlearn</strong>():</dt>
<dd>Reset all the <code class="docutils literal"><span class="pre">imexam</span></code> default function parameters</dd>
<dt><strong>plotname</strong>():</dt>
<dd><p class="first">change or show the default save plotname for imexamine</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">plotname</span><span class="p">()</span>
<span class="n">imexam_plot</span><span class="o">.</span><span class="n">pdf</span>
<span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">plotname</span><span class="p">(</span><span class="s1">'myplot.jpg'</span><span class="p">)</span>
<span class="n">In</span> <span class="p">[</span><span class="mi">3</span><span class="p">]:</span> <span class="n">viewer</span><span class="o">.</span><span class="n">plotname</span><span class="p">()</span>
<span class="n">myplot</span><span class="o">.</span><span class="n">jpg</span>
</pre></div>
</div>
</dd>
</dl>
<p>The extension of the filename controls the plot type.</p>
<dl class="docutils">
<dt><strong>display_help</strong>():</dt>
<dd><p class="first">Display the help documentation into a webpage from the locally installed
version. This is done from the main package:</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="kn">import</span> <span class="nn">imexam</span>
<span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="n">imexam</span><span class="o">.</span><span class="n">display_help</span><span class="p">()</span>
</pre></div>
</div>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/imexam_logo_trans.png" alt="Logo"/>
</a></p><h3>Page Contents</h3>
<ul>
<li><a class="reference internal" href="#">imexam User Methods</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="../_sources/imexam/current_capability.rst.txt"
rel="nofollow">Page Source</a>
<a href="#">Back to Top</a></p>
<p>
© Copyright 2017, Megan Sosey.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.5.
Last built 19 Dec 2017. <br/>
</p>
</footer>
</body>
</html>
|