-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a94de17
commit c2e2ee0
Showing
17 changed files
with
761 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1"> | ||
| <meta name="generator" content="pdoc3 0.11.1"> | ||
| <title>enrgdaq.daq.jobs.camera API documentation</title> | ||
| <meta name="description" content=""> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin> | ||
| <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style> | ||
| <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style> | ||
| <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style> | ||
| <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script> | ||
| <script>window.addEventListener('DOMContentLoaded', () => { | ||
| hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']}); | ||
| hljs.highlightAll(); | ||
| })</script> | ||
| </head> | ||
| <body> | ||
| <main> | ||
| <article id="content"> | ||
| <header> | ||
| <h1 class="title">Module <code>enrgdaq.daq.jobs.camera</code></h1> | ||
| </header> | ||
| <section id="section-intro"> | ||
| </section> | ||
| <section> | ||
| </section> | ||
| <section> | ||
| </section> | ||
| <section> | ||
| </section> | ||
| <section> | ||
| <h2 class="section-title" id="header-classes">Classes</h2> | ||
| <dl> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCamera"><code class="flex name class"> | ||
| <span>class <span class="ident">DAQJobCamera</span></span> | ||
| <span>(</span><span>config: <a title="enrgdaq.daq.jobs.camera.DAQJobCameraConfig" href="#enrgdaq.daq.jobs.camera.DAQJobCameraConfig">DAQJobCameraConfig</a>, **kwargs)</span> | ||
| </code></dt> | ||
| <dd> | ||
| <div class="desc"><p>DAQ job for capturing images from a camera using PIL and pygrabber.</p></div> | ||
| <details class="source"> | ||
| <summary> | ||
| <span>Expand source code</span> | ||
| </summary> | ||
| <pre><code class="python">class DAQJobCamera(DAQJob): | ||
| """ | ||
| DAQ job for capturing images from a camera using PIL and pygrabber. | ||
| """ | ||
|
|
||
| allowed_message_in_types = [] | ||
| config_type = DAQJobCameraConfig | ||
| config: DAQJobCameraConfig | ||
| _cam: cv2.VideoCapture | ||
|
|
||
| def __init__(self, config: DAQJobCameraConfig, **kwargs): | ||
| super().__init__(config, **kwargs) | ||
| self._cam = cv2.VideoCapture(self.config.camera_device_index) | ||
|
|
||
| def start(self): | ||
| while True: | ||
| start_time = datetime.now() | ||
| self.capture_image() | ||
| sleep_for(self.config.store_interval_seconds, start_time) | ||
|
|
||
| def capture_image(self): | ||
| self._logger.debug("Capturing image...") | ||
| res, frame = self._cam.read() | ||
| assert res | ||
| # get bytes from frame | ||
| res, buffer = cv2.imencode(".jpg", frame) | ||
| assert res | ||
| image_data = buffer.tobytes() | ||
|
|
||
| self._put_message_out( | ||
| DAQJobMessageStoreRaw( | ||
| data=image_data, | ||
| store_config=self.config.store_config, | ||
| ) | ||
| ) | ||
| self._logger.debug("Image captured and sent")</code></pre> | ||
| </details> | ||
| <h3>Ancestors</h3> | ||
| <ul class="hlist"> | ||
| <li><a title="enrgdaq.daq.base.DAQJob" href="../base.html#enrgdaq.daq.base.DAQJob">DAQJob</a></li> | ||
| </ul> | ||
| <h3>Class variables</h3> | ||
| <dl> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCamera.allowed_message_in_types"><code class="name">var <span class="ident">allowed_message_in_types</span> : list[type[<a title="enrgdaq.daq.models.DAQJobMessage" href="../models.html#enrgdaq.daq.models.DAQJobMessage">DAQJobMessage</a>]]</code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCamera.config"><code class="name">var <span class="ident">config</span> : <a title="enrgdaq.daq.jobs.camera.DAQJobCameraConfig" href="#enrgdaq.daq.jobs.camera.DAQJobCameraConfig">DAQJobCameraConfig</a></code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCamera.config_type"><code class="name">var <span class="ident">config_type</span> : Any</code></dt> | ||
| <dd> | ||
| <div class="desc"><p>Configuration class for DAQJobCamera.</p></div> | ||
| </dd> | ||
| </dl> | ||
| <h3>Methods</h3> | ||
| <dl> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCamera.capture_image"><code class="name flex"> | ||
| <span>def <span class="ident">capture_image</span></span>(<span>self)</span> | ||
| </code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCamera.start"><code class="name flex"> | ||
| <span>def <span class="ident">start</span></span>(<span>self)</span> | ||
| </code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| </dl> | ||
| <h3>Inherited members</h3> | ||
| <ul class="hlist"> | ||
| <li><code><b><a title="enrgdaq.daq.base.DAQJob" href="../base.html#enrgdaq.daq.base.DAQJob">DAQJob</a></b></code>: | ||
| <ul class="hlist"> | ||
| <li><code><a title="enrgdaq.daq.base.DAQJob.consume" href="../base.html#enrgdaq.daq.base.DAQJob.consume">consume</a></code></li> | ||
| <li><code><a title="enrgdaq.daq.base.DAQJob.handle_message" href="../base.html#enrgdaq.daq.base.DAQJob.handle_message">handle_message</a></code></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </dd> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCameraConfig"><code class="flex name class"> | ||
| <span>class <span class="ident">DAQJobCameraConfig</span></span> | ||
| <span>(</span><span>store_config: <a title="enrgdaq.daq.store.models.DAQJobStoreConfig" href="../store/models.html#enrgdaq.daq.store.models.DAQJobStoreConfig">DAQJobStoreConfig</a>, camera_device_index: int = 0, store_interval_seconds: int = 5, *, verbosity: <a title="enrgdaq.daq.models.LogVerbosity" href="../models.html#enrgdaq.daq.models.LogVerbosity">LogVerbosity</a> = LogVerbosity.INFO, remote_config: Optional[<a title="enrgdaq.daq.models.DAQRemoteConfig" href="../models.html#enrgdaq.daq.models.DAQRemoteConfig">DAQRemoteConfig</a>] = <factory>, daq_job_type: str)</span> | ||
| </code></dt> | ||
| <dd> | ||
| <div class="desc"><p>Configuration class for DAQJobCamera.</p></div> | ||
| <details class="source"> | ||
| <summary> | ||
| <span>Expand source code</span> | ||
| </summary> | ||
| <pre><code class="python">class DAQJobCameraConfig(StorableDAQJobConfig): | ||
| """Configuration class for DAQJobCamera.""" | ||
|
|
||
| camera_device_index: int = 0 | ||
| store_interval_seconds: int = 5</code></pre> | ||
| </details> | ||
| <h3>Ancestors</h3> | ||
| <ul class="hlist"> | ||
| <li><a title="enrgdaq.daq.store.models.StorableDAQJobConfig" href="../store/models.html#enrgdaq.daq.store.models.StorableDAQJobConfig">StorableDAQJobConfig</a></li> | ||
| <li><a title="enrgdaq.daq.models.DAQJobConfig" href="../models.html#enrgdaq.daq.models.DAQJobConfig">DAQJobConfig</a></li> | ||
| <li>msgspec.Struct</li> | ||
| <li>msgspec._core._StructMixin</li> | ||
| </ul> | ||
| <h3>Instance variables</h3> | ||
| <dl> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCameraConfig.camera_device_index"><code class="name">var <span class="ident">camera_device_index</span> : int</code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| <dt id="enrgdaq.daq.jobs.camera.DAQJobCameraConfig.store_interval_seconds"><code class="name">var <span class="ident">store_interval_seconds</span> : int</code></dt> | ||
| <dd> | ||
| <div class="desc"></div> | ||
| </dd> | ||
| </dl> | ||
| </dd> | ||
| </dl> | ||
| </section> | ||
| </article> | ||
| <nav id="sidebar"> | ||
| <div class="toc"> | ||
| <ul></ul> | ||
| </div> | ||
| <ul id="index"> | ||
| <li><h3>Super-module</h3> | ||
| <ul> | ||
| <li><code><a title="enrgdaq.daq.jobs" href="index.html">enrgdaq.daq.jobs</a></code></li> | ||
| </ul> | ||
| </li> | ||
| <li><h3><a href="#header-classes">Classes</a></h3> | ||
| <ul> | ||
| <li> | ||
| <h4><code><a title="enrgdaq.daq.jobs.camera.DAQJobCamera" href="#enrgdaq.daq.jobs.camera.DAQJobCamera">DAQJobCamera</a></code></h4> | ||
| <ul class=""> | ||
| <li><code><a title="enrgdaq.daq.jobs.camera.DAQJobCamera.allowed_message_in_types" href="#enrgdaq.daq.jobs.camera.DAQJobCamera.allowed_message_in_types">allowed_message_in_types</a></code></li> | ||
| <li><code><a title="enrgdaq.daq.jobs.camera.DAQJobCamera.capture_image" href="#enrgdaq.daq.jobs.camera.DAQJobCamera.capture_image">capture_image</a></code></li> | ||
| <li><code><a title="enrgdaq.daq.jobs.camera.DAQJobCamera.config" href="#enrgdaq.daq.jobs.camera.DAQJobCamera.config">config</a></code></li> | ||
| <li><code><a title="enrgdaq.daq.jobs.camera.DAQJobCamera.config_type" href="#enrgdaq.daq.jobs.camera.DAQJobCamera.config_type">config_type</a></code></li> | ||
| <li><code><a title="enrgdaq.daq.jobs.camera.DAQJobCamera.start" href="#enrgdaq.daq.jobs.camera.DAQJobCamera.start">start</a></code></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <h4><code><a title="enrgdaq.daq.jobs.camera.DAQJobCameraConfig" href="#enrgdaq.daq.jobs.camera.DAQJobCameraConfig">DAQJobCameraConfig</a></code></h4> | ||
| <ul class=""> | ||
| <li><code><a title="enrgdaq.daq.jobs.camera.DAQJobCameraConfig.camera_device_index" href="#enrgdaq.daq.jobs.camera.DAQJobCameraConfig.camera_device_index">camera_device_index</a></code></li> | ||
| <li><code><a title="enrgdaq.daq.jobs.camera.DAQJobCameraConfig.store_interval_seconds" href="#enrgdaq.daq.jobs.camera.DAQJobCameraConfig.store_interval_seconds">store_interval_seconds</a></code></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| </main> | ||
| <footer id="footer"> | ||
| <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p> | ||
| </footer> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.