halation 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +211 -0
- data/bin/halation +4 -1
- data/doc/Halation.html +14 -4
- data/doc/Halation/AttrHelpers.html +288 -0
- data/doc/Halation/Coerce.html +373 -0
- data/doc/Halation/Config.html +732 -0
- data/doc/Halation/Config/Camera.html +628 -0
- data/doc/Halation/Config/Lens.html +540 -0
- data/doc/Halation/Engine.html +928 -0
- data/doc/Halation/ExifToolImage.html +486 -0
- data/doc/Halation/Roll.html +916 -0
- data/doc/Halation/Roll/Frame.html +842 -0
- data/doc/Halation/Script.html +506 -0
- data/doc/_index.html +112 -1
- data/doc/class_list.html +1 -1
- data/doc/file.LICENSE.html +1 -1
- data/doc/file.README.html +211 -1
- data/doc/index.html +211 -1
- data/doc/method_list.html +432 -0
- data/doc/top-level-namespace.html +1 -1
- data/lib/halation.rb +4 -0
- data/lib/halation/coerce.rb +21 -0
- data/lib/halation/config.rb +53 -0
- data/lib/halation/config/camera.rb +42 -0
- data/lib/halation/config/lens.rb +32 -0
- data/lib/halation/engine.rb +91 -0
- data/lib/halation/roll.rb +57 -0
- data/lib/halation/roll/frame.rb +47 -0
- data/lib/halation/script.rb +150 -0
- data/lib/halation/tools/exif_tool/image.rb +33 -0
- data/lib/halation/version.rb +1 -1
- metadata +42 -3
|
@@ -0,0 +1,486 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Halation::ExifToolImage
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "Halation::ExifToolImage";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Halation.html" title="Halation (module)">Halation</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ExifToolImage</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame" src="../class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Class: Halation::ExifToolImage
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
<dl>
|
|
72
|
+
<dt>Inherits:</dt>
|
|
73
|
+
<dd>
|
|
74
|
+
<span class="inheritName">Object</span>
|
|
75
|
+
|
|
76
|
+
<ul class="fullTree">
|
|
77
|
+
<li>Object</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">Halation::ExifToolImage</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/halation/tools/exif_tool/image.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>Image interface implementation for ExifTool. Available as apt package
|
|
108
|
+
`libimage-exiftool-perl`.</p>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
<div class="tags">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<p class="tag_title">See Also:</p>
|
|
117
|
+
<ul class="see">
|
|
118
|
+
|
|
119
|
+
<li><a href="http://www.sno.phy.queensu.ca/~phil/exiftool/" target="_parent" title="http://www.sno.phy.queensu.ca/~phil/exiftool/">http://www.sno.phy.queensu.ca/~phil/exiftool/</a></li>
|
|
120
|
+
|
|
121
|
+
</ul>
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<h2>
|
|
132
|
+
Instance Method Summary
|
|
133
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
134
|
+
</h2>
|
|
135
|
+
|
|
136
|
+
<ul class="summary">
|
|
137
|
+
|
|
138
|
+
<li class="public ">
|
|
139
|
+
<span class="summary_signature">
|
|
140
|
+
|
|
141
|
+
<a href="#%5B%5D-instance_method" title="#[] (instance method)">#<strong>[]</strong>(tag) ⇒ Object </a>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</span>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<span class="summary_desc"><div class='inline'>
|
|
156
|
+
<p>Read an Exif tag.</p>
|
|
157
|
+
</div></span>
|
|
158
|
+
|
|
159
|
+
</li>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<li class="public ">
|
|
163
|
+
<span class="summary_signature">
|
|
164
|
+
|
|
165
|
+
<a href="#%5B%5D%3D-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(tag, value) ⇒ Object </a>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</span>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<span class="summary_desc"><div class='inline'>
|
|
180
|
+
<p>Write an Exif tag.</p>
|
|
181
|
+
</div></span>
|
|
182
|
+
|
|
183
|
+
</li>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<li class="public ">
|
|
187
|
+
<span class="summary_signature">
|
|
188
|
+
|
|
189
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(file_path) ⇒ ExifToolImage </a>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
</span>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<span class="note title constructor">constructor</span>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<span class="summary_desc"><div class='inline'>
|
|
206
|
+
<p>A new instance of ExifToolImage.</p>
|
|
207
|
+
</div></span>
|
|
208
|
+
|
|
209
|
+
</li>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<li class="public ">
|
|
213
|
+
<span class="summary_signature">
|
|
214
|
+
|
|
215
|
+
<a href="#save-instance_method" title="#save (instance method)">#<strong>save</strong> ⇒ Object </a>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
</span>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<span class="summary_desc"><div class='inline'>
|
|
230
|
+
<p>Save the Exif data to the image file.</p>
|
|
231
|
+
</div></span>
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</ul>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<div id="constructor_details" class="method_details_list">
|
|
240
|
+
<h2>Constructor Details</h2>
|
|
241
|
+
|
|
242
|
+
<div class="method_details first">
|
|
243
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
244
|
+
|
|
245
|
+
#<strong>initialize</strong>(file_path) ⇒ <tt><span class='object_link'><a href="" title="Halation::ExifToolImage (class)">ExifToolImage</a></span></tt>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</h3><div class="docstring">
|
|
252
|
+
<div class="discussion">
|
|
253
|
+
|
|
254
|
+
<p>Returns a new instance of ExifToolImage</p>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</div>
|
|
258
|
+
</div>
|
|
259
|
+
<div class="tags">
|
|
260
|
+
<p class="tag_title">Parameters:</p>
|
|
261
|
+
<ul class="param">
|
|
262
|
+
|
|
263
|
+
<li>
|
|
264
|
+
|
|
265
|
+
<span class='name'>file_path</span>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
—
|
|
273
|
+
<div class='inline'>
|
|
274
|
+
<p>Path to the image file.</p>
|
|
275
|
+
</div>
|
|
276
|
+
|
|
277
|
+
</li>
|
|
278
|
+
|
|
279
|
+
</ul>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
</div><table class="source_code">
|
|
283
|
+
<tr>
|
|
284
|
+
<td>
|
|
285
|
+
<pre class="lines">
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
10
|
|
289
|
+
11
|
|
290
|
+
12</pre>
|
|
291
|
+
</td>
|
|
292
|
+
<td>
|
|
293
|
+
<pre class="code"><span class="info file"># File 'lib/halation/tools/exif_tool/image.rb', line 10</span>
|
|
294
|
+
|
|
295
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span>
|
|
296
|
+
<span class='ivar'>@image</span> <span class='op'>=</span> <span class='const'>MiniExiftool</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='comma'>,</span> <span class='label'>numerical:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
297
|
+
<span class='kw'>end</span></pre>
|
|
298
|
+
</td>
|
|
299
|
+
</tr>
|
|
300
|
+
</table>
|
|
301
|
+
</div>
|
|
302
|
+
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<div id="instance_method_details" class="method_details_list">
|
|
307
|
+
<h2>Instance Method Details</h2>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<div class="method_details first">
|
|
311
|
+
<h3 class="signature first" id="[]-instance_method">
|
|
312
|
+
|
|
313
|
+
#<strong>[]</strong>(tag) ⇒ <tt>Object</tt>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
</h3><div class="docstring">
|
|
320
|
+
<div class="discussion">
|
|
321
|
+
|
|
322
|
+
<p>Read an Exif tag.</p>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</div>
|
|
326
|
+
</div>
|
|
327
|
+
<div class="tags">
|
|
328
|
+
<p class="tag_title">Parameters:</p>
|
|
329
|
+
<ul class="param">
|
|
330
|
+
|
|
331
|
+
<li>
|
|
332
|
+
|
|
333
|
+
<span class='name'>tag</span>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</li>
|
|
341
|
+
|
|
342
|
+
</ul>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
</div><table class="source_code">
|
|
346
|
+
<tr>
|
|
347
|
+
<td>
|
|
348
|
+
<pre class="lines">
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
16
|
|
352
|
+
17
|
|
353
|
+
18</pre>
|
|
354
|
+
</td>
|
|
355
|
+
<td>
|
|
356
|
+
<pre class="code"><span class="info file"># File 'lib/halation/tools/exif_tool/image.rb', line 16</span>
|
|
357
|
+
|
|
358
|
+
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='rparen'>)</span>
|
|
359
|
+
<span class='ivar'>@image</span><span class='lbracket'>[</span><span class='id identifier rubyid_tag'>tag</span><span class='rbracket'>]</span>
|
|
360
|
+
<span class='kw'>end</span></pre>
|
|
361
|
+
</td>
|
|
362
|
+
</tr>
|
|
363
|
+
</table>
|
|
364
|
+
</div>
|
|
365
|
+
|
|
366
|
+
<div class="method_details ">
|
|
367
|
+
<h3 class="signature " id="[]=-instance_method">
|
|
368
|
+
|
|
369
|
+
#<strong>[]=</strong>(tag, value) ⇒ <tt>Object</tt>
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</h3><div class="docstring">
|
|
376
|
+
<div class="discussion">
|
|
377
|
+
|
|
378
|
+
<p>Write an Exif tag.</p>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
</div>
|
|
382
|
+
</div>
|
|
383
|
+
<div class="tags">
|
|
384
|
+
<p class="tag_title">Parameters:</p>
|
|
385
|
+
<ul class="param">
|
|
386
|
+
|
|
387
|
+
<li>
|
|
388
|
+
|
|
389
|
+
<span class='name'>tag</span>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
<li>
|
|
399
|
+
|
|
400
|
+
<span class='name'>value</span>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
</li>
|
|
408
|
+
|
|
409
|
+
</ul>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
</div><table class="source_code">
|
|
413
|
+
<tr>
|
|
414
|
+
<td>
|
|
415
|
+
<pre class="lines">
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
23
|
|
419
|
+
24
|
|
420
|
+
25</pre>
|
|
421
|
+
</td>
|
|
422
|
+
<td>
|
|
423
|
+
<pre class="code"><span class="info file"># File 'lib/halation/tools/exif_tool/image.rb', line 23</span>
|
|
424
|
+
|
|
425
|
+
<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
|
426
|
+
<span class='ivar'>@image</span><span class='lbracket'>[</span><span class='id identifier rubyid_tag'>tag</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
|
|
427
|
+
<span class='kw'>end</span></pre>
|
|
428
|
+
</td>
|
|
429
|
+
</tr>
|
|
430
|
+
</table>
|
|
431
|
+
</div>
|
|
432
|
+
|
|
433
|
+
<div class="method_details ">
|
|
434
|
+
<h3 class="signature " id="save-instance_method">
|
|
435
|
+
|
|
436
|
+
#<strong>save</strong> ⇒ <tt>Object</tt>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
</h3><div class="docstring">
|
|
443
|
+
<div class="discussion">
|
|
444
|
+
|
|
445
|
+
<p>Save the Exif data to the image file.</p>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
</div>
|
|
449
|
+
</div>
|
|
450
|
+
<div class="tags">
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
</div><table class="source_code">
|
|
454
|
+
<tr>
|
|
455
|
+
<td>
|
|
456
|
+
<pre class="lines">
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
28
|
|
460
|
+
29
|
|
461
|
+
30</pre>
|
|
462
|
+
</td>
|
|
463
|
+
<td>
|
|
464
|
+
<pre class="code"><span class="info file"># File 'lib/halation/tools/exif_tool/image.rb', line 28</span>
|
|
465
|
+
|
|
466
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_save'>save</span>
|
|
467
|
+
<span class='ivar'>@image</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
|
468
|
+
<span class='kw'>end</span></pre>
|
|
469
|
+
</td>
|
|
470
|
+
</tr>
|
|
471
|
+
</table>
|
|
472
|
+
</div>
|
|
473
|
+
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
</div>
|
|
477
|
+
|
|
478
|
+
<div id="footer">
|
|
479
|
+
Generated on Sat May 28 22:28:57 2016 by
|
|
480
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
481
|
+
0.8.7.6 (ruby-2.1.7).
|
|
482
|
+
</div>
|
|
483
|
+
|
|
484
|
+
</div>
|
|
485
|
+
</body>
|
|
486
|
+
</html>
|