-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpythia.applications.base.html
785 lines (705 loc) · 73.6 KB
/
pythia.applications.base.html
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
<!doctype html>
<html class="no-js" lang="en">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="pythia.applications.command_line" href="pythia.applications.command_line.html" /><link rel="prev" title="pythia.applications.annotation" href="pythia.applications.annotation.html" />
<link rel="shortcut icon" href="_static/logo.png"/><meta name="generator" content="sphinx-5.1.1, furo 2022.06.21"/>
<title>pythia.applications.base - pythia 1.3.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">pythia 1.3.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>
<span class="sidebar-brand-text">pythia 1.3.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README_.html">pythia README</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/index.html">Code examples</a></li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="modules.html">API Documentation</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l2 current has-children"><a class="reference internal" href="pythia.html">pythia package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l3 current has-children"><a class="reference internal" href="pythia.applications.html">pythia.applications package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="pythia.applications.annotation.html">pythia.applications.annotation</a></li>
<li class="toctree-l4 current current-page"><a class="current reference internal" href="#">pythia.applications.base</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.applications.command_line.html">pythia.applications.command_line</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.applications.demo.html">pythia.applications.demo</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="pythia.cli.html">pythia.cli package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="pythia.cli.app.html">pythia.cli.app</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="pythia.event_stream.html">pythia.event_stream package</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="pythia.event_stream.base.html">pythia.event_stream.base</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.event_stream.kafka.html">pythia.event_stream.kafka</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.event_stream.log.html">pythia.event_stream.log</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.event_stream.memory.html">pythia.event_stream.memory</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.event_stream.redis.html">pythia.event_stream.redis</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="pythia.models.html">pythia.models package</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="pythia.models.base.html">pythia.models.base</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="pythia.pipelines.html">pythia.pipelines package</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="pythia.pipelines.base.html">pythia.pipelines.base</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="pythia.utils.html">pythia.utils package</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="pythia.utils.ds.html">pythia.utils.ds</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.utils.ext.html">pythia.utils.ext</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.utils.gst.html">pythia.utils.gst</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.utils.maskrcnn.html">pythia.utils.maskrcnn</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.utils.message_handlers.html">pythia.utils.message_handlers</a></li>
<li class="toctree-l4"><a class="reference internal" href="pythia.utils.str2pythia.html">pythia.utils.str2pythia</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pythia.config.html">pythia.config</a></li>
<li class="toctree-l3"><a class="reference internal" href="pythia.exceptions.html">pythia.exceptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="pythia.iterators.html">pythia.iterators</a></li>
<li class="toctree-l3"><a class="reference internal" href="pythia.paths.html">pythia.paths</a></li>
<li class="toctree-l3"><a class="reference internal" href="pythia.types.html">pythia.types</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="development.html">Developers corner</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="development/pytest_.html">Pytest</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/coverage.html">Coverage</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="module-pythia.applications.base">
<span id="pythia-applications-base"></span><h1>pythia.applications.base<a class="headerlink" href="#module-pythia.applications.base" title="Permalink to this heading">#</a></h1>
<p>Application.</p>
<p>An application is composed of (at least) a pipeline. It implements two logics:</p>
<blockquote>
<div><p>State management: Start/Stop/Play/Pause of the pipeline.
Bus Call</p>
</div></blockquote>
<dl class="py class">
<dt class="sig sig-object py" id="pythia.applications.base.Application">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">Application</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pythia.pipelines.base.html#pythia.pipelines.base.BasePipeline" title="pythia.pipelines.base.BasePipeline"><span class="pre">BasePipeline</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#Application"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.Application" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pythia.applications.base.BaseApplication" title="pythia.applications.base.BaseApplication"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseApplication</span></code></a></p>
<p>Typical pythia application.</p>
<p>Construct an application from a pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pipeline</strong> – an instantiated <cite>Pipeline</cite>.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.Application.on_message_eos">
<span class="sig-name descname"><span class="pre">on_message_eos</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Bus</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pythia.applications.base.Application.on_message_eos" title="Permalink to this definition">#</a></dt>
<dd><p>Stop application on EOS event.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – A stoppable instance.</p></li>
<li><p><strong>bus</strong> – The application’s pipeline’s bus.</p></li>
<li><p><strong>message</strong> – The gstreamer state change message.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.Application.on_message_error">
<span class="sig-name descname"><span class="pre">on_message_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Bus</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pythia.applications.base.Application.on_message_error" title="Permalink to this definition">#</a></dt>
<dd><p>Stop application on error.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – A stoppable instance.</p></li>
<li><p><strong>bus</strong> – The application’s pipeline’s bus.</p></li>
<li><p><strong>message</strong> – The gstreamer error message.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Error and debug string.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pythia.applications.base.BackgroundThreadLoop">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">BackgroundThreadLoop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loop</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pythia.types.html#pythia.types.Loop" title="pythia.types.Loop"><span class="pre">Loop</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#BackgroundThreadLoop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BackgroundThreadLoop" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Thread</span></code>, <a class="reference internal" href="#pythia.applications.base.RunLoop" title="pythia.applications.base.RunLoop"><code class="xref py py-class docutils literal notranslate"><span class="pre">RunLoop</span></code></a></p>
<p>Simple thread to run a loop without blocking.</p>
<p>Initialize a background thread to run the loop in.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>args</strong> – Forwarded to thread constructor.</p></li>
<li><p><strong>loop</strong> – the loop to run. If not set, uses
<code class="xref py py-class docutils literal notranslate"><span class="pre">GLib.MainLoop</span></code></p></li>
<li><p><strong>kwargs</strong> – Forwarded to thread constructor.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BackgroundThreadLoop.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loop</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pythia.types.html#pythia.types.Loop" title="pythia.types.Loop"><span class="pre">Loop</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#BackgroundThreadLoop.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BackgroundThreadLoop.__init__" title="Permalink to this definition">#</a></dt>
<dd><p>Initialize a background thread to run the loop in.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>args</strong> – Forwarded to thread constructor.</p></li>
<li><p><strong>loop</strong> – the loop to run. If not set, uses
<code class="xref py py-class docutils literal notranslate"><span class="pre">GLib.MainLoop</span></code></p></li>
<li><p><strong>kwargs</strong> – Forwarded to thread constructor.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pythia.applications.base.BackgroundThreadLoop._abc_impl">
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc_data</span> <span class="pre">object></span></em><a class="headerlink" href="#pythia.applications.base.BackgroundThreadLoop._abc_impl" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pythia.applications.base.BackgroundThreadLoop._is_protocol">
<span class="sig-name descname"><span class="pre">_is_protocol</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#pythia.applications.base.BackgroundThreadLoop._is_protocol" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BackgroundThreadLoop.quit">
<span class="sig-name descname"><span class="pre">quit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BackgroundThreadLoop.quit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BackgroundThreadLoop.quit" title="Permalink to this definition">#</a></dt>
<dd><p>Quit the running loop.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BackgroundThreadLoop.run">
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BackgroundThreadLoop.run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BackgroundThreadLoop.run" title="Permalink to this definition">#</a></dt>
<dd><p>Run and block running the loop.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">BaseApplication</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pythia.pipelines.base.html#pythia.pipelines.base.BasePipeline" title="pythia.pipelines.base.BasePipeline"><span class="pre">BasePipeline</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Base pythia application to reduce boilerplate.</p>
<p>You can define pipeline message handlers and they will be called
when pertinent. For example, by defining a method called
‘on_message_error’, pythia will connect said method as a signal
handler for the ‘message::eos’ detailed signal. Only values from
<cite>Gst.MessageType</cite> are allowed, see
<a class="reference external" href="http://lazka.github.io/pgi-docs/index.html#Gst-1.0/flags">http://lazka.github.io/pgi-docs/index.html#Gst-1.0/flags</a>.html#Gst.MessageType</p>
<p>Construct an application from a pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pipeline</strong> – an instantiated <cite>Pipeline</cite>.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pythia.pipelines.base.html#pythia.pipelines.base.BasePipeline" title="pythia.pipelines.base.BasePipeline"><span class="pre">BasePipeline</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.__init__" title="Permalink to this definition">#</a></dt>
<dd><p>Construct an application from a pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>pipeline</strong> – an instantiated <cite>Pipeline</cite>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication._before_pipeline_start">
<span class="sig-name descname"><span class="pre">_before_pipeline_start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#pythia.applications.base.RunLoop" title="pythia.applications.base.RunLoop"><span class="pre">RunLoop</span></a></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication._before_pipeline_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication._before_pipeline_start" title="Permalink to this definition">#</a></dt>
<dd><p>Call hook - run before pipeline start.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>loop</strong> – the loop to run.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A thread running the background loop.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication._build_message_handlers">
<span class="sig-name descname"><span class="pre">_build_message_handlers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">BA</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Bus</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Message</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication._build_message_handlers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication._build_message_handlers" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.after_pipeline_start">
<span class="sig-name descname"><span class="pre">after_pipeline_start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.after_pipeline_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.after_pipeline_start" title="Permalink to this definition">#</a></dt>
<dd><p>Call hook - run after pipeline start.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.backend">
<span class="sig-name descname"><span class="pre">backend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pad_direction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'sink'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'src'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="pythia.event_stream.base.html#pythia.event_stream.base.Backend" title="pythia.event_stream.base.Backend"><span class="pre">Backend</span></a></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.backend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.backend" title="Permalink to this definition">#</a></dt>
<dd><p>Retrieve a backend for a registered generator probe.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>element_name</strong> – Gstreamer element name the probe is registered
to.</p></li>
<li><p><strong>pad_direction</strong> – The element’s pad direction where the buffer
probe is attached.</p></li>
<li><p><strong>idx</strong> – position in the registry array for the specified pad.
As the most usual case a pad will have a single buffer
probe, if this value is not set it defaults to <cite>0</cite>,
meaning the signle element in the list is retrieved.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="simple">
<dt>The backend associated with the generator probe. The backend</dt><dd><p>is in charge of posting the messages from the generator
probe to an external service.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.before_loop_join">
<span class="sig-name descname"><span class="pre">before_loop_join</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.before_loop_join"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.before_loop_join" title="Permalink to this definition">#</a></dt>
<dd><p>Call hook - run before calling <cite>loop.join</cite>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.before_loop_quit">
<span class="sig-name descname"><span class="pre">before_loop_quit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.before_loop_quit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.before_loop_quit" title="Permalink to this definition">#</a></dt>
<dd><p>Call hook - run before calling <cite>loop.quit</cite>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.before_pipeline_start">
<span class="sig-name descname"><span class="pre">before_pipeline_start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.before_pipeline_start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.before_pipeline_start" title="Permalink to this definition">#</a></dt>
<dd><p>Custom call hook - run before pipeline start.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.bus">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Bus</span></em><a class="headerlink" href="#pythia.applications.base.BaseApplication.bus" title="Permalink to this definition">#</a></dt>
<dd><p>Get pipeline bus - lazy property.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The pipeline’s bus.</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>RuntimeError</strong> – Unable to get bus from pipeline.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.connect_bus">
<span class="sig-name descname"><span class="pre">connect_bus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.connect_bus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.connect_bus" title="Permalink to this definition">#</a></dt>
<dd><p>Attach bus signal watch depending on the message type.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.disconnect_bus">
<span class="sig-name descname"><span class="pre">disconnect_bus</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.disconnect_bus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.disconnect_bus" title="Permalink to this definition">#</a></dt>
<dd><p>Dettach bus signal watch.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.from_pipeline_file">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_pipeline_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">BA</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.from_pipeline_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.from_pipeline_file" title="Permalink to this definition">#</a></dt>
<dd><p>Factory from pipeline file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pipeline_file</strong> – the string to use to generate the pipeline.</p></li>
<li><p><strong>params</strong> – Parameters to format the pipeline.</p></li>
<li><p><strong>args</strong> – Forwarded to <a class="reference internal" href="#pythia.applications.base.BaseApplication.from_pipeline_file" title="pythia.applications.base.BaseApplication.from_pipeline_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">from_pipeline_file()</span></code></a> factory.</p></li>
<li><p><strong>kwargs</strong> – Forwarded to <a class="reference internal" href="#pythia.applications.base.BaseApplication.from_pipeline_file" title="pythia.applications.base.BaseApplication.from_pipeline_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">from_pipeline_file()</span></code></a> factory.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The instantiated app.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.from_pipeline_string">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_pipeline_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extractors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Probes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">BA</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.from_pipeline_string"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.from_pipeline_string" title="Permalink to this definition">#</a></dt>
<dd><p>Factory from pipeline string.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pipeline</strong> – the string to use to generate the pipeline.</p></li>
<li><p><strong>extractors</strong> – buffer probes to inject to the pipeline.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The instantiated app.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.inject_probes">
<span class="sig-name descname"><span class="pre">inject_probes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extractors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'sink'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'src'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.inject_probes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.inject_probes" title="Permalink to this definition">#</a></dt>
<dd><p>Register several probes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>extractors</strong> – mapping containing a collection of probes
(callbacks) assigned to their respective element’s
source (or sink) pad.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.loop_cls">
<span class="sig-name descname"><span class="pre">loop_cls</span></span><a class="headerlink" href="#pythia.applications.base.BaseApplication.loop_cls" title="Permalink to this definition">#</a></dt>
<dd><p>alias of <a class="reference internal" href="#pythia.applications.base.BackgroundThreadLoop" title="pythia.applications.base.BackgroundThreadLoop"><code class="xref py py-class docutils literal notranslate"><span class="pre">BackgroundThreadLoop</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.probe">
<span class="sig-name descname"><span class="pre">probe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">element_name:</span> <span class="pre">str,</span> <span class="pre">pad_direction:</span> <span class="pre">~typing.Literal['sink',</span> <span class="pre">'src'],</span> <span class="pre">*probe_args,</span> <span class="pre">pad_probe_type:</span> <span class="pre">~gi.repository.Gst.PadProbeType</span> <span class="pre">=</span> <span class="pre"><flags</span> <span class="pre">GST_PAD_PROBE_TYPE_BUFFER</span> <span class="pre">of</span> <span class="pre">type</span> <span class="pre">Gst.PadProbeType>,</span> <span class="pre">backend_uri:</span> <span class="pre">~typing.Optional[str]</span> <span class="pre">=</span> <span class="pre">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.probe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.probe" title="Permalink to this definition">#</a></dt>
<dd><p>Register function as a probe callback.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>element_name</strong> – Name of the <cite>Gst.Element</cite> to attach the probe
to.</p></li>
<li><p><strong>pad_direction</strong> – : Direction of the <cite>Gst.Pad</cite> to attach the
probe to.</p></li>
<li><p><strong>probe_args</strong> – Optional additional args - forwarded to the
decorated callback as varargs.</p></li>
<li><p><strong>pad_probe_type</strong> – Buffer probe type.</p></li>
<li><p><strong>backend_uri</strong> – If set, used to send messages from the probe to
this remote backend. Only used (and mandatory in that
case) when he callable to decorate is a generator.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="simple">
<dt>decorated callback, registered as an application buffer</dt><dd><p>probe.</p>
</dd>
</dl>
</p>
</dd>
</dl>
<p>This method has two usages: to decorate proper buffer probes,
where the developer is in charge of handling the data, and to
decorate a generator which yields incoming data. In the latter a
‘backend_uri’ is required and used to connect and send any and
all generated data into the remote service.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.BaseApplication.stop">
<span class="sig-name descname"><span class="pre">stop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#BaseApplication.stop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.BaseApplication.stop" title="Permalink to this definition">#</a></dt>
<dd><p>Stop application execution.</p>
<p>A loop must be running, and it is stopped as well.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>RuntimeError</strong> – no loop set.</p></li>
<li><p><strong>RuntimeError</strong> – unabl to stop loop.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pythia.applications.base.BoundGstPadProbeCallback">
<span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">BoundGstPadProbeCallback</span></span><a class="headerlink" href="#pythia.applications.base.BoundGstPadProbeCallback" title="Permalink to this definition">#</a></dt>
<dd><p>Gstreamer PadProbe must implement this protocol.</p>
<p>Using upstream ‘Gst.PadProbeCallback’ raises NotImplementedError.</p>
<p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code>[[<code class="xref py py-obj docutils literal notranslate"><span class="pre">BA</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Pad</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">PadProbeInfo</span></code>], <code class="xref py py-class docutils literal notranslate"><span class="pre">PadProbeReturn</span></code>]</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">ForegroundLoop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pythia.types.html#pythia.types.Loop" title="pythia.types.Loop"><span class="pre">Loop</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#ForegroundLoop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.ForegroundLoop" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pythia.applications.base.RunLoop" title="pythia.applications.base.RunLoop"><code class="xref py py-class docutils literal notranslate"><span class="pre">RunLoop</span></code></a></p>
<p>Simple Loop wrapper implementation to run a blocking loop.</p>
<p>Initialize a foreground glib loop.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>loop</strong> – the loop to run. If not set, uses
<code class="xref py py-class docutils literal notranslate"><span class="pre">GLib.MainLoop</span></code></p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pythia.types.html#pythia.types.Loop" title="pythia.types.Loop"><span class="pre">Loop</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#ForegroundLoop.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.ForegroundLoop.__init__" title="Permalink to this definition">#</a></dt>
<dd><p>Initialize a foreground glib loop.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>loop</strong> – the loop to run. If not set, uses
<code class="xref py py-class docutils literal notranslate"><span class="pre">GLib.MainLoop</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop._abc_impl">
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc_data</span> <span class="pre">object></span></em><a class="headerlink" href="#pythia.applications.base.ForegroundLoop._abc_impl" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop._is_protocol">
<span class="sig-name descname"><span class="pre">_is_protocol</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#pythia.applications.base.ForegroundLoop._is_protocol" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop.join">
<span class="sig-name descname"><span class="pre">join</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#ForegroundLoop.join"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.ForegroundLoop.join" title="Permalink to this definition">#</a></dt>
<dd><p>Run the main loop in the foreground.</p>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop.loop">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">loop</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pythia.types.html#pythia.types.Loop" title="pythia.types.Loop"><span class="pre">Loop</span></a></em><a class="headerlink" href="#pythia.applications.base.ForegroundLoop.loop" title="Permalink to this definition">#</a></dt>
<dd><p>Lazy property for the loop.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>initialized or pre-existing loop.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop.quit">
<span class="sig-name descname"><span class="pre">quit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#ForegroundLoop.quit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.ForegroundLoop.quit" title="Permalink to this definition">#</a></dt>
<dd><p>Quit the main loop running the foreground.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.ForegroundLoop.start">
<span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#ForegroundLoop.start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.ForegroundLoop.start" title="Permalink to this definition">#</a></dt>
<dd><p>Ensure the lazy property is accessed at least once.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pythia.applications.base.RunLoop">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">RunLoop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#RunLoop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.RunLoop" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Protocol</span></code></p>
<p>Loop wrapper interface.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pythia.applications.base.RunLoop._abc_impl">
<span class="sig-name descname"><span class="pre">_abc_impl</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><_abc_data</span> <span class="pre">object></span></em><a class="headerlink" href="#pythia.applications.base.RunLoop._abc_impl" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pythia.applications.base.RunLoop._is_protocol">
<span class="sig-name descname"><span class="pre">_is_protocol</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#pythia.applications.base.RunLoop._is_protocol" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.RunLoop.join">
<span class="sig-name descname"><span class="pre">join</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#RunLoop.join"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.RunLoop.join" title="Permalink to this definition">#</a></dt>
<dd><p>Run and block the loop.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.RunLoop.quit">
<span class="sig-name descname"><span class="pre">quit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#RunLoop.quit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.RunLoop.quit" title="Permalink to this definition">#</a></dt>
<dd><p>Stop the running loop.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pythia.applications.base.RunLoop.start">
<span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#RunLoop.start"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base.RunLoop.start" title="Permalink to this definition">#</a></dt>
<dd><p>Ensure the loop is running / activated.</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pythia.applications.base._build_probe">
<span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">_build_probe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">probe</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend_uri</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pythia/applications/base.html#_build_probe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base._build_probe" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pythia.applications.base._get_from_annotations">
<span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">_get_from_annotations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#_get_from_annotations"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base._get_from_annotations" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pythia.applications.base._get_from_positional_arg_name">
<span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">_get_from_positional_arg_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#_get_from_positional_arg_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base._get_from_positional_arg_name" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pythia.applications.base._get_probe_batch_meta_idx">
<span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">_get_probe_batch_meta_idx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">FullArgSpec</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#_get_probe_batch_meta_idx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base._get_probe_batch_meta_idx" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pythia.applications.base._get_probe_info_idx">
<span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">_get_probe_info_idx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">FullArgSpec</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#_get_probe_info_idx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base._get_probe_info_idx" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pythia.applications.base._get_probe_pad_idx">
<span class="sig-prename descclassname"><span class="pre">pythia.applications.base.</span></span><span class="sig-name descname"><span class="pre">_get_probe_pad_idx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">FullArgSpec</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pythia/applications/base.html#_get_probe_pad_idx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pythia.applications.base._get_probe_pad_idx" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="pythia.applications.command_line.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">pythia.applications.command_line</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="pythia.applications.annotation.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">pythia.applications.annotation</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2022, RMC Labs
</div>
Made with 🖤 by <a href="https://dev.rmclabs.io">RMC Labs</a> in Concon, Chile
</div>
<div class="right-details">
<div class="icons">
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer no-toc">
</aside>
</div>
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/furo.js"></script>
</body>
</html>