<!DOCTYPE html> <html lang=en data-content_root="../"> <meta charset=utf-8 /> <meta name=viewport content="width=device-width, initial-scale=1.0" /><meta name=viewport content="width=device-width, initial-scale=1" /> <meta name=viewport content="width=device-width,initial-scale=1"> <meta http-equiv=x-ua-compatible content="ie=edge"> <meta name="lang:clipboard.copy" content="Copy to clipboard"> <meta name="lang:clipboard.copied" content="Copied to clipboard"> <meta name="lang:search.language" content=en > <meta name="lang:search.pipeline.stopwords" content=True > <meta name="lang:search.pipeline.trimmer" content=True > <meta name="lang:search.result.none" content="No matching documents"> <meta name="lang:search.result.one" content="1 matching document"> <meta name="lang:search.result.other" content="# matching documents"> <meta name="lang:search.tokenizer" content="[\s\-]+"> <link href="https://fonts.gstatic.com/" rel=preconnect crossorigin> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel=stylesheet > <style> body, input { font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif } code, kbd, pre { font-family: "Roboto Mono", "Courier New", Courier, monospace } </style> <link rel=stylesheet href="../_static/stylesheets/application.css"/> <link rel=stylesheet href="../_static/stylesheets/application-palette.css"/> <link rel=stylesheet href="../_static/stylesheets/application-fixes.css"/> <link rel=stylesheet href="../_static/fonts/material-icons.css"/> <meta name=theme-color content="#3f51b5"> <script src="../_static/javascripts/modernizr.js"></script> <title>jfjoch-client — Jungfraujoch 1.0.0-rc.144 documentation</title> <link rel=stylesheet type="text/css" href="../_static/pygments.css?v=83e35b93" /> <link rel=stylesheet type="text/css" href="../_static/material.css?v=79c92029" /> <script src="../_static/documentation_options.js?v=909c8bec"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel=icon href="../_static/jfjoch.png"/> <link rel=index title=Index href="../genindex.html" /> <link rel=search title=Search href="../search.html" /> <link rel=next title=jfjoch_client.DefaultApi href="docs/DefaultApi.html" /> <link rel=prev title=Tests href="../TESTS.html" /> <body dir=ltr data-md-color-primary=indigo data-md-color-accent=lime> <svg class=md-svg > <defs data-children-count=0 > <svg xmlns="http://www.w3.org/2000/svg" width=500 height=500 viewBox="0 0 500 500" id=__gitlab ><path fill=currentColor d="M93.667 473.347l90.684-279.097H2.983l90.684 279.097z" transform="translate(156.198 1.16)"/><path fill=currentColor d="M221.333 473.345L130.649 194.25H3.557l217.776 279.095z" transform="translate(28.531 1.16)" opacity=.7 /><path fill=currentColor d="M32 195.155L4.441 279.97a18.773 18.773 0 0 0 6.821 20.99l238.514 173.29L32 195.155z" transform="translate(.089 .256)" opacity=.5 /><path fill=currentColor d="M2.667-84.844h127.092L75.14-252.942c-2.811-8.649-15.047-8.649-17.856 0L2.667-84.844z" transform="translate(29.422 280.256)"/><path fill=currentColor d="M2.667 473.345L93.351 194.25h127.092L2.667 473.345z" transform="translate(247.198 1.16)" opacity=.7 /><path fill=currentColor d="M221.334 195.155l27.559 84.815a18.772 18.772 0 0 1-6.821 20.99L3.557 474.25l217.777-279.095z" transform="translate(246.307 .256)" opacity=.5 /><path fill=currentColor d="M130.667-84.844H3.575l54.618-168.098c2.811-8.649 15.047-8.649 17.856 0l54.618 168.098z" transform="translate(336.974 280.256)"/></svg> </defs> </svg> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer > <input class=md-toggle data-md-toggle=search type=checkbox id=__search > <label class=md-overlay data-md-component=overlay for=__drawer ></label> <a href="#python_client/README" tabindex=1 class=md-skip > Skip to content </a> <header class=md-header data-md-component=header > <nav class="md-header-nav md-grid"> <div class="md-flex navheader"> <div class="md-flex__cell md-flex__cell--shrink"> <a href="../index.html" title="Jungfraujoch 1.0.0-rc.144 documentation" class="md-header-nav__button md-logo"> <i class=md-icon ></i> </a> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--menu md-header-nav__button" for=__drawer ></label> </div> <div class="md-flex__cell md-flex__cell--stretch"> <div class="md-flex__ellipsis md-header-nav__title" data-md-component=title > <span class=md-header-nav__topic >PSI Jungfraujoch</span> <span class=md-header-nav__topic > jfjoch-client </span> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--search md-header-nav__button" for=__search ></label> <div class=md-search data-md-component=search role=dialog > <label class=md-search__overlay for=__search ></label> <div class=md-search__inner role=search > <form class=md-search__form action="../search.html" method=get name=search > <input type=text class=md-search__input name=q placeholder=""Search"" autocapitalize=off autocomplete=off spellcheck=false data-md-component=query data-md-state=active > <label class="md-icon md-search__icon" for=__search ></label> <button type=reset class="md-icon md-search__icon" data-md-component=reset tabindex=-1 >  </button> </form> <div class=md-search__output > <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=result > <div class=md-search-result__meta > Type to start searching </div> <ol class=md-search-result__list ></ol> </div> </div> </div> </div> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <div class=md-header-nav__source > <a href="https://gitea.psi.ch/mx/jungfraujoch" title="Go to repository" class=md-source data-md-source=github > <div class=md-source__icon > <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width=28 height=28 > <use xlink:href="#__gitlab" width=24 height=24 ></use> </svg> </div> <div class=md-source__repository > Jungfraujoch </div> </a> </div> </div> <script src="../_static/javascripts/version_dropdown.js"></script> <script> var json_loc = "../"versions.json"", target_loc = "../../", text = "Versions"; $( document ).ready( add_version_dropdown(json_loc, target_loc, text)); </script> </div> </nav> </header> <div class=md-container > <nav class=md-tabs data-md-component=tabs > <div class="md-tabs__inner md-grid"> <ul class=md-tabs__list > <li class=md-tabs__item ><a href="../index.html" class=md-tabs__link >Jungfraujoch 1.0.0-rc.144 documentation</a> </ul> </div> </nav> <main class=md-main > <div class="md-main__inner md-grid" data-md-component=container > <div class="md-sidebar md-sidebar--primary" data-md-component=navigation > <div class=md-sidebar__scrollwrap > <div class=md-sidebar__inner > <nav class="md-nav md-nav--primary" data-md-level=0 > <label class="md-nav__title md-nav__title--site" for=__drawer > <a href="../index.html" title="Jungfraujoch 1.0.0-rc.144 documentation" class="md-nav__button md-logo"> <i class=md-icon ></i> </a> <a href="../index.html" title="Jungfraujoch 1.0.0-rc.144 documentation">PSI Jungfraujoch</a> </label> <div class=md-nav__source > <a href="https://gitea.psi.ch/mx/jungfraujoch" title="Go to repository" class=md-source data-md-source=github > <div class=md-source__icon > <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width=28 height=28 > <use xlink:href="#__gitlab" width=24 height=24 ></use> </svg> </div> <div class=md-source__repository > Jungfraujoch </div> </a> </div> <ul class=md-nav__list > <li class=md-nav__item > <span class="md-nav__link caption"><span class=caption-text >General</span></span> <li class=md-nav__item > <a href="../ACKNOWLEDGEMENT.html" class=md-nav__link >Acknowledgements</a> <li class=md-nav__item > <a href="../LICENSE.html" class=md-nav__link >License</a> <li class=md-nav__item > <a href="../DETECTORS.html" class=md-nav__link >Supported detectors</a> <li class=md-nav__item > <a href="../DETECTORS.html#dectris-detectors" class=md-nav__link >DECTRIS detectors</a> <li class=md-nav__item > <a href="../HARDWARE.html" class=md-nav__link >Hardware requirements</a> <li class=md-nav__item > <a href="../SOFTWARE.html" class=md-nav__link >Software requirements</a> <li class=md-nav__item > <a href="../VERSIONING.html" class=md-nav__link >Semantic versioning</a> <li class=md-nav__item > <a href="../DEPLOYMENT.html" class=md-nav__link >Deployment</a> <li class=md-nav__item > <a href="../CHANGELOG.html" class=md-nav__link >Changelog</a> <li class=md-nav__item > <span class="md-nav__link caption"><span class=caption-text >Software</span></span> <li class=md-nav__item > <a href="../JFJOCH_BROKER.html" class=md-nav__link >jfjoch_broker</a> <li class=md-nav__item > <a href="../JFJOCH_WRITER.html" class=md-nav__link >jfjoch_writer</a> <li class=md-nav__item > <a href="../SOFTWARE_INTEGRATION.html" class=md-nav__link >Integration with MX data processing software</a> <li class=md-nav__item > <a href="../TOOLS.html" class=md-nav__link >Tools</a> <li class=md-nav__item > <span class="md-nav__link caption"><span class=caption-text >FPGA</span></span> <li class=md-nav__item > <a href="../FPGA.html" class=md-nav__link >FPGA smartNIC</a> <li class=md-nav__item > <a href="../FPGA_LICENSE.html" class=md-nav__link >FPGA license</a> <li class=md-nav__item > <a href="../FPGA_DESIGN.html" class=md-nav__link >FPGA data flow</a> <li class=md-nav__item > <a href="../FPGA_NETWORK.html" class=md-nav__link >FPGA network</a> <li class=md-nav__item > <a href="../FPGA_PCIE_DRIVER.html" class=md-nav__link >FPGA PCIe driver</a> <li class=md-nav__item > <a href="../FPGA_SETTINGS.html" class=md-nav__link >FPGA advanced reference</a> <li class=md-nav__item > <a href="../FPGA_DATA_ANALYSIS.html" class=md-nav__link >FPGA data analysis</a> <li class=md-nav__item > <span class="md-nav__link caption"><span class=caption-text >Reference</span></span> <li class=md-nav__item > <a href="../DETECTOR_GEOMETRY.html" class=md-nav__link >Detector geometry</a> <li class=md-nav__item > <a href="../CPU_DATA_ANALYSIS.html" class=md-nav__link >CPU-side crystallographic data analysis (Jungfraujoch)</a> <li class=md-nav__item > <a href="../OPENAPI.html" class=md-nav__link >OpenAPI</a> <li class=md-nav__item > <a href="../OPENAPI_SPECS.html" class=md-nav__link >OpenAPI specification</a> <li class=md-nav__item > <a href="../CBOR.html" class=md-nav__link >CBOR messages</a> <li class=md-nav__item > <a href="../IMAGE_STREAM.html" class=md-nav__link >Data streams</a> <li class=md-nav__item > <a href="../PIXEL_MASK.html" class=md-nav__link >Pixel mask</a> <li class=md-nav__item > <a href="../WEB_FRONTEND.html" class=md-nav__link >Web frontend</a> <li class=md-nav__item > <a href="../TESTS.html" class=md-nav__link >Tests</a> <li class=md-nav__item > <span class="md-nav__link caption"><span class=caption-text >OpenAPI Python client</span></span> <li class=md-nav__item > <input class="md-toggle md-nav__toggle" data-md-toggle=toc type=checkbox id=__toc > <label class="md-nav__link md-nav__link--active" for=__toc > jfjoch-client </label> <a href="#" class="md-nav__link md-nav__link--active">jfjoch-client</a> <nav class="md-nav md-nav--secondary"> <ul class=md-nav__list data-md-scrollfix=""> </ul> </nav> <li class=md-nav__item > <a href="#license-clarification" class=md-nav__link >License Clarification</a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#requirements" class=md-nav__link >Requirements.</a> <li class=md-nav__item > <a href="#installation-usage" class=md-nav__link >Installation & Usage</a> <li class=md-nav__item > <a href="#getting-started" class=md-nav__link >Getting Started</a> <li class=md-nav__item > <a href="#documentation-for-api-endpoints" class=md-nav__link >Documentation for API Endpoints</a> <li class=md-nav__item > <a href="#documentation-for-models" class=md-nav__link >Documentation For Models</a> <li class=md-nav__item > <a href="#documentation-for-authorization" class=md-nav__link >Documentation For Authorization</a> <li class=md-nav__item > <a href="#author" class=md-nav__link >Author</a> </ul> <li class=md-nav__item > <a href="docs/DefaultApi.html" class=md-nav__link >jfjoch_client.DefaultApi</a> <li class=md-nav__item > <a href="docs/DefaultApi.html#cancel-post" class=md-nav__link ><strong>cancel_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-azim-int-get" class=md-nav__link ><strong>config_azim_int_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-azim-int-put" class=md-nav__link ><strong>config_azim_int_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-dark-mask-get" class=md-nav__link ><strong>config_dark_mask_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-dark-mask-put" class=md-nav__link ><strong>config_dark_mask_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-detector-get" class=md-nav__link ><strong>config_detector_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-detector-put" class=md-nav__link ><strong>config_detector_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-file-writer-get" class=md-nav__link ><strong>config_file_writer_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-file-writer-put" class=md-nav__link ><strong>config_file_writer_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-image-format-conversion-post" class=md-nav__link ><strong>config_image_format_conversion_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-image-format-get" class=md-nav__link ><strong>config_image_format_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-image-format-put" class=md-nav__link ><strong>config_image_format_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-image-format-raw-post" class=md-nav__link ><strong>config_image_format_raw_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-indexing-get" class=md-nav__link ><strong>config_indexing_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-indexing-put" class=md-nav__link ><strong>config_indexing_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-instrument-get" class=md-nav__link ><strong>config_instrument_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-instrument-put" class=md-nav__link ><strong>config_instrument_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-internal-generator-image-put" class=md-nav__link ><strong>config_internal_generator_image_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-internal-generator-image-tiff-put" class=md-nav__link ><strong>config_internal_generator_image_tiff_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-mask-get" class=md-nav__link ><strong>config_mask_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-mask-tiff-get" class=md-nav__link ><strong>config_mask_tiff_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-roi-get" class=md-nav__link ><strong>config_roi_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-roi-put" class=md-nav__link ><strong>config_roi_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-select-detector-get" class=md-nav__link ><strong>config_select_detector_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-select-detector-put" class=md-nav__link ><strong>config_select_detector_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-spot-finding-get" class=md-nav__link ><strong>config_spot_finding_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-spot-finding-put" class=md-nav__link ><strong>config_spot_finding_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-user-mask-get" class=md-nav__link ><strong>config_user_mask_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-user-mask-put" class=md-nav__link ><strong>config_user_mask_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-user-mask-tiff-get" class=md-nav__link ><strong>config_user_mask_tiff_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-user-mask-tiff-put" class=md-nav__link ><strong>config_user_mask_tiff_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-zeromq-metadata-get" class=md-nav__link ><strong>config_zeromq_metadata_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-zeromq-metadata-put" class=md-nav__link ><strong>config_zeromq_metadata_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-zeromq-preview-get" class=md-nav__link ><strong>config_zeromq_preview_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#config-zeromq-preview-put" class=md-nav__link ><strong>config_zeromq_preview_put</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#deactivate-post" class=md-nav__link ><strong>deactivate_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#detector-status-get" class=md-nav__link ><strong>detector_status_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#fpga-status-get" class=md-nav__link ><strong>fpga_status_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#image-buffer-clear-post" class=md-nav__link ><strong>image_buffer_clear_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#image-buffer-image-cbor-get" class=md-nav__link ><strong>image_buffer_image_cbor_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#image-buffer-image-jpeg-get" class=md-nav__link ><strong>image_buffer_image_jpeg_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#image-buffer-image-tiff-get" class=md-nav__link ><strong>image_buffer_image_tiff_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#image-buffer-start-cbor-get" class=md-nav__link ><strong>image_buffer_start_cbor_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#image-buffer-status-get" class=md-nav__link ><strong>image_buffer_status_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#image-pusher-status-get" class=md-nav__link ><strong>image_pusher_status_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#initialize-post" class=md-nav__link ><strong>initialize_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#pedestal-post" class=md-nav__link ><strong>pedestal_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#preview-pedestal-tiff-get" class=md-nav__link ><strong>preview_pedestal_tiff_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#preview-plot-bin-get" class=md-nav__link ><strong>preview_plot_bin_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#preview-plot-get" class=md-nav__link ><strong>preview_plot_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#result-scan-get" class=md-nav__link ><strong>result_scan_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#start-post" class=md-nav__link ><strong>start_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#statistics-calibration-get" class=md-nav__link ><strong>statistics_calibration_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#statistics-data-collection-get" class=md-nav__link ><strong>statistics_data_collection_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#statistics-get" class=md-nav__link ><strong>statistics_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#status-get" class=md-nav__link ><strong>status_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#trigger-post" class=md-nav__link ><strong>trigger_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#version-get" class=md-nav__link ><strong>version_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#wait-till-done-post" class=md-nav__link ><strong>wait_till_done_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#wait-until-running-post" class=md-nav__link ><strong>wait_until_running_post</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#xfel-event-code-get" class=md-nav__link ><strong>xfel_event_code_get</strong></a> <li class=md-nav__item > <a href="docs/DefaultApi.html#xfel-pulse-id-get" class=md-nav__link ><strong>xfel_pulse_id_get</strong></a> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=toc > <div class=md-sidebar__scrollwrap > <div class=md-sidebar__inner > <nav class="md-nav md-nav--secondary"> <ul class=md-nav__list data-md-scrollfix=""> </ul> </nav> </div> </div> </div> <div class=md-content > <article class="md-content__inner md-typeset" role=main > <section class="tex2jax_ignore mathjax_ignore" id=jfjoch-client > <h1 id=python-client-readme--page-root >jfjoch-client<a class=headerlink href="#python-client-readme--page-root" title="Link to this heading">¶</a></h1> <p>API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.</p> </section> <section class="tex2jax_ignore mathjax_ignore" id=license-clarification > <h1 id=license-clarification >License Clarification<a class=headerlink href="#license-clarification" title="Link to this heading">¶</a></h1> <p>While this API definition is licensed under GPL-3.0, <strong>the GPL copyleft provisions do not apply</strong> when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.</p> <p>This exception is similar in spirit to the Linux Kernel’s approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.</p> <p>This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms.</p> <p>This Python package is automatically generated by the <a class="reference external" href="https://openapi-generator.tech">OpenAPI Generator</a> project:</p> <ul class=simple > <li><p>API version: 1.0.0-rc.144</p> <li><p>Package version: 1.0.0-rc.144</p> <li><p>Generator version: 7.20.0</p> <li><p>Build package: org.openapitools.codegen.languages.PythonClientCodegen</p> </ul> <section id=requirements > <h2 id=requirements >Requirements.<a class=headerlink href="#requirements" title="Link to this heading">¶</a></h2> <p>Python 3.9+</p> </section> <section id=installation-usage > <h2 id=installation-usage >Installation & Usage<a class=headerlink href="#installation-usage" title="Link to this heading">¶</a></h2> <section id=pip-install > <h3 id=pip-install >pip install<a class=headerlink href="#pip-install" title="Link to this heading">¶</a></h3> <p>If the python package is hosted on a repository, you can install directly using:</p> <div class="highlight-sh notranslate"><div class=highlight ><pre><span></span>pip<span class=w > </span>install<span class=w > </span>git+https://git.psi.ch/jungfraujoch/jungfraujoch.git
</pre></div> </div> <p>(you may need to run <code class="docutils literal notranslate"><span class=pre >pip</span></code> with root permission: <code class="docutils literal notranslate"><span class=pre >sudo</span> <span class=pre >pip</span> <span class=pre >install</span> <span class=pre >git+https://git.psi.ch/jungfraujoch/jungfraujoch.git</span></code>)</p> <p>Then import the package:</p> <div class="highlight-python notranslate"><div class=highlight ><pre><span></span><span class=kn >import</span> <span class=nn >jfjoch_client</span>
</pre></div> </div> </section> <section id=setuptools > <h3 id=setuptools >Setuptools<a class=headerlink href="#setuptools" title="Link to this heading">¶</a></h3> <p>Install via <a class="reference external" href="http://pypi.python.org/pypi/setuptools">Setuptools</a>.</p> <div class="highlight-sh notranslate"><div class=highlight ><pre><span></span>python<span class=w > </span>setup.py<span class=w > </span>install<span class=w > </span>--user
</pre></div> </div> <p>(or <code class="docutils literal notranslate"><span class=pre >sudo</span> <span class=pre >python</span> <span class=pre >setup.py</span> <span class=pre >install</span></code> to install the package for all users)</p> <p>Then import the package:</p> <div class="highlight-python notranslate"><div class=highlight ><pre><span></span><span class=kn >import</span> <span class=nn >jfjoch_client</span>
</pre></div> </div> </section> <section id=tests > <h3 id=tests >Tests<a class=headerlink href="#tests" title="Link to this heading">¶</a></h3> <p>Execute <code class="docutils literal notranslate"><span class=pre >pytest</span></code> to run the tests.</p> </section> </section> <section id=getting-started > <h2 id=getting-started >Getting Started<a class=headerlink href="#getting-started" title="Link to this heading">¶</a></h2> <p>Please follow the <a class="reference internal" href="#installation--usage"><span class="xref myst">installation procedure</span></a> and then run the following:</p> <div class="highlight-python notranslate"><div class=highlight ><pre><span></span>
<span class=kn >import</span> <span class=nn >jfjoch_client</span>
<span class=kn >from</span> <span class=nn >jfjoch_client.rest</span> <span class=kn >import</span> <span class=n >ApiException</span>
<span class=kn >from</span> <span class=nn >pprint</span> <span class=kn >import</span> <span class=n >pprint</span>
<span class=c1 ># Defining the host is optional and defaults to http://localhost:5232</span>
<span class=c1 ># See configuration.py for a list of all supported configuration parameters.</span>
<span class=n >configuration</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >Configuration</span><span class=p >(</span>
<span class=n >host</span> <span class=o >=</span> <span class=s2 >"http://localhost:5232"</span>
<span class=p >)</span>
<span class=c1 ># Enter a context with an instance of the API client</span>
<span class=k >with</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >ApiClient</span><span class=p >(</span><span class=n >configuration</span><span class=p >)</span> <span class=k >as</span> <span class=n >api_client</span><span class=p >:</span>
<span class=c1 ># Create an instance of the API class</span>
<span class=n >api_instance</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >DefaultApi</span><span class=p >(</span><span class=n >api_client</span><span class=p >)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Cancel running data collection</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >cancel_post</span><span class=p >()</span>
<span class=k >except</span> <span class=n >ApiException</span> <span class=k >as</span> <span class=n >e</span><span class=p >:</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"Exception when calling DefaultApi->cancel_post: </span><span class=si >%s</span><span class=se >\n</span><span class=s2 >"</span> <span class=o >%</span> <span class=n >e</span><span class=p >)</span>
</pre></div> </div> </section> <section id=documentation-for-api-endpoints > <h2 id=documentation-for-api-endpoints >Documentation for API Endpoints<a class=headerlink href="#documentation-for-api-endpoints" title="Link to this heading">¶</a></h2> <p>All URIs are relative to <em><a class="reference external" href="http://localhost:5232">http://localhost:5232</a></em></p> <table> <thead> <tr class=row-odd ><th class=head ><p>Class</p> <th class=head ><p>Method</p> <th class=head ><p>HTTP request</p> <th class=head ><p>Description</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#cancel_post"><span class="std std-ref"><strong>cancel_post</strong></span></a></p> <td><p><strong>POST</strong> /cancel</p> <td><p>Cancel running data collection</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_azim_int_get"><span class="std std-ref"><strong>config_azim_int_get</strong></span></a></p> <td><p><strong>GET</strong> /config/azim_int</p> <td><p>Get azimuthal integration configuration</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_azim_int_put"><span class="std std-ref"><strong>config_azim_int_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/azim_int</p> <td><p>Configure azimuthal integration</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_dark_mask_get"><span class="std std-ref"><strong>config_dark_mask_get</strong></span></a></p> <td><p><strong>GET</strong> /config/dark_mask</p> <td><p>Get settings for dark data collection to calculate mask</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_dark_mask_put"><span class="std std-ref"><strong>config_dark_mask_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/dark_mask</p> <td><p>Set configuration for dark data collection to calculate mask</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_detector_get"><span class="std std-ref"><strong>config_detector_get</strong></span></a></p> <td><p><strong>GET</strong> /config/detector</p> <td><p>Get detector configuration</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_detector_put"><span class="std std-ref"><strong>config_detector_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/detector</p> <td><p>Change detector configuration</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_file_writer_get"><span class="std std-ref"><strong>config_file_writer_get</strong></span></a></p> <td><p><strong>GET</strong> /config/file_writer</p> <td><p>Get file writer settings</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_file_writer_put"><span class="std std-ref"><strong>config_file_writer_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/file_writer</p> <td><p>Change file writer settings</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_image_format_conversion_post"><span class="std std-ref"><strong>config_image_format_conversion_post</strong></span></a></p> <td><p><strong>POST</strong> /config/image_format/conversion</p> <td><p>Configure format for data collection with full conversion</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_image_format_get"><span class="std std-ref"><strong>config_image_format_get</strong></span></a></p> <td><p><strong>GET</strong> /config/image_format</p> <td><p>Get image output format</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_image_format_put"><span class="std std-ref"><strong>config_image_format_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/image_format</p> <td><p>Change image output format</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_image_format_raw_post"><span class="std std-ref"><strong>config_image_format_raw_post</strong></span></a></p> <td><p><strong>POST</strong> /config/image_format/raw</p> <td><p>Configure format for raw data collection</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_indexing_get"><span class="std std-ref"><strong>config_indexing_get</strong></span></a></p> <td><p><strong>GET</strong> /config/indexing</p> <td><p>Get indexing configuration</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_indexing_put"><span class="std std-ref"><strong>config_indexing_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/indexing</p> <td><p>Change indexing algorithm settings</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_instrument_get"><span class="std std-ref"><strong>config_instrument_get</strong></span></a></p> <td><p><strong>GET</strong> /config/instrument</p> <td><p>Get instrument metadata</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_instrument_put"><span class="std std-ref"><strong>config_instrument_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/instrument</p> <td><p>Change instrument metadata</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_internal_generator_image_put"><span class="std std-ref"><strong>config_internal_generator_image_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/internal_generator_image</p> <td><p>Load binary image for internal FPGA generator</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_internal_generator_image_tiff_put"><span class="std std-ref"><strong>config_internal_generator_image_tiff_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/internal_generator_image.tiff</p> <td><p>Load TIFF image for internal FPGA generator</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_mask_get"><span class="std std-ref"><strong>config_mask_get</strong></span></a></p> <td><p><strong>GET</strong> /config/mask</p> <td><p>Get mask of the detector (binary)</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_mask_tiff_get"><span class="std std-ref"><strong>config_mask_tiff_get</strong></span></a></p> <td><p><strong>GET</strong> /config/mask.tiff</p> <td><p>Get mask of the detector (TIFF)</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_roi_get"><span class="std std-ref"><strong>config_roi_get</strong></span></a></p> <td><p><strong>GET</strong> /config/roi</p> <td><p>Get ROI definitions</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_roi_put"><span class="std std-ref"><strong>config_roi_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/roi</p> <td><p>Upload ROI definitions</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_select_detector_get"><span class="std std-ref"><strong>config_select_detector_get</strong></span></a></p> <td><p><strong>GET</strong> /config/select_detector</p> <td><p>List available detectors</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_select_detector_put"><span class="std std-ref"><strong>config_select_detector_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/select_detector</p> <td><p>Select detector</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_spot_finding_get"><span class="std std-ref"><strong>config_spot_finding_get</strong></span></a></p> <td><p><strong>GET</strong> /config/spot_finding</p> <td><p>Get data processing configuration</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_spot_finding_put"><span class="std std-ref"><strong>config_spot_finding_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/spot_finding</p> <td><p>Configure spot finding</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_user_mask_get"><span class="std std-ref"><strong>config_user_mask_get</strong></span></a></p> <td><p><strong>GET</strong> /config/user_mask</p> <td><p>Detector must be Initialized. Get user mask of the detector (binary)</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_user_mask_put"><span class="std std-ref"><strong>config_user_mask_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/user_mask</p> <td><p>Upload user mask of the detector (binary)</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_user_mask_tiff_get"><span class="std std-ref"><strong>config_user_mask_tiff_get</strong></span></a></p> <td><p><strong>GET</strong> /config/user_mask.tiff</p> <td><p>Detector must be Initialized. Get user mask of the detector (TIFF)</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_user_mask_tiff_put"><span class="std std-ref"><strong>config_user_mask_tiff_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/user_mask.tiff</p> <td><p>Upload user mask of the detector</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_zeromq_metadata_get"><span class="std std-ref"><strong>config_zeromq_metadata_get</strong></span></a></p> <td><p><strong>GET</strong> /config/zeromq_metadata</p> <td><p>Get ZeroMQ metadata socket settings</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_zeromq_metadata_put"><span class="std std-ref"><strong>config_zeromq_metadata_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/zeromq_metadata</p> <td><p>Set ZeroMQ metadata settings</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_zeromq_preview_get"><span class="std std-ref"><strong>config_zeromq_preview_get</strong></span></a></p> <td><p><strong>GET</strong> /config/zeromq_preview</p> <td><p>Get ZeroMQ preview settings</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#config_zeromq_preview_put"><span class="std std-ref"><strong>config_zeromq_preview_put</strong></span></a></p> <td><p><strong>PUT</strong> /config/zeromq_preview</p> <td><p>Set ZeroMQ preview settings</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#deactivate_post"><span class="std std-ref"><strong>deactivate_post</strong></span></a></p> <td><p><strong>POST</strong> /deactivate</p> <td><p>Prepare detector to turn off</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#detector_status_get"><span class="std std-ref"><strong>detector_status_get</strong></span></a></p> <td><p><strong>GET</strong> /detector/status</p> <td><p>Get detector status</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#fpga_status_get"><span class="std std-ref"><strong>fpga_status_get</strong></span></a></p> <td><p><strong>GET</strong> /fpga_status</p> <td><p>Get status of FPGA devices</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#image_buffer_clear_post"><span class="std std-ref"><strong>image_buffer_clear_post</strong></span></a></p> <td><p><strong>POST</strong> /image_buffer/clear</p> <td><p>Clear image buffer</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#image_buffer_image_cbor_get"><span class="std std-ref"><strong>image_buffer_image_cbor_get</strong></span></a></p> <td><p><strong>GET</strong> /image_buffer/image.cbor</p> <td><p>Get image message in CBOR format</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#image_buffer_image_jpeg_get"><span class="std std-ref"><strong>image_buffer_image_jpeg_get</strong></span></a></p> <td><p><strong>GET</strong> /image_buffer/image.jpeg</p> <td><p>Get preview image in JPEG format using custom settings</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#image_buffer_image_tiff_get"><span class="std std-ref"><strong>image_buffer_image_tiff_get</strong></span></a></p> <td><p><strong>GET</strong> /image_buffer/image.tiff</p> <td><p>Get preview image in TIFF format</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#image_buffer_start_cbor_get"><span class="std std-ref"><strong>image_buffer_start_cbor_get</strong></span></a></p> <td><p><strong>GET</strong> /image_buffer/start.cbor</p> <td><p>Get Start message in CBOR format</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#image_buffer_status_get"><span class="std std-ref"><strong>image_buffer_status_get</strong></span></a></p> <td><p><strong>GET</strong> /image_buffer/status</p> <td><p>Get status of the image buffers</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#image_pusher_status_get"><span class="std std-ref"><strong>image_pusher_status_get</strong></span></a></p> <td><p><strong>GET</strong> /image_pusher/status</p> <td><p>Get status of image pusher</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#initialize_post"><span class="std std-ref"><strong>initialize_post</strong></span></a></p> <td><p><strong>POST</strong> /initialize</p> <td><p>Initialize detector and data acquisition</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#pedestal_post"><span class="std std-ref"><strong>pedestal_post</strong></span></a></p> <td><p><strong>POST</strong> /pedestal</p> <td><p>Collect dark current for the detector</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#preview_pedestal_tiff_get"><span class="std std-ref"><strong>preview_pedestal_tiff_get</strong></span></a></p> <td><p><strong>GET</strong> /preview/pedestal.tiff</p> <td><p>Get pedestal in TIFF format</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#preview_plot_bin_get"><span class="std std-ref"><strong>preview_plot_bin_get</strong></span></a></p> <td><p><strong>GET</strong> /preview/plot.bin</p> <td><p>Generate 1D plot from Jungfraujoch and send in raw binary format. Data are provided as (32-bit) float binary array. This format doesn’t transmit information about X-axis, only values, so it is of limited use for azimuthal integration.</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#preview_plot_get"><span class="std std-ref"><strong>preview_plot_get</strong></span></a></p> <td><p><strong>GET</strong> /preview/plot</p> <td><p>Generate 1D plot from Jungfraujoch</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#result_scan_get"><span class="std std-ref"><strong>result_scan_get</strong></span></a></p> <td><p><strong>GET</strong> /result/scan</p> <td><p>Get full scan result</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#start_post"><span class="std std-ref"><strong>start_post</strong></span></a></p> <td><p><strong>POST</strong> /start</p> <td><p>Start detector</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#statistics_calibration_get"><span class="std std-ref"><strong>statistics_calibration_get</strong></span></a></p> <td><p><strong>GET</strong> /statistics/calibration</p> <td><p>Get calibration statistics</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#statistics_data_collection_get"><span class="std std-ref"><strong>statistics_data_collection_get</strong></span></a></p> <td><p><strong>GET</strong> /statistics/data_collection</p> <td><p>Get data collection statistics</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#statistics_get"><span class="std std-ref"><strong>statistics_get</strong></span></a></p> <td><p><strong>GET</strong> /statistics</p> <td><p>Get general statistics</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#status_get"><span class="std std-ref"><strong>status_get</strong></span></a></p> <td><p><strong>GET</strong> /status</p> <td><p>Get Jungfraujoch status</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#trigger_post"><span class="std std-ref"><strong>trigger_post</strong></span></a></p> <td><p><strong>POST</strong> /trigger</p> <td><p>Send soft trigger to the detector</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#version_get"><span class="std std-ref"><strong>version_get</strong></span></a></p> <td><p><strong>GET</strong> /version</p> <td><p>Get Jungfraujoch version of jfjoch_broker</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#wait_till_done_post"><span class="std std-ref"><strong>wait_till_done_post</strong></span></a></p> <td><p><strong>POST</strong> /wait_till_done</p> <td><p>Wait for acquisition done</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#wait_until_running_post"><span class="std std-ref"><strong>wait_until_running_post</strong></span></a></p> <td><p><strong>POST</strong> /wait_until_running</p> <td><p>Wait for acquisition running</p> <tr class=row-even ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#xfel_event_code_get"><span class="std std-ref"><strong>xfel_event_code_get</strong></span></a></p> <td><p><strong>GET</strong> /xfel/event_code</p> <td><p>Return XFEL event codes for the current data acquisition</p> <tr class=row-odd ><td><p><em>DefaultApi</em></p> <td><p><a class="reference internal" href="docs/DefaultApi.html#xfel_pulse_id_get"><span class="std std-ref"><strong>xfel_pulse_id_get</strong></span></a></p> <td><p><strong>GET</strong> /xfel/pulse_id</p> <td><p>Return XFEL pulse IDs for the current data acquisition</p> </table> </section> <section id=documentation-for-models > <h2 id=documentation-for-models >Documentation For Models<a class=headerlink href="#documentation-for-models" title="Link to this heading">¶</a></h2> <ul class=simple > <li><p><a class="reference internal" href="docs/AzimIntSettings.html"><span class="std std-doc">AzimIntSettings</span></a></p> <li><p><a class="reference internal" href="docs/BrokerStatus.html"><span class="std std-doc">BrokerStatus</span></a></p> <li><p><a class="reference internal" href="docs/CalibrationStatisticsInner.html"><span class="std std-doc">CalibrationStatisticsInner</span></a></p> <li><p><a class="reference internal" href="docs/DarkMaskSettings.html"><span class="std std-doc">DarkMaskSettings</span></a></p> <li><p><a class="reference internal" href="docs/DatasetSettings.html"><span class="std std-doc">DatasetSettings</span></a></p> <li><p><a class="reference internal" href="docs/DatasetSettingsXrayFluorescenceSpectrum.html"><span class="std std-doc">DatasetSettingsXrayFluorescenceSpectrum</span></a></p> <li><p><a class="reference internal" href="docs/Detector.html"><span class="std std-doc">Detector</span></a></p> <li><p><a class="reference internal" href="docs/DetectorList.html"><span class="std std-doc">DetectorList</span></a></p> <li><p><a class="reference internal" href="docs/DetectorListElement.html"><span class="std std-doc">DetectorListElement</span></a></p> <li><p><a class="reference internal" href="docs/DetectorModule.html"><span class="std std-doc">DetectorModule</span></a></p> <li><p><a class="reference internal" href="docs/DetectorModuleDirection.html"><span class="std std-doc">DetectorModuleDirection</span></a></p> <li><p><a class="reference internal" href="docs/DetectorPowerState.html"><span class="std std-doc">DetectorPowerState</span></a></p> <li><p><a class="reference internal" href="docs/DetectorSelection.html"><span class="std std-doc">DetectorSelection</span></a></p> <li><p><a class="reference internal" href="docs/DetectorSettings.html"><span class="std std-doc">DetectorSettings</span></a></p> <li><p><a class="reference internal" href="docs/DetectorState.html"><span class="std std-doc">DetectorState</span></a></p> <li><p><a class="reference internal" href="docs/DetectorStatus.html"><span class="std std-doc">DetectorStatus</span></a></p> <li><p><a class="reference internal" href="docs/DetectorTiming.html"><span class="std std-doc">DetectorTiming</span></a></p> <li><p><a class="reference internal" href="docs/DetectorType.html"><span class="std std-doc">DetectorType</span></a></p> <li><p><a class="reference internal" href="docs/ErrorMessage.html"><span class="std std-doc">ErrorMessage</span></a></p> <li><p><a class="reference internal" href="docs/FileWriterFormat.html"><span class="std std-doc">FileWriterFormat</span></a></p> <li><p><a class="reference internal" href="docs/FileWriterSettings.html"><span class="std std-doc">FileWriterSettings</span></a></p> <li><p><a class="reference internal" href="docs/FpgaStatusInner.html"><span class="std std-doc">FpgaStatusInner</span></a></p> <li><p><a class="reference internal" href="docs/GeomRefinementAlgorithm.html"><span class="std std-doc">GeomRefinementAlgorithm</span></a></p> <li><p><a class="reference internal" href="docs/GridScan.html"><span class="std std-doc">GridScan</span></a></p> <li><p><a class="reference internal" href="docs/ImageBufferStatus.html"><span class="std std-doc">ImageBufferStatus</span></a></p> <li><p><a class="reference internal" href="docs/ImageFormatSettings.html"><span class="std std-doc">ImageFormatSettings</span></a></p> <li><p><a class="reference internal" href="docs/ImagePusherStatus.html"><span class="std std-doc">ImagePusherStatus</span></a></p> <li><p><a class="reference internal" href="docs/ImagePusherType.html"><span class="std std-doc">ImagePusherType</span></a></p> <li><p><a class="reference internal" href="docs/IndexingAlgorithm.html"><span class="std std-doc">IndexingAlgorithm</span></a></p> <li><p><a class="reference internal" href="docs/IndexingSettings.html"><span class="std std-doc">IndexingSettings</span></a></p> <li><p><a class="reference internal" href="docs/InstrumentMetadata.html"><span class="std std-doc">InstrumentMetadata</span></a></p> <li><p><a class="reference internal" href="docs/JfjochSettings.html"><span class="std std-doc">JfjochSettings</span></a></p> <li><p><a class="reference internal" href="docs/JfjochStatistics.html"><span class="std std-doc">JfjochStatistics</span></a></p> <li><p><a class="reference internal" href="docs/MeasurementStatistics.html"><span class="std std-doc">MeasurementStatistics</span></a></p> <li><p><a class="reference internal" href="docs/PcieDevicesInner.html"><span class="std std-doc">PcieDevicesInner</span></a></p> <li><p><a class="reference internal" href="docs/PixelMaskStatistics.html"><span class="std std-doc">PixelMaskStatistics</span></a></p> <li><p><a class="reference internal" href="docs/Plot.html"><span class="std std-doc">Plot</span></a></p> <li><p><a class="reference internal" href="docs/PlotUnitX.html"><span class="std std-doc">PlotUnitX</span></a></p> <li><p><a class="reference internal" href="docs/Plots.html"><span class="std std-doc">Plots</span></a></p> <li><p><a class="reference internal" href="docs/RoiAzimList.html"><span class="std std-doc">RoiAzimList</span></a></p> <li><p><a class="reference internal" href="docs/RoiAzimuthal.html"><span class="std std-doc">RoiAzimuthal</span></a></p> <li><p><a class="reference internal" href="docs/RoiBox.html"><span class="std std-doc">RoiBox</span></a></p> <li><p><a class="reference internal" href="docs/RoiBoxList.html"><span class="std std-doc">RoiBoxList</span></a></p> <li><p><a class="reference internal" href="docs/RoiCircle.html"><span class="std std-doc">RoiCircle</span></a></p> <li><p><a class="reference internal" href="docs/RoiCircleList.html"><span class="std std-doc">RoiCircleList</span></a></p> <li><p><a class="reference internal" href="docs/RoiDefinitions.html"><span class="std std-doc">RoiDefinitions</span></a></p> <li><p><a class="reference internal" href="docs/RotationAxis.html"><span class="std std-doc">RotationAxis</span></a></p> <li><p><a class="reference internal" href="docs/ScanResult.html"><span class="std std-doc">ScanResult</span></a></p> <li><p><a class="reference internal" href="docs/ScanResultImagesInner.html"><span class="std std-doc">ScanResultImagesInner</span></a></p> <li><p><a class="reference internal" href="docs/SpotFindingSettings.html"><span class="std std-doc">SpotFindingSettings</span></a></p> <li><p><a class="reference internal" href="docs/StandardDetectorGeometry.html"><span class="std std-doc">StandardDetectorGeometry</span></a></p> <li><p><a class="reference internal" href="docs/TcpSettings.html"><span class="std std-doc">TcpSettings</span></a></p> <li><p><a class="reference internal" href="docs/UnitCell.html"><span class="std std-doc">UnitCell</span></a></p> <li><p><a class="reference internal" href="docs/ZeromqMetadataSettings.html"><span class="std std-doc">ZeromqMetadataSettings</span></a></p> <li><p><a class="reference internal" href="docs/ZeromqPreviewSettings.html"><span class="std std-doc">ZeromqPreviewSettings</span></a></p> <li><p><a class="reference internal" href="docs/ZeromqSettings.html"><span class="std std-doc">ZeromqSettings</span></a></p> </ul> <p><a id=documentation-for-authorization ></a></p> </section> <section id=documentation-for-authorization > <h2 id=documentation-for-authorization >Documentation For Authorization<a class=headerlink href="#documentation-for-authorization" title="Link to this heading">¶</a></h2> <p>Endpoints do not require authorization.</p> </section> <section id=author > <h2 id=author >Author<a class=headerlink href="#author" title="Link to this heading">¶</a></h2> <p><a class="reference external" href="mailto:filip.leonarski%40psi.ch">filip<span>.</span>leonarski<span>@</span>psi<span>.</span>ch</a></p> </section> </section> </article> </div> </div> </main> </div> <footer class=md-footer > <div class=md-footer-nav > <nav class="md-footer-nav__inner md-grid"> <a href="../TESTS.html" title=Tests class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel=prev > <div class="md-flex__cell md-flex__cell--shrink"> <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> </div> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> <span class=md-flex__ellipsis > <span class=md-footer-nav__direction > "Previous" </span> Tests </span> </div> </a> <a href="docs/DefaultApi.html" title=jfjoch_client.DefaultApi class="md-flex md-footer-nav__link md-footer-nav__link--next" rel=next > <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span class=md-flex__ellipsis > <span class=md-footer-nav__direction > "Next" </span> jfjoch_client.DefaultApi </span> </div> <div class="md-flex__cell md-flex__cell--shrink"><i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright > <div class=md-footer-copyright__highlight > © Copyright 2024, Paul Scherrer Institute. </div> Created using <a href="http://www.sphinx-doc.org/">Sphinx</a> 8.1.3. and <a href="https://github.com/bashtage/sphinx-material/">Material for Sphinx</a> </div> </div> </div> </footer> <script src="../_static/javascripts/application.js"></script> <script>app.initialize({version: "1.0.4", url: {base: ".."}})</script>
