mx/Jungfraujoch
1
1
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 52 Wiki Activity
Files
5fdda01ff45574181cd4997370adabb7a2c9a8c4
Jungfraujoch/python_client/docs/DefaultApi.html
T
leonarski_f 5fdda01ff4 Deploy site
2026-05-01 16:49:38 +00:00

1450 lines
399 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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.DefaultApi &#8212; 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=prev title=jfjoch-client href="../README.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/docs/DefaultApi" 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 >&#xe30d</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.DefaultApi </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 > &#xE5CD; </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 >&#xe30d</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 > <a href="../README.html" class=md-nav__link >jfjoch-client</a> <li class=md-nav__item > <a href="../README.html#license-clarification" class=md-nav__link >License Clarification</a> <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.DefaultApi </label> <a href="#" class="md-nav__link md-nav__link--active">jfjoch_client.DefaultApi</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="#cancel-post" class=md-nav__link ><strong>cancel_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#example" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#parameters" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#return-type" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#authorization" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#http-request-headers" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#http-response-details" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-azim-int-get" class=md-nav__link ><strong>config_azim_int_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id1" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id2" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id3" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id4" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id5" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id6" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-azim-int-put" class=md-nav__link ><strong>config_azim_int_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id7" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id8" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id9" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id10" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id11" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id12" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-dark-mask-get" class=md-nav__link ><strong>config_dark_mask_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id13" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id14" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id15" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id16" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id17" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id18" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-dark-mask-put" class=md-nav__link ><strong>config_dark_mask_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id19" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id20" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id21" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id22" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id23" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id24" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-detector-get" class=md-nav__link ><strong>config_detector_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id25" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id26" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id27" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id28" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id29" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id30" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-detector-put" class=md-nav__link ><strong>config_detector_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id31" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id32" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id33" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id34" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id35" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id36" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-file-writer-get" class=md-nav__link ><strong>config_file_writer_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id37" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id38" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id39" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id40" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id41" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id42" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-file-writer-put" class=md-nav__link ><strong>config_file_writer_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id43" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id44" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id45" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id46" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id47" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id48" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-image-format-conversion-post" class=md-nav__link ><strong>config_image_format_conversion_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id49" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id50" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id51" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id52" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id53" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id54" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-image-format-get" class=md-nav__link ><strong>config_image_format_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id55" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id56" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id57" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id58" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id59" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id60" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-image-format-put" class=md-nav__link ><strong>config_image_format_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id61" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id62" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id63" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id64" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id65" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id66" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-image-format-raw-post" class=md-nav__link ><strong>config_image_format_raw_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id67" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id68" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id69" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id70" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id71" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id72" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-indexing-get" class=md-nav__link ><strong>config_indexing_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id73" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id74" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id75" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id76" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id77" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id78" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-indexing-put" class=md-nav__link ><strong>config_indexing_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id79" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id80" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id81" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id82" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id83" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id84" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-instrument-get" class=md-nav__link ><strong>config_instrument_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id85" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id86" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id87" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id88" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id89" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id90" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-instrument-put" class=md-nav__link ><strong>config_instrument_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id91" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id92" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id93" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id94" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id95" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id96" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-internal-generator-image-put" class=md-nav__link ><strong>config_internal_generator_image_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id97" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id98" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id99" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id100" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id101" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id102" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-internal-generator-image-tiff-put" class=md-nav__link ><strong>config_internal_generator_image_tiff_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id103" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id104" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id105" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id106" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id107" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id108" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-mask-get" class=md-nav__link ><strong>config_mask_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id109" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id110" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id111" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id112" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id113" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id114" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-mask-tiff-get" class=md-nav__link ><strong>config_mask_tiff_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id115" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id116" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id117" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id118" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id119" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id120" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-roi-get" class=md-nav__link ><strong>config_roi_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id121" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id122" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id123" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id124" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id125" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id126" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-roi-put" class=md-nav__link ><strong>config_roi_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id127" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id128" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id129" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id130" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id131" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id132" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-select-detector-get" class=md-nav__link ><strong>config_select_detector_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id133" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id134" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id135" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id136" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id137" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id138" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-select-detector-put" class=md-nav__link ><strong>config_select_detector_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id139" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id140" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id141" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id142" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id143" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id144" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-spot-finding-get" class=md-nav__link ><strong>config_spot_finding_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id145" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id146" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id147" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id148" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id149" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id150" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-spot-finding-put" class=md-nav__link ><strong>config_spot_finding_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id151" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id152" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id153" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id154" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id155" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id156" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-user-mask-get" class=md-nav__link ><strong>config_user_mask_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id157" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id158" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id159" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id160" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id161" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id162" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-user-mask-put" class=md-nav__link ><strong>config_user_mask_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id163" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id164" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id165" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id166" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id167" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id168" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-user-mask-tiff-get" class=md-nav__link ><strong>config_user_mask_tiff_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id169" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id170" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id171" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id172" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id173" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id174" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-user-mask-tiff-put" class=md-nav__link ><strong>config_user_mask_tiff_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id175" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id176" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id177" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id178" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id179" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id180" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-zeromq-metadata-get" class=md-nav__link ><strong>config_zeromq_metadata_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id181" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id182" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id183" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id184" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id185" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id186" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-zeromq-metadata-put" class=md-nav__link ><strong>config_zeromq_metadata_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id187" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id188" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id189" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id190" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id191" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id192" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-zeromq-preview-get" class=md-nav__link ><strong>config_zeromq_preview_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id193" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id194" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id195" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id196" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id197" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id198" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#config-zeromq-preview-put" class=md-nav__link ><strong>config_zeromq_preview_put</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id199" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id200" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id201" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id202" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id203" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id204" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#deactivate-post" class=md-nav__link ><strong>deactivate_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id205" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id206" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id207" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id208" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id209" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id210" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#detector-status-get" class=md-nav__link ><strong>detector_status_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id211" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id212" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id213" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id214" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id215" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id216" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#fpga-status-get" class=md-nav__link ><strong>fpga_status_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id217" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id218" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id219" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id220" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id221" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id222" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#image-buffer-clear-post" class=md-nav__link ><strong>image_buffer_clear_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id223" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id224" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id225" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id226" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id227" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id228" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#image-buffer-image-cbor-get" class=md-nav__link ><strong>image_buffer_image_cbor_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id229" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id230" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id231" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id232" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id233" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id234" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#image-buffer-image-jpeg-get" class=md-nav__link ><strong>image_buffer_image_jpeg_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id235" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id236" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id237" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id238" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id239" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id240" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#image-buffer-image-tiff-get" class=md-nav__link ><strong>image_buffer_image_tiff_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id241" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id242" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id243" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id244" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id245" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id246" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#image-buffer-start-cbor-get" class=md-nav__link ><strong>image_buffer_start_cbor_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id247" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id248" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id249" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id250" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id251" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id252" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#image-buffer-status-get" class=md-nav__link ><strong>image_buffer_status_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id253" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id254" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id255" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id256" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id257" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id258" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#image-pusher-status-get" class=md-nav__link ><strong>image_pusher_status_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id259" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id260" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id261" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id262" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id263" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id264" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#initialize-post" class=md-nav__link ><strong>initialize_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id265" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id266" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id267" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id268" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id269" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id270" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#pedestal-post" class=md-nav__link ><strong>pedestal_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id271" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id272" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id273" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id274" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id275" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id276" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#preview-pedestal-tiff-get" class=md-nav__link ><strong>preview_pedestal_tiff_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id277" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id278" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id279" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id280" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id281" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id282" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#preview-plot-bin-get" class=md-nav__link ><strong>preview_plot_bin_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id283" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id284" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id285" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id286" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id287" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id288" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#preview-plot-get" class=md-nav__link ><strong>preview_plot_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id289" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id290" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id291" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id292" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id293" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id294" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#result-scan-get" class=md-nav__link ><strong>result_scan_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id295" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id296" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id297" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id298" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id299" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id300" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#start-post" class=md-nav__link ><strong>start_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id301" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id302" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id303" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id304" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id305" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id306" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#statistics-calibration-get" class=md-nav__link ><strong>statistics_calibration_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id307" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id308" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id309" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id310" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id311" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id312" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#statistics-data-collection-get" class=md-nav__link ><strong>statistics_data_collection_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id313" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id314" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id315" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id316" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id317" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id318" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#statistics-get" class=md-nav__link ><strong>statistics_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id319" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id320" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id321" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id322" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id323" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id324" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#status-get" class=md-nav__link ><strong>status_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id325" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id326" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id327" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id328" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id329" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id330" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#trigger-post" class=md-nav__link ><strong>trigger_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id331" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id332" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id333" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id334" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id335" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id336" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#version-get" class=md-nav__link ><strong>version_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id337" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id338" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id339" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id340" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id341" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id342" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#wait-till-done-post" class=md-nav__link ><strong>wait_till_done_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id343" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id344" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id345" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id346" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id347" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id348" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#wait-until-running-post" class=md-nav__link ><strong>wait_until_running_post</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id349" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id350" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id351" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id352" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id353" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id354" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#xfel-event-code-get" class=md-nav__link ><strong>xfel_event_code_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id355" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id356" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id357" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id358" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id359" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id360" class=md-nav__link >HTTP response details</a> </ul> <li class=md-nav__item > <a href="#xfel-pulse-id-get" class=md-nav__link ><strong>xfel_pulse_id_get</strong></a> <ul class=md-nav__list > <li class=md-nav__item > <a href="#id361" class=md-nav__link >Example</a> <li class=md-nav__item > <a href="#id362" class=md-nav__link >Parameters</a> <li class=md-nav__item > <a href="#id363" class=md-nav__link >Return type</a> <li class=md-nav__item > <a href="#id364" class=md-nav__link >Authorization</a> <li class=md-nav__item > <a href="#id365" class=md-nav__link >HTTP request headers</a> <li class=md-nav__item > <a href="#id366" class=md-nav__link >HTTP response details</a> </ul> </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-defaultapi > <h1 id=python-client-docs-defaultapi--page-root >jfjoch_client.DefaultApi<a class=headerlink href="#python-client-docs-defaultapi--page-root" title="Link to this heading"></a></h1> <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>Method</p> <th class=head ><p>HTTP request</p> <th class=head ><p>Description</p> <tr class=row-even ><td><p><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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><a class="reference internal" href="#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 class="tex2jax_ignore mathjax_ignore" id=cancel-post > <h1 id=cancel-post ><strong>cancel_post</strong><a class=headerlink href="#cancel-post" title="Link to this heading"></a></h1> <blockquote> <div><p>cancel_post()</p> </div></blockquote> <p>Cancel running data collection</p> <p>Command will inform FPGA network card to stop pedestal or data collection at the current stage. Any frame that is currently being processed by CPU will be finished and sent to writer. Given the command is making sure to gracefully stop data acquisition and detector, it might take some time to switch back after command finished to <code class="docutils literal notranslate"><span class=pre >Idle</span></code> state.</p> <p>If data collection is not running, the command has no effect.</p> <section id=example > <h2 id=example >Example<a class=headerlink href="#example" title="Link to this heading"></a></h2> <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=ne >Exception</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-&gt;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=parameters > <h2 id=parameters >Parameters<a class=headerlink href="#parameters" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=return-type > <h2 id=return-type >Return type<a class=headerlink href="#return-type" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=authorization > <h2 id=authorization >Authorization<a class=headerlink href="#authorization" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=http-request-headers > <h2 id=http-request-headers >HTTP request headers<a class=headerlink href="#http-request-headers" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: Not defined</p> </ul> </section> <section id=http-response-details > <h2 id=http-response-details >HTTP response details<a class=headerlink href="#http-response-details" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Cancel request sent to FPGAs (or ignored, as data collection is not running)</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-azim-int-get > <h1 id=config-azim-int-get ><strong>config_azim_int_get</strong><a class=headerlink href="#config-azim-int-get" title="Link to this heading"></a></h1> <blockquote> <div><p>AzimIntSettings config_azim_int_get()</p> </div></blockquote> <p>Get azimuthal integration configuration</p> <p>Can be done anytime</p> <section id=id1 > <h2 id=id1 >Example<a class=headerlink href="#id1" title="Link to this heading"></a></h2> <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.models.azim_int_settings</span> <span class=kn >import</span> <span class=n >AzimIntSettings</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 ># Get azimuthal integration configuration</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_azim_int_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_azim_int_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_azim_int_get: </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=id2 > <h2 id=id2 >Parameters<a class=headerlink href="#id2" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id3 > <h2 id=id3 >Return type<a class=headerlink href="#id3" title="Link to this heading"></a></h2> <p><a class="reference internal" href=AzimIntSettings.html ><span class="std std-doc"><strong>AzimIntSettings</strong></span></a></p> </section> <section id=id4 > <h2 id=id4 >Authorization<a class=headerlink href="#id4" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id5 > <h2 id=id5 >HTTP request headers<a class=headerlink href="#id5" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id6 > <h2 id=id6 >HTTP response details<a class=headerlink href="#id6" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-azim-int-put > <h1 id=config-azim-int-put ><strong>config_azim_int_put</strong><a class=headerlink href="#config-azim-int-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_azim_int_put(azim_int_settings=azim_int_settings)</p> </div></blockquote> <p>Configure azimuthal integration</p> <p>Can be done when detector is Inactive or Idle</p> <section id=id7 > <h2 id=id7 >Example<a class=headerlink href="#id7" title="Link to this heading"></a></h2> <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.models.azim_int_settings</span> <span class=kn >import</span> <span class=n >AzimIntSettings</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=n >azim_int_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >AzimIntSettings</span><span class=p >()</span> <span class=c1 ># AzimIntSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Configure azimuthal integration</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_azim_int_put</span><span class=p >(</span><span class=n >azim_int_settings</span><span class=o >=</span><span class=n >azim_int_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_azim_int_put: </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=id8 > <h2 id=id8 >Parameters<a class=headerlink href="#id8" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>azim_int_settings</strong></p> <td><p><a class="reference internal" href=AzimIntSettings.html ><span class="std std-doc"><strong>AzimIntSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id9 > <h2 id=id9 >Return type<a class=headerlink href="#id9" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id10 > <h2 id=id10 >Authorization<a class=headerlink href="#id10" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id11 > <h2 id=id11 >HTTP request headers<a class=headerlink href="#id11" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id12 > <h2 id=id12 >HTTP response details<a class=headerlink href="#id12" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-dark-mask-get > <h1 id=config-dark-mask-get ><strong>config_dark_mask_get</strong><a class=headerlink href="#config-dark-mask-get" title="Link to this heading"></a></h1> <blockquote> <div><p>DarkMaskSettings config_dark_mask_get()</p> </div></blockquote> <p>Get settings for dark data collection to calculate mask</p> <section id=id13 > <h2 id=id13 >Example<a class=headerlink href="#id13" title="Link to this heading"></a></h2> <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.models.dark_mask_settings</span> <span class=kn >import</span> <span class=n >DarkMaskSettings</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 ># Get settings for dark data collection to calculate mask</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_dark_mask_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_dark_mask_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_dark_mask_get: </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=id14 > <h2 id=id14 >Parameters<a class=headerlink href="#id14" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id15 > <h2 id=id15 >Return type<a class=headerlink href="#id15" title="Link to this heading"></a></h2> <p><a class="reference internal" href=DarkMaskSettings.html ><span class="std std-doc"><strong>DarkMaskSettings</strong></span></a></p> </section> <section id=id16 > <h2 id=id16 >Authorization<a class=headerlink href="#id16" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id17 > <h2 id=id17 >HTTP request headers<a class=headerlink href="#id17" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id18 > <h2 id=id18 >HTTP response details<a class=headerlink href="#id18" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-dark-mask-put > <h1 id=config-dark-mask-put ><strong>config_dark_mask_put</strong><a class=headerlink href="#config-dark-mask-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_dark_mask_put(dark_mask_settings=dark_mask_settings)</p> </div></blockquote> <p>Set configuration for dark data collection to calculate mask</p> <p>This is only possible when operating DECTRIS detectors at the moment; it will be also available for PSI EIGER at some point. This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states.</p> <section id=id19 > <h2 id=id19 >Example<a class=headerlink href="#id19" title="Link to this heading"></a></h2> <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.models.dark_mask_settings</span> <span class=kn >import</span> <span class=n >DarkMaskSettings</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=n >dark_mask_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >DarkMaskSettings</span><span class=p >()</span> <span class=c1 ># DarkMaskSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Set configuration for dark data collection to calculate mask</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_dark_mask_put</span><span class=p >(</span><span class=n >dark_mask_settings</span><span class=o >=</span><span class=n >dark_mask_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_dark_mask_put: </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=id20 > <h2 id=id20 >Parameters<a class=headerlink href="#id20" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>dark_mask_settings</strong></p> <td><p><a class="reference internal" href=DarkMaskSettings.html ><span class="std std-doc"><strong>DarkMaskSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id21 > <h2 id=id21 >Return type<a class=headerlink href="#id21" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id22 > <h2 id=id22 >Authorization<a class=headerlink href="#id22" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id23 > <h2 id=id23 >HTTP request headers<a class=headerlink href="#id23" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id24 > <h2 id=id24 >HTTP response details<a class=headerlink href="#id24" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-detector-get > <h1 id=config-detector-get ><strong>config_detector_get</strong><a class=headerlink href="#config-detector-get" title="Link to this heading"></a></h1> <blockquote> <div><p>DetectorSettings config_detector_get()</p> </div></blockquote> <p>Get detector configuration</p> <p>Can be done anytime</p> <section id=id25 > <h2 id=id25 >Example<a class=headerlink href="#id25" title="Link to this heading"></a></h2> <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.models.detector_settings</span> <span class=kn >import</span> <span class=n >DetectorSettings</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 ># Get detector configuration</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_detector_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_detector_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_detector_get: </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=id26 > <h2 id=id26 >Parameters<a class=headerlink href="#id26" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id27 > <h2 id=id27 >Return type<a class=headerlink href="#id27" title="Link to this heading"></a></h2> <p><a class="reference internal" href=DetectorSettings.html ><span class="std std-doc"><strong>DetectorSettings</strong></span></a></p> </section> <section id=id28 > <h2 id=id28 >Authorization<a class=headerlink href="#id28" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id29 > <h2 id=id29 >HTTP request headers<a class=headerlink href="#id29" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id30 > <h2 id=id30 >HTTP response details<a class=headerlink href="#id30" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-detector-put > <h1 id=config-detector-put ><strong>config_detector_put</strong><a class=headerlink href="#config-detector-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_detector_put(detector_settings=detector_settings)</p> </div></blockquote> <p>Change detector configuration</p> <p>Detector settings are ones that have effect on calibration, i.e., pedestal has to be collected again after changing these settings. This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states. If detector is in <code class="docutils literal notranslate"><span class=pre >Idle</span></code> state , pedestal procedure will be executed automatically - there must be no X-rays on the detector during the operation. If detector is in <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> or <code class="docutils literal notranslate"><span class=pre >Error</span></code> states, new settings will be saved, but no calibration will be executed.</p> <section id=id31 > <h2 id=id31 >Example<a class=headerlink href="#id31" title="Link to this heading"></a></h2> <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.models.detector_settings</span> <span class=kn >import</span> <span class=n >DetectorSettings</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=n >detector_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >DetectorSettings</span><span class=p >()</span> <span class=c1 ># DetectorSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Change detector configuration</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_detector_put</span><span class=p >(</span><span class=n >detector_settings</span><span class=o >=</span><span class=n >detector_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_detector_put: </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=id32 > <h2 id=id32 >Parameters<a class=headerlink href="#id32" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>detector_settings</strong></p> <td><p><a class="reference internal" href=DetectorSettings.html ><span class="std std-doc"><strong>DetectorSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id33 > <h2 id=id33 >Return type<a class=headerlink href="#id33" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id34 > <h2 id=id34 >Authorization<a class=headerlink href="#id34" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id35 > <h2 id=id35 >HTTP request headers<a class=headerlink href="#id35" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id36 > <h2 id=id36 >HTTP response details<a class=headerlink href="#id36" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-file-writer-get > <h1 id=config-file-writer-get ><strong>config_file_writer_get</strong><a class=headerlink href="#config-file-writer-get" title="Link to this heading"></a></h1> <blockquote> <div><p>FileWriterSettings config_file_writer_get()</p> </div></blockquote> <p>Get file writer settings</p> <p>Can be done anytime</p> <section id=id37 > <h2 id=id37 >Example<a class=headerlink href="#id37" title="Link to this heading"></a></h2> <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.models.file_writer_settings</span> <span class=kn >import</span> <span class=n >FileWriterSettings</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 ># Get file writer settings</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_file_writer_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_file_writer_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_file_writer_get: </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=id38 > <h2 id=id38 >Parameters<a class=headerlink href="#id38" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id39 > <h2 id=id39 >Return type<a class=headerlink href="#id39" title="Link to this heading"></a></h2> <p><a class="reference internal" href=FileWriterSettings.html ><span class="std std-doc"><strong>FileWriterSettings</strong></span></a></p> </section> <section id=id40 > <h2 id=id40 >Authorization<a class=headerlink href="#id40" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id41 > <h2 id=id41 >HTTP request headers<a class=headerlink href="#id41" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id42 > <h2 id=id42 >HTTP response details<a class=headerlink href="#id42" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-file-writer-put > <h1 id=config-file-writer-put ><strong>config_file_writer_put</strong><a class=headerlink href="#config-file-writer-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_file_writer_put(file_writer_settings=file_writer_settings)</p> </div></blockquote> <p>Change file writer settings</p> <p>This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states.</p> <section id=id43 > <h2 id=id43 >Example<a class=headerlink href="#id43" title="Link to this heading"></a></h2> <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.models.file_writer_settings</span> <span class=kn >import</span> <span class=n >FileWriterSettings</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=n >file_writer_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >FileWriterSettings</span><span class=p >()</span> <span class=c1 ># FileWriterSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Change file writer settings</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_file_writer_put</span><span class=p >(</span><span class=n >file_writer_settings</span><span class=o >=</span><span class=n >file_writer_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_file_writer_put: </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=id44 > <h2 id=id44 >Parameters<a class=headerlink href="#id44" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>file_writer_settings</strong></p> <td><p><a class="reference internal" href=FileWriterSettings.html ><span class="std std-doc"><strong>FileWriterSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id45 > <h2 id=id45 >Return type<a class=headerlink href="#id45" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id46 > <h2 id=id46 >Authorization<a class=headerlink href="#id46" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id47 > <h2 id=id47 >HTTP request headers<a class=headerlink href="#id47" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id48 > <h2 id=id48 >HTTP response details<a class=headerlink href="#id48" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-image-format-conversion-post > <h1 id=config-image-format-conversion-post ><strong>config_image_format_conversion_post</strong><a class=headerlink href="#config-image-format-conversion-post" title="Link to this heading"></a></h1> <blockquote> <div><p>config_image_format_conversion_post()</p> </div></blockquote> <p>Configure format for data collection with full conversion</p> <p>This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states.</p> <section id=id49 > <h2 id=id49 >Example<a class=headerlink href="#id49" title="Link to this heading"></a></h2> <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 ># Configure format for data collection with full conversion</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_image_format_conversion_post</span><span class=p >()</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_image_format_conversion_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=id50 > <h2 id=id50 >Parameters<a class=headerlink href="#id50" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id51 > <h2 id=id51 >Return type<a class=headerlink href="#id51" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id52 > <h2 id=id52 >Authorization<a class=headerlink href="#id52" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id53 > <h2 id=id53 >HTTP request headers<a class=headerlink href="#id53" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id54 > <h2 id=id54 >HTTP response details<a class=headerlink href="#id54" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-image-format-get > <h1 id=config-image-format-get ><strong>config_image_format_get</strong><a class=headerlink href="#config-image-format-get" title="Link to this heading"></a></h1> <blockquote> <div><p>ImageFormatSettings config_image_format_get()</p> </div></blockquote> <p>Get image output format</p> <p>Can be done anytime</p> <section id=id55 > <h2 id=id55 >Example<a class=headerlink href="#id55" title="Link to this heading"></a></h2> <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.models.image_format_settings</span> <span class=kn >import</span> <span class=n >ImageFormatSettings</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 ># Get image output format</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_image_format_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_image_format_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_image_format_get: </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=id56 > <h2 id=id56 >Parameters<a class=headerlink href="#id56" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id57 > <h2 id=id57 >Return type<a class=headerlink href="#id57" title="Link to this heading"></a></h2> <p><a class="reference internal" href=ImageFormatSettings.html ><span class="std std-doc"><strong>ImageFormatSettings</strong></span></a></p> </section> <section id=id58 > <h2 id=id58 >Authorization<a class=headerlink href="#id58" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id59 > <h2 id=id59 >HTTP request headers<a class=headerlink href="#id59" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id60 > <h2 id=id60 >HTTP response details<a class=headerlink href="#id60" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-image-format-put > <h1 id=config-image-format-put ><strong>config_image_format_put</strong><a class=headerlink href="#config-image-format-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_image_format_put(image_format_settings=image_format_settings)</p> </div></blockquote> <p>Change image output format</p> <p>This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states.</p> <section id=id61 > <h2 id=id61 >Example<a class=headerlink href="#id61" title="Link to this heading"></a></h2> <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.models.image_format_settings</span> <span class=kn >import</span> <span class=n >ImageFormatSettings</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=n >image_format_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >ImageFormatSettings</span><span class=p >()</span> <span class=c1 ># ImageFormatSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Change image output format</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_image_format_put</span><span class=p >(</span><span class=n >image_format_settings</span><span class=o >=</span><span class=n >image_format_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_image_format_put: </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=id62 > <h2 id=id62 >Parameters<a class=headerlink href="#id62" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>image_format_settings</strong></p> <td><p><a class="reference internal" href=ImageFormatSettings.html ><span class="std std-doc"><strong>ImageFormatSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id63 > <h2 id=id63 >Return type<a class=headerlink href="#id63" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id64 > <h2 id=id64 >Authorization<a class=headerlink href="#id64" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id65 > <h2 id=id65 >HTTP request headers<a class=headerlink href="#id65" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id66 > <h2 id=id66 >HTTP response details<a class=headerlink href="#id66" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-image-format-raw-post > <h1 id=config-image-format-raw-post ><strong>config_image_format_raw_post</strong><a class=headerlink href="#config-image-format-raw-post" title="Link to this heading"></a></h1> <blockquote> <div><p>config_image_format_raw_post()</p> </div></blockquote> <p>Configure format for raw data collection</p> <p>This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states.</p> <section id=id67 > <h2 id=id67 >Example<a class=headerlink href="#id67" title="Link to this heading"></a></h2> <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 ># Configure format for raw data collection</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_image_format_raw_post</span><span class=p >()</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_image_format_raw_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=id68 > <h2 id=id68 >Parameters<a class=headerlink href="#id68" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id69 > <h2 id=id69 >Return type<a class=headerlink href="#id69" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id70 > <h2 id=id70 >Authorization<a class=headerlink href="#id70" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id71 > <h2 id=id71 >HTTP request headers<a class=headerlink href="#id71" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id72 > <h2 id=id72 >HTTP response details<a class=headerlink href="#id72" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-indexing-get > <h1 id=config-indexing-get ><strong>config_indexing_get</strong><a class=headerlink href="#config-indexing-get" title="Link to this heading"></a></h1> <blockquote> <div><p>IndexingSettings config_indexing_get()</p> </div></blockquote> <p>Get indexing configuration</p> <p>Can be done anytime</p> <section id=id73 > <h2 id=id73 >Example<a class=headerlink href="#id73" title="Link to this heading"></a></h2> <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.models.indexing_settings</span> <span class=kn >import</span> <span class=n >IndexingSettings</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 ># Get indexing configuration</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_indexing_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_indexing_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_indexing_get: </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=id74 > <h2 id=id74 >Parameters<a class=headerlink href="#id74" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id75 > <h2 id=id75 >Return type<a class=headerlink href="#id75" title="Link to this heading"></a></h2> <p><a class="reference internal" href=IndexingSettings.html ><span class="std std-doc"><strong>IndexingSettings</strong></span></a></p> </section> <section id=id76 > <h2 id=id76 >Authorization<a class=headerlink href="#id76" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id77 > <h2 id=id77 >HTTP request headers<a class=headerlink href="#id77" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id78 > <h2 id=id78 >HTTP response details<a class=headerlink href="#id78" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-indexing-put > <h1 id=config-indexing-put ><strong>config_indexing_put</strong><a class=headerlink href="#config-indexing-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_indexing_put(indexing_settings=indexing_settings)</p> </div></blockquote> <p>Change indexing algorithm settings</p> <p>This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states.</p> <section id=id79 > <h2 id=id79 >Example<a class=headerlink href="#id79" title="Link to this heading"></a></h2> <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.models.indexing_settings</span> <span class=kn >import</span> <span class=n >IndexingSettings</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=n >indexing_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >IndexingSettings</span><span class=p >()</span> <span class=c1 ># IndexingSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Change indexing algorithm settings</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_indexing_put</span><span class=p >(</span><span class=n >indexing_settings</span><span class=o >=</span><span class=n >indexing_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_indexing_put: </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=id80 > <h2 id=id80 >Parameters<a class=headerlink href="#id80" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>indexing_settings</strong></p> <td><p><a class="reference internal" href=IndexingSettings.html ><span class="std std-doc"><strong>IndexingSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id81 > <h2 id=id81 >Return type<a class=headerlink href="#id81" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id82 > <h2 id=id82 >Authorization<a class=headerlink href="#id82" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id83 > <h2 id=id83 >HTTP request headers<a class=headerlink href="#id83" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id84 > <h2 id=id84 >HTTP response details<a class=headerlink href="#id84" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-instrument-get > <h1 id=config-instrument-get ><strong>config_instrument_get</strong><a class=headerlink href="#config-instrument-get" title="Link to this heading"></a></h1> <blockquote> <div><p>InstrumentMetadata config_instrument_get()</p> </div></blockquote> <p>Get instrument metadata</p> <p>Can be done anytime</p> <section id=id85 > <h2 id=id85 >Example<a class=headerlink href="#id85" title="Link to this heading"></a></h2> <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.models.instrument_metadata</span> <span class=kn >import</span> <span class=n >InstrumentMetadata</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 ># Get instrument metadata</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_instrument_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_instrument_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_instrument_get: </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=id86 > <h2 id=id86 >Parameters<a class=headerlink href="#id86" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id87 > <h2 id=id87 >Return type<a class=headerlink href="#id87" title="Link to this heading"></a></h2> <p><a class="reference internal" href=InstrumentMetadata.html ><span class="std std-doc"><strong>InstrumentMetadata</strong></span></a></p> </section> <section id=id88 > <h2 id=id88 >Authorization<a class=headerlink href="#id88" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id89 > <h2 id=id89 >HTTP request headers<a class=headerlink href="#id89" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id90 > <h2 id=id90 >HTTP response details<a class=headerlink href="#id90" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-instrument-put > <h1 id=config-instrument-put ><strong>config_instrument_put</strong><a class=headerlink href="#config-instrument-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_instrument_put(instrument_metadata=instrument_metadata)</p> </div></blockquote> <p>Change instrument metadata</p> <p>This can only be done when detector is <code class="docutils literal notranslate"><span class=pre >Idle</span></code>, <code class="docutils literal notranslate"><span class=pre >Error</span></code> or <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> states.</p> <section id=id91 > <h2 id=id91 >Example<a class=headerlink href="#id91" title="Link to this heading"></a></h2> <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.models.instrument_metadata</span> <span class=kn >import</span> <span class=n >InstrumentMetadata</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=n >instrument_metadata</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >InstrumentMetadata</span><span class=p >()</span> <span class=c1 ># InstrumentMetadata | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Change instrument metadata</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_instrument_put</span><span class=p >(</span><span class=n >instrument_metadata</span><span class=o >=</span><span class=n >instrument_metadata</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_instrument_put: </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=id92 > <h2 id=id92 >Parameters<a class=headerlink href="#id92" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>instrument_metadata</strong></p> <td><p><a class="reference internal" href=InstrumentMetadata.html ><span class="std std-doc"><strong>InstrumentMetadata</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id93 > <h2 id=id93 >Return type<a class=headerlink href="#id93" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id94 > <h2 id=id94 >Authorization<a class=headerlink href="#id94" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id95 > <h2 id=id95 >HTTP request headers<a class=headerlink href="#id95" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id96 > <h2 id=id96 >HTTP response details<a class=headerlink href="#id96" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-internal-generator-image-put > <h1 id=config-internal-generator-image-put ><strong>config_internal_generator_image_put</strong><a class=headerlink href="#config-internal-generator-image-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_internal_generator_image_put(id=id, body=body)</p> </div></blockquote> <p>Load binary image for internal FPGA generator</p> <p>Load image for internal FPGA generator. This can only happen in Idle state of the detector. Requires binary blob with 16-bit integer numbers of size of detector in raw/converted coordinates (depending on detector settings).</p> <section id=id97 > <h2 id=id97 >Example<a class=headerlink href="#id97" title="Link to this heading"></a></h2> <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=nb >id</span> <span class=o >=</span> <span class=mi >56</span> <span class=c1 ># int | Image id to upload (optional)</span>
<span class=n >body</span> <span class=o >=</span> <span class=kc >None</span> <span class=c1 ># bytearray | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Load binary image for internal FPGA generator</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_internal_generator_image_put</span><span class=p >(</span><span class=nb >id</span><span class=o >=</span><span class=nb >id</span><span class=p >,</span> <span class=n >body</span><span class=o >=</span><span class=n >body</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_internal_generator_image_put: </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=id98 > <h2 id=id98 >Parameters<a class=headerlink href="#id98" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>id</strong></p> <td><p><strong>int</strong></p> <td><p>Image id to upload</p> <td><p>[optional]</p> <tr class=row-odd ><td><p><strong>body</strong></p> <td><p><strong>bytearray</strong></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id99 > <h2 id=id99 >Return type<a class=headerlink href="#id99" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id100 > <h2 id=id100 >Authorization<a class=headerlink href="#id100" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id101 > <h2 id=id101 >HTTP request headers<a class=headerlink href="#id101" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/octet-stream</p> <li><p><strong>Accept</strong>: text/plain</p> </ul> </section> <section id=id102 > <h2 id=id102 >HTTP response details<a class=headerlink href="#id102" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-internal-generator-image-tiff-put > <h1 id=config-internal-generator-image-tiff-put ><strong>config_internal_generator_image_tiff_put</strong><a class=headerlink href="#config-internal-generator-image-tiff-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_internal_generator_image_tiff_put(id=id, body=body)</p> </div></blockquote> <p>Load TIFF image for internal FPGA generator</p> <p>Load image for internal FPGA generator. This can only happen in Idle state of the detector. Requires TIFF with 16-bit integer numbers of size of detector in raw/converted coordinates (depending on detector settings).</p> <section id=id103 > <h2 id=id103 >Example<a class=headerlink href="#id103" title="Link to this heading"></a></h2> <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=nb >id</span> <span class=o >=</span> <span class=mi >56</span> <span class=c1 ># int | Image ID to upload (optional)</span>
<span class=n >body</span> <span class=o >=</span> <span class=kc >None</span> <span class=c1 ># bytearray | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Load TIFF image for internal FPGA generator</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_internal_generator_image_tiff_put</span><span class=p >(</span><span class=nb >id</span><span class=o >=</span><span class=nb >id</span><span class=p >,</span> <span class=n >body</span><span class=o >=</span><span class=n >body</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_internal_generator_image_tiff_put: </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=id104 > <h2 id=id104 >Parameters<a class=headerlink href="#id104" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>id</strong></p> <td><p><strong>int</strong></p> <td><p>Image ID to upload</p> <td><p>[optional]</p> <tr class=row-odd ><td><p><strong>body</strong></p> <td><p><strong>bytearray</strong></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id105 > <h2 id=id105 >Return type<a class=headerlink href="#id105" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id106 > <h2 id=id106 >Authorization<a class=headerlink href="#id106" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id107 > <h2 id=id107 >HTTP request headers<a class=headerlink href="#id107" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: image/tiff</p> <li><p><strong>Accept</strong>: text/plain</p> </ul> </section> <section id=id108 > <h2 id=id108 >HTTP response details<a class=headerlink href="#id108" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-mask-get > <h1 id=config-mask-get ><strong>config_mask_get</strong><a class=headerlink href="#config-mask-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray config_mask_get()</p> </div></blockquote> <p>Get mask of the detector (binary)</p> <p>Detector must be Initialized. Get full pixel mask of the detector. See NXmx standard for meaning of pixel values.</p> <section id=id109 > <h2 id=id109 >Example<a class=headerlink href="#id109" title="Link to this heading"></a></h2> <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 ># Get mask of the detector (binary)</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_mask_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_mask_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_mask_get: </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=id110 > <h2 id=id110 >Parameters<a class=headerlink href="#id110" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id111 > <h2 id=id111 >Return type<a class=headerlink href="#id111" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id112 > <h2 id=id112 >Authorization<a class=headerlink href="#id112" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id113 > <h2 id=id113 >HTTP request headers<a class=headerlink href="#id113" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/octet-stream</p> </ul> </section> <section id=id114 > <h2 id=id114 >HTTP response details<a class=headerlink href="#id114" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Binary array (4 byte; unsigned)</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-mask-tiff-get > <h1 id=config-mask-tiff-get ><strong>config_mask_tiff_get</strong><a class=headerlink href="#config-mask-tiff-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray config_mask_tiff_get()</p> </div></blockquote> <p>Get mask of the detector (TIFF)</p> <p>Should be in <code class="docutils literal notranslate"><span class=pre >Idle</span></code> state. Get full pixel mask of the detector See NXmx standard for meaning of pixel values</p> <section id=id115 > <h2 id=id115 >Example<a class=headerlink href="#id115" title="Link to this heading"></a></h2> <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 ># Get mask of the detector (TIFF)</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_mask_tiff_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_mask_tiff_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_mask_tiff_get: </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=id116 > <h2 id=id116 >Parameters<a class=headerlink href="#id116" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id117 > <h2 id=id117 >Return type<a class=headerlink href="#id117" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id118 > <h2 id=id118 >Authorization<a class=headerlink href="#id118" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id119 > <h2 id=id119 >HTTP request headers<a class=headerlink href="#id119" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: image/tiff</p> </ul> </section> <section id=id120 > <h2 id=id120 >HTTP response details<a class=headerlink href="#id120" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Pixel mask in TIFF format (4 byte; unsigned)</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-roi-get > <h1 id=config-roi-get ><strong>config_roi_get</strong><a class=headerlink href="#config-roi-get" title="Link to this heading"></a></h1> <blockquote> <div><p>RoiDefinitions config_roi_get()</p> </div></blockquote> <p>Get ROI definitions</p> <section id=id121 > <h2 id=id121 >Example<a class=headerlink href="#id121" title="Link to this heading"></a></h2> <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.models.roi_definitions</span> <span class=kn >import</span> <span class=n >RoiDefinitions</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 ># Get ROI definitions</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_roi_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_roi_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_roi_get: </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=id122 > <h2 id=id122 >Parameters<a class=headerlink href="#id122" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id123 > <h2 id=id123 >Return type<a class=headerlink href="#id123" title="Link to this heading"></a></h2> <p><a class="reference internal" href=RoiDefinitions.html ><span class="std std-doc"><strong>RoiDefinitions</strong></span></a></p> </section> <section id=id124 > <h2 id=id124 >Authorization<a class=headerlink href="#id124" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id125 > <h2 id=id125 >HTTP request headers<a class=headerlink href="#id125" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id126 > <h2 id=id126 >HTTP response details<a class=headerlink href="#id126" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-roi-put > <h1 id=config-roi-put ><strong>config_roi_put</strong><a class=headerlink href="#config-roi-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_roi_put(roi_definitions=roi_definitions)</p> </div></blockquote> <p>Upload ROI definitions</p> <section id=id127 > <h2 id=id127 >Example<a class=headerlink href="#id127" title="Link to this heading"></a></h2> <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.models.roi_definitions</span> <span class=kn >import</span> <span class=n >RoiDefinitions</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=n >roi_definitions</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >RoiDefinitions</span><span class=p >()</span> <span class=c1 ># RoiDefinitions | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Upload ROI definitions</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_roi_put</span><span class=p >(</span><span class=n >roi_definitions</span><span class=o >=</span><span class=n >roi_definitions</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_roi_put: </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=id128 > <h2 id=id128 >Parameters<a class=headerlink href="#id128" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>roi_definitions</strong></p> <td><p><a class="reference internal" href=RoiDefinitions.html ><span class="std std-doc"><strong>RoiDefinitions</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id129 > <h2 id=id129 >Return type<a class=headerlink href="#id129" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id130 > <h2 id=id130 >Authorization<a class=headerlink href="#id130" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id131 > <h2 id=id131 >HTTP request headers<a class=headerlink href="#id131" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id132 > <h2 id=id132 >HTTP response details<a class=headerlink href="#id132" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-select-detector-get > <h1 id=config-select-detector-get ><strong>config_select_detector_get</strong><a class=headerlink href="#config-select-detector-get" title="Link to this heading"></a></h1> <blockquote> <div><p>DetectorList config_select_detector_get()</p> </div></blockquote> <p>List available detectors</p> <p>Configured detectors that can be selected by used</p> <section id=id133 > <h2 id=id133 >Example<a class=headerlink href="#id133" title="Link to this heading"></a></h2> <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.models.detector_list</span> <span class=kn >import</span> <span class=n >DetectorList</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 ># List available detectors</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_select_detector_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_select_detector_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_select_detector_get: </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=id134 > <h2 id=id134 >Parameters<a class=headerlink href="#id134" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id135 > <h2 id=id135 >Return type<a class=headerlink href="#id135" title="Link to this heading"></a></h2> <p><a class="reference internal" href=DetectorList.html ><span class="std std-doc"><strong>DetectorList</strong></span></a></p> </section> <section id=id136 > <h2 id=id136 >Authorization<a class=headerlink href="#id136" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id137 > <h2 id=id137 >HTTP request headers<a class=headerlink href="#id137" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id138 > <h2 id=id138 >HTTP response details<a class=headerlink href="#id138" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-select-detector-put > <h1 id=config-select-detector-put ><strong>config_select_detector_put</strong><a class=headerlink href="#config-select-detector-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_select_detector_put(detector_selection=detector_selection)</p> </div></blockquote> <p>Select detector</p> <p>Jungfraujoch allows to control multiple detectors and/or region-of-interests. The command allows to choose one detector from the list (ID has to be consistent with one provided by GET response). Changing detector will set detector to <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> state and will require reinitialization.</p> <section id=id139 > <h2 id=id139 >Example<a class=headerlink href="#id139" title="Link to this heading"></a></h2> <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.models.detector_selection</span> <span class=kn >import</span> <span class=n >DetectorSelection</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=n >detector_selection</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >DetectorSelection</span><span class=p >()</span> <span class=c1 ># DetectorSelection | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Select detector</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_select_detector_put</span><span class=p >(</span><span class=n >detector_selection</span><span class=o >=</span><span class=n >detector_selection</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_select_detector_put: </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=id140 > <h2 id=id140 >Parameters<a class=headerlink href="#id140" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>detector_selection</strong></p> <td><p><a class="reference internal" href=DetectorSelection.html ><span class="std std-doc"><strong>DetectorSelection</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id141 > <h2 id=id141 >Return type<a class=headerlink href="#id141" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id142 > <h2 id=id142 >Authorization<a class=headerlink href="#id142" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id143 > <h2 id=id143 >HTTP request headers<a class=headerlink href="#id143" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id144 > <h2 id=id144 >HTTP response details<a class=headerlink href="#id144" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-spot-finding-get > <h1 id=config-spot-finding-get ><strong>config_spot_finding_get</strong><a class=headerlink href="#config-spot-finding-get" title="Link to this heading"></a></h1> <blockquote> <div><p>SpotFindingSettings config_spot_finding_get()</p> </div></blockquote> <p>Get data processing configuration</p> <p>Can be done anytime</p> <section id=id145 > <h2 id=id145 >Example<a class=headerlink href="#id145" title="Link to this heading"></a></h2> <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.models.spot_finding_settings</span> <span class=kn >import</span> <span class=n >SpotFindingSettings</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 ># Get data processing configuration</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_spot_finding_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_spot_finding_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_spot_finding_get: </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=id146 > <h2 id=id146 >Parameters<a class=headerlink href="#id146" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id147 > <h2 id=id147 >Return type<a class=headerlink href="#id147" title="Link to this heading"></a></h2> <p><a class="reference internal" href=SpotFindingSettings.html ><span class="std std-doc"><strong>SpotFindingSettings</strong></span></a></p> </section> <section id=id148 > <h2 id=id148 >Authorization<a class=headerlink href="#id148" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id149 > <h2 id=id149 >HTTP request headers<a class=headerlink href="#id149" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id150 > <h2 id=id150 >HTTP response details<a class=headerlink href="#id150" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-spot-finding-put > <h1 id=config-spot-finding-put ><strong>config_spot_finding_put</strong><a class=headerlink href="#config-spot-finding-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_spot_finding_put(spot_finding_settings=spot_finding_settings)</p> </div></blockquote> <p>Configure spot finding</p> <p>Can be done anytime, also while data collection is running</p> <section id=id151 > <h2 id=id151 >Example<a class=headerlink href="#id151" title="Link to this heading"></a></h2> <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.models.spot_finding_settings</span> <span class=kn >import</span> <span class=n >SpotFindingSettings</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=n >spot_finding_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >SpotFindingSettings</span><span class=p >()</span> <span class=c1 ># SpotFindingSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Configure spot finding</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_spot_finding_put</span><span class=p >(</span><span class=n >spot_finding_settings</span><span class=o >=</span><span class=n >spot_finding_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_spot_finding_put: </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=id152 > <h2 id=id152 >Parameters<a class=headerlink href="#id152" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>spot_finding_settings</strong></p> <td><p><a class="reference internal" href=SpotFindingSettings.html ><span class="std std-doc"><strong>SpotFindingSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id153 > <h2 id=id153 >Return type<a class=headerlink href="#id153" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id154 > <h2 id=id154 >Authorization<a class=headerlink href="#id154" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id155 > <h2 id=id155 >HTTP request headers<a class=headerlink href="#id155" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain</p> </ul> </section> <section id=id156 > <h2 id=id156 >HTTP response details<a class=headerlink href="#id156" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-user-mask-get > <h1 id=config-user-mask-get ><strong>config_user_mask_get</strong><a class=headerlink href="#config-user-mask-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray config_user_mask_get()</p> </div></blockquote> <p>Detector must be Initialized. Get user mask of the detector (binary)</p> <p>Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked</p> <section id=id157 > <h2 id=id157 >Example<a class=headerlink href="#id157" title="Link to this heading"></a></h2> <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 ># Detector must be Initialized. Get user mask of the detector (binary) </span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_user_mask_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_user_mask_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_user_mask_get: </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=id158 > <h2 id=id158 >Parameters<a class=headerlink href="#id158" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id159 > <h2 id=id159 >Return type<a class=headerlink href="#id159" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id160 > <h2 id=id160 >Authorization<a class=headerlink href="#id160" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id161 > <h2 id=id161 >HTTP request headers<a class=headerlink href="#id161" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/octet-stream</p> </ul> </section> <section id=id162 > <h2 id=id162 >HTTP response details<a class=headerlink href="#id162" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>User mask in binary format (4 byte; unsigned)</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-user-mask-put > <h1 id=config-user-mask-put ><strong>config_user_mask_put</strong><a class=headerlink href="#config-user-mask-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_user_mask_put(body=body)</p> </div></blockquote> <p>Upload user mask of the detector (binary)</p> <p>Should be in <code class="docutils literal notranslate"><span class=pre >Idle</span></code> state. Upload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions. If detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates. In the latter case - module gaps are ignored and don’t need to be assigned value. Mask is expected as binary array (4-byte; unsigned). 0 - good pixel, other value - masked User mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration.</p> <section id=id163 > <h2 id=id163 >Example<a class=headerlink href="#id163" title="Link to this heading"></a></h2> <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=n >body</span> <span class=o >=</span> <span class=kc >None</span> <span class=c1 ># bytearray | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Upload user mask of the detector (binary)</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_user_mask_put</span><span class=p >(</span><span class=n >body</span><span class=o >=</span><span class=n >body</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_user_mask_put: </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=id164 > <h2 id=id164 >Parameters<a class=headerlink href="#id164" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>body</strong></p> <td><p><strong>bytearray</strong></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id165 > <h2 id=id165 >Return type<a class=headerlink href="#id165" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id166 > <h2 id=id166 >Authorization<a class=headerlink href="#id166" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id167 > <h2 id=id167 >HTTP request headers<a class=headerlink href="#id167" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/octet-stream</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id168 > <h2 id=id168 >HTTP response details<a class=headerlink href="#id168" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>All good</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Mask is not 4-byte unsigned integer array or empty body</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-user-mask-tiff-get > <h1 id=config-user-mask-tiff-get ><strong>config_user_mask_tiff_get</strong><a class=headerlink href="#config-user-mask-tiff-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray config_user_mask_tiff_get()</p> </div></blockquote> <p>Detector must be Initialized. Get user mask of the detector (TIFF)</p> <p>Get user pixel mask of the detector in the actual detector coordinates: 0 - good pixel, 1 - masked</p> <section id=id169 > <h2 id=id169 >Example<a class=headerlink href="#id169" title="Link to this heading"></a></h2> <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 ># Detector must be Initialized. Get user mask of the detector (TIFF) </span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_user_mask_tiff_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_user_mask_tiff_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_user_mask_tiff_get: </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=id170 > <h2 id=id170 >Parameters<a class=headerlink href="#id170" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id171 > <h2 id=id171 >Return type<a class=headerlink href="#id171" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id172 > <h2 id=id172 >Authorization<a class=headerlink href="#id172" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id173 > <h2 id=id173 >HTTP request headers<a class=headerlink href="#id173" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: image/tiff</p> </ul> </section> <section id=id174 > <h2 id=id174 >HTTP response details<a class=headerlink href="#id174" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>User mask in TIFF format (4 byte; unsigned)</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-user-mask-tiff-put > <h1 id=config-user-mask-tiff-put ><strong>config_user_mask_tiff_put</strong><a class=headerlink href="#config-user-mask-tiff-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_user_mask_tiff_put(body=body)</p> </div></blockquote> <p>Upload user mask of the detector</p> <p>Should be in <code class="docutils literal notranslate"><span class=pre >Idle</span></code> state. Upload user mask of the detector - this is for example to account for beam stop shadow or misbehaving regions. If detector is conversion mode the mask can be both in raw (1024x512; stacked modules) or converted coordinates. In the latter case - module gaps are ignored and don’t need to be assigned value. Mask is expected as TIFF (4-byte; unsigned). 0 - good pixel, other value - masked User mask is stored in NXmx pixel mask (bit 8), as well as used in spot finding and azimuthal integration. User mask is not automatically applied - i.e. pixels with user mask will have a valid pixel value in the images.</p> <section id=id175 > <h2 id=id175 >Example<a class=headerlink href="#id175" title="Link to this heading"></a></h2> <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=n >body</span> <span class=o >=</span> <span class=kc >None</span> <span class=c1 ># bytearray | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Upload user mask of the detector</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_user_mask_tiff_put</span><span class=p >(</span><span class=n >body</span><span class=o >=</span><span class=n >body</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_user_mask_tiff_put: </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=id176 > <h2 id=id176 >Parameters<a class=headerlink href="#id176" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>body</strong></p> <td><p><strong>bytearray</strong></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id177 > <h2 id=id177 >Return type<a class=headerlink href="#id177" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id178 > <h2 id=id178 >Authorization<a class=headerlink href="#id178" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id179 > <h2 id=id179 >HTTP request headers<a class=headerlink href="#id179" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: image/tiff</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id180 > <h2 id=id180 >HTTP response details<a class=headerlink href="#id180" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>All good</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-zeromq-metadata-get > <h1 id=config-zeromq-metadata-get ><strong>config_zeromq_metadata_get</strong><a class=headerlink href="#config-zeromq-metadata-get" title="Link to this heading"></a></h1> <blockquote> <div><p>ZeromqMetadataSettings config_zeromq_metadata_get()</p> </div></blockquote> <p>Get ZeroMQ metadata socket settings</p> <section id=id181 > <h2 id=id181 >Example<a class=headerlink href="#id181" title="Link to this heading"></a></h2> <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.models.zeromq_metadata_settings</span> <span class=kn >import</span> <span class=n >ZeromqMetadataSettings</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 ># Get ZeroMQ metadata socket settings</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_zeromq_metadata_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_zeromq_metadata_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_zeromq_metadata_get: </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=id182 > <h2 id=id182 >Parameters<a class=headerlink href="#id182" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id183 > <h2 id=id183 >Return type<a class=headerlink href="#id183" title="Link to this heading"></a></h2> <p><a class="reference internal" href=ZeromqMetadataSettings.html ><span class="std std-doc"><strong>ZeromqMetadataSettings</strong></span></a></p> </section> <section id=id184 > <h2 id=id184 >Authorization<a class=headerlink href="#id184" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id185 > <h2 id=id185 >HTTP request headers<a class=headerlink href="#id185" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id186 > <h2 id=id186 >HTTP response details<a class=headerlink href="#id186" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-zeromq-metadata-put > <h1 id=config-zeromq-metadata-put ><strong>config_zeromq_metadata_put</strong><a class=headerlink href="#config-zeromq-metadata-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)</p> </div></blockquote> <p>Set ZeroMQ metadata settings</p> <p>Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.</p> <section id=id187 > <h2 id=id187 >Example<a class=headerlink href="#id187" title="Link to this heading"></a></h2> <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.models.zeromq_metadata_settings</span> <span class=kn >import</span> <span class=n >ZeromqMetadataSettings</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=n >zeromq_metadata_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >ZeromqMetadataSettings</span><span class=p >()</span> <span class=c1 ># ZeromqMetadataSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Set ZeroMQ metadata settings</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_zeromq_metadata_put</span><span class=p >(</span><span class=n >zeromq_metadata_settings</span><span class=o >=</span><span class=n >zeromq_metadata_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_zeromq_metadata_put: </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=id188 > <h2 id=id188 >Parameters<a class=headerlink href="#id188" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>zeromq_metadata_settings</strong></p> <td><p><a class="reference internal" href=ZeromqMetadataSettings.html ><span class="std std-doc"><strong>ZeromqMetadataSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id189 > <h2 id=id189 >Return type<a class=headerlink href="#id189" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id190 > <h2 id=id190 >Authorization<a class=headerlink href="#id190" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id191 > <h2 id=id191 >HTTP request headers<a class=headerlink href="#id191" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id192 > <h2 id=id192 >HTTP response details<a class=headerlink href="#id192" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-zeromq-preview-get > <h1 id=config-zeromq-preview-get ><strong>config_zeromq_preview_get</strong><a class=headerlink href="#config-zeromq-preview-get" title="Link to this heading"></a></h1> <blockquote> <div><p>ZeromqPreviewSettings config_zeromq_preview_get()</p> </div></blockquote> <p>Get ZeroMQ preview settings</p> <section id=id193 > <h2 id=id193 >Example<a class=headerlink href="#id193" title="Link to this heading"></a></h2> <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.models.zeromq_preview_settings</span> <span class=kn >import</span> <span class=n >ZeromqPreviewSettings</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 ># Get ZeroMQ preview settings</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >config_zeromq_preview_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;config_zeromq_preview_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_zeromq_preview_get: </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=id194 > <h2 id=id194 >Parameters<a class=headerlink href="#id194" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id195 > <h2 id=id195 >Return type<a class=headerlink href="#id195" title="Link to this heading"></a></h2> <p><a class="reference internal" href=ZeromqPreviewSettings.html ><span class="std std-doc"><strong>ZeromqPreviewSettings</strong></span></a></p> </section> <section id=id196 > <h2 id=id196 >Authorization<a class=headerlink href="#id196" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id197 > <h2 id=id197 >HTTP request headers<a class=headerlink href="#id197" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id198 > <h2 id=id198 >HTTP response details<a class=headerlink href="#id198" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=config-zeromq-preview-put > <h1 id=config-zeromq-preview-put ><strong>config_zeromq_preview_put</strong><a class=headerlink href="#config-zeromq-preview-put" title="Link to this heading"></a></h1> <blockquote> <div><p>config_zeromq_preview_put(zeromq_preview_settings=zeromq_preview_settings)</p> </div></blockquote> <p>Set ZeroMQ preview settings</p> <p>Jungfraujoch can generate preview message stream on ZeroMQ SUB socket. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request. Options set with this PUT request have no effect on HTTP based preview.</p> <section id=id199 > <h2 id=id199 >Example<a class=headerlink href="#id199" title="Link to this heading"></a></h2> <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.models.zeromq_preview_settings</span> <span class=kn >import</span> <span class=n >ZeromqPreviewSettings</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=n >zeromq_preview_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >ZeromqPreviewSettings</span><span class=p >()</span> <span class=c1 ># ZeromqPreviewSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Set ZeroMQ preview settings</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >config_zeromq_preview_put</span><span class=p >(</span><span class=n >zeromq_preview_settings</span><span class=o >=</span><span class=n >zeromq_preview_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;config_zeromq_preview_put: </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=id200 > <h2 id=id200 >Parameters<a class=headerlink href="#id200" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>zeromq_preview_settings</strong></p> <td><p><a class="reference internal" href=ZeromqPreviewSettings.html ><span class="std std-doc"><strong>ZeromqPreviewSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id201 > <h2 id=id201 >Return type<a class=headerlink href="#id201" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id202 > <h2 id=id202 >Authorization<a class=headerlink href="#id202" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id203 > <h2 id=id203 >HTTP request headers<a class=headerlink href="#id203" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id204 > <h2 id=id204 >HTTP response details<a class=headerlink href="#id204" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=deactivate-post > <h1 id=deactivate-post ><strong>deactivate_post</strong><a class=headerlink href="#deactivate-post" title="Link to this heading"></a></h1> <blockquote> <div><p>deactivate_post()</p> </div></blockquote> <p>Prepare detector to turn off</p> <p>Should be in <code class="docutils literal notranslate"><span class=pre >Idle</span></code> or <code class="docutils literal notranslate"><span class=pre >Error</span></code> state. Command deactivates data acquisition and turns off detector high voltage and ASIC. Should be used always before turning off power from the detector.</p> <section id=id205 > <h2 id=id205 >Example<a class=headerlink href="#id205" title="Link to this heading"></a></h2> <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 ># Prepare detector to turn off</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >deactivate_post</span><span class=p >()</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;deactivate_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=id206 > <h2 id=id206 >Parameters<a class=headerlink href="#id206" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id207 > <h2 id=id207 >Return type<a class=headerlink href="#id207" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id208 > <h2 id=id208 >Authorization<a class=headerlink href="#id208" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id209 > <h2 id=id209 >HTTP request headers<a class=headerlink href="#id209" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id210 > <h2 id=id210 >HTTP response details<a class=headerlink href="#id210" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Detector ready to turn off</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=detector-status-get > <h1 id=detector-status-get ><strong>detector_status_get</strong><a class=headerlink href="#detector-status-get" title="Link to this heading"></a></h1> <blockquote> <div><p>DetectorStatus detector_status_get()</p> </div></blockquote> <p>Get detector status</p> <p>Status of the JUNGFRAU detector</p> <section id=id211 > <h2 id=id211 >Example<a class=headerlink href="#id211" title="Link to this heading"></a></h2> <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.models.detector_status</span> <span class=kn >import</span> <span class=n >DetectorStatus</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 ># Get detector status</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >detector_status_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;detector_status_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;detector_status_get: </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=id212 > <h2 id=id212 >Parameters<a class=headerlink href="#id212" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id213 > <h2 id=id213 >Return type<a class=headerlink href="#id213" title="Link to this heading"></a></h2> <p><a class="reference internal" href=DetectorStatus.html ><span class="std std-doc"><strong>DetectorStatus</strong></span></a></p> </section> <section id=id214 > <h2 id=id214 >Authorization<a class=headerlink href="#id214" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id215 > <h2 id=id215 >HTTP request headers<a class=headerlink href="#id215" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json, text/plain</p> </ul> </section> <section id=id216 > <h2 id=id216 >HTTP response details<a class=headerlink href="#id216" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>Running in &amp;quot;simulator&amp;quot; mode - no detector present</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error encountered when trying to read status</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=fpga-status-get > <h1 id=fpga-status-get ><strong>fpga_status_get</strong><a class=headerlink href="#fpga-status-get" title="Link to this heading"></a></h1> <blockquote> <div><p>List[FpgaStatusInner] fpga_status_get()</p> </div></blockquote> <p>Get status of FPGA devices</p> <section id=id217 > <h2 id=id217 >Example<a class=headerlink href="#id217" title="Link to this heading"></a></h2> <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.models.fpga_status_inner</span> <span class=kn >import</span> <span class=n >FpgaStatusInner</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 ># Get status of FPGA devices</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >fpga_status_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;fpga_status_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;fpga_status_get: </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=id218 > <h2 id=id218 >Parameters<a class=headerlink href="#id218" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id219 > <h2 id=id219 >Return type<a class=headerlink href="#id219" title="Link to this heading"></a></h2> <p><a class="reference internal" href=FpgaStatusInner.html ><span class="std std-doc"><strong>List[FpgaStatusInner]</strong></span></a></p> </section> <section id=id220 > <h2 id=id220 >Authorization<a class=headerlink href="#id220" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id221 > <h2 id=id221 >HTTP request headers<a class=headerlink href="#id221" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id222 > <h2 id=id222 >HTTP response details<a class=headerlink href="#id222" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=image-buffer-clear-post > <h1 id=image-buffer-clear-post ><strong>image_buffer_clear_post</strong><a class=headerlink href="#image-buffer-clear-post" title="Link to this heading"></a></h1> <blockquote> <div><p>image_buffer_clear_post()</p> </div></blockquote> <p>Clear image buffer</p> <p>Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.</p> <section id=id223 > <h2 id=id223 >Example<a class=headerlink href="#id223" title="Link to this heading"></a></h2> <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 ># Clear image buffer</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >image_buffer_clear_post</span><span class=p >()</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;image_buffer_clear_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=id224 > <h2 id=id224 >Parameters<a class=headerlink href="#id224" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id225 > <h2 id=id225 >Return type<a class=headerlink href="#id225" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id226 > <h2 id=id226 >Authorization<a class=headerlink href="#id226" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id227 > <h2 id=id227 >HTTP request headers<a class=headerlink href="#id227" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id228 > <h2 id=id228 >HTTP response details<a class=headerlink href="#id228" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Done</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=image-buffer-image-cbor-get > <h1 id=image-buffer-image-cbor-get ><strong>image_buffer_image_cbor_get</strong><a class=headerlink href="#image-buffer-image-cbor-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray image_buffer_image_cbor_get(id=id)</p> </div></blockquote> <p>Get image message in CBOR format</p> <p>Contains full image data and metadata. The image must come from the latest data collection.</p> <section id=id229 > <h2 id=id229 >Example<a class=headerlink href="#id229" title="Link to this heading"></a></h2> <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=nb >id</span> <span class=o >=</span> <span class=o >-</span><span class=mi >1</span> <span class=c1 ># int | Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer (optional) (default to -1)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Get image message in CBOR format</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >image_buffer_image_cbor_get</span><span class=p >(</span><span class=nb >id</span><span class=o >=</span><span class=nb >id</span><span class=p >)</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;image_buffer_image_cbor_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;image_buffer_image_cbor_get: </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=id230 > <h2 id=id230 >Parameters<a class=headerlink href="#id230" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>id</strong></p> <td><p><strong>int</strong></p> <td><p>Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer</p> <td><p>[optional] [default to -1]</p> </table> </section> <section id=id231 > <h2 id=id231 >Return type<a class=headerlink href="#id231" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id232 > <h2 id=id232 >Authorization<a class=headerlink href="#id232" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id233 > <h2 id=id233 >HTTP request headers<a class=headerlink href="#id233" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/cbor, application/json</p> </ul> </section> <section id=id234 > <h2 id=id234 >HTTP response details<a class=headerlink href="#id234" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Return image message</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>Image not present in the buffer - either not yet measured or already replaced by a next image.</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=image-buffer-image-jpeg-get > <h1 id=image-buffer-image-jpeg-get ><strong>image_buffer_image_jpeg_get</strong><a class=headerlink href="#image-buffer-image-jpeg-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray image_buffer_image_jpeg_get(id=id, show_user_mask=show_user_mask, show_roi=show_roi, show_spots=show_spots, show_beam_center=show_beam_center, saturation=saturation, jpeg_quality=jpeg_quality, show_res_ring=show_res_ring, color=color, show_res_est=show_res_est)</p> </div></blockquote> <p>Get preview image in JPEG format using custom settings</p> <section id=id235 > <h2 id=id235 >Example<a class=headerlink href="#id235" title="Link to this heading"></a></h2> <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=nb >id</span> <span class=o >=</span> <span class=o >-</span><span class=mi >1</span> <span class=c1 ># int | Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer (optional) (default to -1)</span>
<span class=n >show_user_mask</span> <span class=o >=</span> <span class=kc >False</span> <span class=c1 ># bool | Show user mask (optional) (default to False)</span>
<span class=n >show_roi</span> <span class=o >=</span> <span class=kc >False</span> <span class=c1 ># bool | Show ROI areas on the image (optional) (default to False)</span>
<span class=n >show_spots</span> <span class=o >=</span> <span class=kc >True</span> <span class=c1 ># bool | Show spot finding results on the image (optional) (default to True)</span>
<span class=n >show_beam_center</span> <span class=o >=</span> <span class=kc >True</span> <span class=c1 ># bool | Show beam center on the image (optional) (default to True)</span>
<span class=n >saturation</span> <span class=o >=</span> <span class=mf >3.4</span> <span class=c1 ># float | Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used (optional)</span>
<span class=n >jpeg_quality</span> <span class=o >=</span> <span class=mi >100</span> <span class=c1 ># int | Quality of JPEG image (100 - highest; 0 - lowest) (optional) (default to 100)</span>
<span class=n >show_res_ring</span> <span class=o >=</span> <span class=mf >0.1</span> <span class=c1 ># float | Show resolution ring, provided in Angstrom (optional) (default to 0.1)</span>
<span class=n >color</span> <span class=o >=</span> <span class=n >indigo</span> <span class=c1 ># str | Color scale for preview image (optional) (default to indigo)</span>
<span class=n >show_res_est</span> <span class=o >=</span> <span class=kc >False</span> <span class=c1 ># bool | Show resolution estimation as a ring (optional) (default to False)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Get preview image in JPEG format using custom settings</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >image_buffer_image_jpeg_get</span><span class=p >(</span><span class=nb >id</span><span class=o >=</span><span class=nb >id</span><span class=p >,</span> <span class=n >show_user_mask</span><span class=o >=</span><span class=n >show_user_mask</span><span class=p >,</span> <span class=n >show_roi</span><span class=o >=</span><span class=n >show_roi</span><span class=p >,</span> <span class=n >show_spots</span><span class=o >=</span><span class=n >show_spots</span><span class=p >,</span> <span class=n >show_beam_center</span><span class=o >=</span><span class=n >show_beam_center</span><span class=p >,</span> <span class=n >saturation</span><span class=o >=</span><span class=n >saturation</span><span class=p >,</span> <span class=n >jpeg_quality</span><span class=o >=</span><span class=n >jpeg_quality</span><span class=p >,</span> <span class=n >show_res_ring</span><span class=o >=</span><span class=n >show_res_ring</span><span class=p >,</span> <span class=n >color</span><span class=o >=</span><span class=n >color</span><span class=p >,</span> <span class=n >show_res_est</span><span class=o >=</span><span class=n >show_res_est</span><span class=p >)</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;image_buffer_image_jpeg_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;image_buffer_image_jpeg_get: </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=id236 > <h2 id=id236 >Parameters<a class=headerlink href="#id236" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>id</strong></p> <td><p><strong>int</strong></p> <td><p>Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer</p> <td><p>[optional] [default to -1]</p> <tr class=row-odd ><td><p><strong>show_user_mask</strong></p> <td><p><strong>bool</strong></p> <td><p>Show user mask</p> <td><p>[optional] [default to False]</p> <tr class=row-even ><td><p><strong>show_roi</strong></p> <td><p><strong>bool</strong></p> <td><p>Show ROI areas on the image</p> <td><p>[optional] [default to False]</p> <tr class=row-odd ><td><p><strong>show_spots</strong></p> <td><p><strong>bool</strong></p> <td><p>Show spot finding results on the image</p> <td><p>[optional] [default to True]</p> <tr class=row-even ><td><p><strong>show_beam_center</strong></p> <td><p><strong>bool</strong></p> <td><p>Show beam center on the image</p> <td><p>[optional] [default to True]</p> <tr class=row-odd ><td><p><strong>saturation</strong></p> <td><p><strong>float</strong></p> <td><p>Saturation value to set contrast in the preview image; if not provided, then autocontrast procedure is used</p> <td><p>[optional]</p> <tr class=row-even ><td><p><strong>jpeg_quality</strong></p> <td><p><strong>int</strong></p> <td><p>Quality of JPEG image (100 - highest; 0 - lowest)</p> <td><p>[optional] [default to 100]</p> <tr class=row-odd ><td><p><strong>show_res_ring</strong></p> <td><p><strong>float</strong></p> <td><p>Show resolution ring, provided in Angstrom</p> <td><p>[optional] [default to 0.1]</p> <tr class=row-even ><td><p><strong>color</strong></p> <td><p><strong>str</strong></p> <td><p>Color scale for preview image</p> <td><p>[optional] [default to indigo]</p> <tr class=row-odd ><td><p><strong>show_res_est</strong></p> <td><p><strong>bool</strong></p> <td><p>Show resolution estimation as a ring</p> <td><p>[optional] [default to False]</p> </table> </section> <section id=id237 > <h2 id=id237 >Return type<a class=headerlink href="#id237" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id238 > <h2 id=id238 >Authorization<a class=headerlink href="#id238" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id239 > <h2 id=id239 >HTTP request headers<a class=headerlink href="#id239" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: image/jpeg, text/plain, application/json</p> </ul> </section> <section id=id240 > <h2 id=id240 >HTTP response details<a class=headerlink href="#id240" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Preview image</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>Image not present in the buffer - either not yet measured or already replaced by a next image.</p> <td><p>-</p> <tr class=row-even ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=image-buffer-image-tiff-get > <h1 id=image-buffer-image-tiff-get ><strong>image_buffer_image_tiff_get</strong><a class=headerlink href="#image-buffer-image-tiff-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray image_buffer_image_tiff_get(id=id)</p> </div></blockquote> <p>Get preview image in TIFF format</p> <section id=id241 > <h2 id=id241 >Example<a class=headerlink href="#id241" title="Link to this heading"></a></h2> <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=nb >id</span> <span class=o >=</span> <span class=o >-</span><span class=mi >1</span> <span class=c1 ># int | Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer (optional) (default to -1)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Get preview image in TIFF format</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >image_buffer_image_tiff_get</span><span class=p >(</span><span class=nb >id</span><span class=o >=</span><span class=nb >id</span><span class=p >)</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;image_buffer_image_tiff_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;image_buffer_image_tiff_get: </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=id242 > <h2 id=id242 >Parameters<a class=headerlink href="#id242" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>id</strong></p> <td><p><strong>int</strong></p> <td><p>Image ID in the image buffer. Special values: -1 - last image in the buffer, -2: last indexed image in the buffer</p> <td><p>[optional] [default to -1]</p> </table> </section> <section id=id243 > <h2 id=id243 >Return type<a class=headerlink href="#id243" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id244 > <h2 id=id244 >Authorization<a class=headerlink href="#id244" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id245 > <h2 id=id245 >HTTP request headers<a class=headerlink href="#id245" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: image/tiff</p> </ul> </section> <section id=id246 > <h2 id=id246 >HTTP response details<a class=headerlink href="#id246" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Preview image</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>No preview image recorded so far</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=image-buffer-start-cbor-get > <h1 id=image-buffer-start-cbor-get ><strong>image_buffer_start_cbor_get</strong><a class=headerlink href="#image-buffer-start-cbor-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray image_buffer_start_cbor_get()</p> </div></blockquote> <p>Get Start message in CBOR format</p> <p>Contains metadata for a dataset (e.g., experimental geometry)</p> <section id=id247 > <h2 id=id247 >Example<a class=headerlink href="#id247" title="Link to this heading"></a></h2> <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 ># Get Start message in CBOR format</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >image_buffer_start_cbor_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;image_buffer_start_cbor_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;image_buffer_start_cbor_get: </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=id248 > <h2 id=id248 >Parameters<a class=headerlink href="#id248" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id249 > <h2 id=id249 >Return type<a class=headerlink href="#id249" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id250 > <h2 id=id250 >Authorization<a class=headerlink href="#id250" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id251 > <h2 id=id251 >HTTP request headers<a class=headerlink href="#id251" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/cbor, application/json</p> </ul> </section> <section id=id252 > <h2 id=id252 >HTTP response details<a class=headerlink href="#id252" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Return start message</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>No measurement so far</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=image-buffer-status-get > <h1 id=image-buffer-status-get ><strong>image_buffer_status_get</strong><a class=headerlink href="#image-buffer-status-get" title="Link to this heading"></a></h1> <blockquote> <div><p>ImageBufferStatus image_buffer_status_get()</p> </div></blockquote> <p>Get status of the image buffers</p> <p>Can be run at any stage of Jungfraujoch operation, including during data collection. The status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots, then image might be replaced in the buffer between calling /images and /image.cbor.</p> <section id=id253 > <h2 id=id253 >Example<a class=headerlink href="#id253" title="Link to this heading"></a></h2> <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.models.image_buffer_status</span> <span class=kn >import</span> <span class=n >ImageBufferStatus</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 ># Get status of the image buffers</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >image_buffer_status_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;image_buffer_status_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;image_buffer_status_get: </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=id254 > <h2 id=id254 >Parameters<a class=headerlink href="#id254" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id255 > <h2 id=id255 >Return type<a class=headerlink href="#id255" title="Link to this heading"></a></h2> <p><a class="reference internal" href=ImageBufferStatus.html ><span class="std std-doc"><strong>ImageBufferStatus</strong></span></a></p> </section> <section id=id256 > <h2 id=id256 >Authorization<a class=headerlink href="#id256" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id257 > <h2 id=id257 >HTTP request headers<a class=headerlink href="#id257" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id258 > <h2 id=id258 >HTTP response details<a class=headerlink href="#id258" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Done</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=image-pusher-status-get > <h1 id=image-pusher-status-get ><strong>image_pusher_status_get</strong><a class=headerlink href="#image-pusher-status-get" title="Link to this heading"></a></h1> <blockquote> <div><p>ImagePusherStatus image_pusher_status_get()</p> </div></blockquote> <p>Get status of image pusher</p> <section id=id259 > <h2 id=id259 >Example<a class=headerlink href="#id259" title="Link to this heading"></a></h2> <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.models.image_pusher_status</span> <span class=kn >import</span> <span class=n >ImagePusherStatus</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 ># Get status of image pusher</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >image_pusher_status_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;image_pusher_status_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;image_pusher_status_get: </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=id260 > <h2 id=id260 >Parameters<a class=headerlink href="#id260" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id261 > <h2 id=id261 >Return type<a class=headerlink href="#id261" title="Link to this heading"></a></h2> <p><a class="reference internal" href=ImagePusherStatus.html ><span class="std std-doc"><strong>ImagePusherStatus</strong></span></a></p> </section> <section id=id262 > <h2 id=id262 >Authorization<a class=headerlink href="#id262" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id263 > <h2 id=id263 >HTTP request headers<a class=headerlink href="#id263" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json, text/plain</p> </ul> </section> <section id=id264 > <h2 id=id264 >HTTP response details<a class=headerlink href="#id264" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error encountered when trying to read status</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=initialize-post > <h1 id=initialize-post ><strong>initialize_post</strong><a class=headerlink href="#initialize-post" title="Link to this heading"></a></h1> <blockquote> <div><p>initialize_post()</p> </div></blockquote> <p>Initialize detector and data acquisition</p> <p>Should be used in two cases:</p> <ul class=simple > <li><p>Detector is in <code class="docutils literal notranslate"><span class=pre >Inactive</span></code> state</p> <li><p>Detector is in <code class="docutils literal notranslate"><span class=pre >Error</span></code> state X-ray shutter must be closed. This operation will reconfigure network interface of the detector. During operation of the detector it is recommended to use the <code class="docutils literal notranslate"><span class=pre >POST</span> <span class=pre >/pedestal</span></code> operation instead. If storage cells are used, the execution time might be few minutes.</p> </ul> <p>This is async function - one needs to use <code class="docutils literal notranslate"><span class=pre >POST</span> <span class=pre >/wait_till_done</span></code> to ensure operation is done.</p> <section id=id265 > <h2 id=id265 >Example<a class=headerlink href="#id265" title="Link to this heading"></a></h2> <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 ># Initialize detector and data acquisition</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >initialize_post</span><span class=p >()</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;initialize_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=id266 > <h2 id=id266 >Parameters<a class=headerlink href="#id266" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id267 > <h2 id=id267 >Return type<a class=headerlink href="#id267" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id268 > <h2 id=id268 >Authorization<a class=headerlink href="#id268" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id269 > <h2 id=id269 >HTTP request headers<a class=headerlink href="#id269" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id270 > <h2 id=id270 >HTTP response details<a class=headerlink href="#id270" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Initialization started</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=pedestal-post > <h1 id=pedestal-post ><strong>pedestal_post</strong><a class=headerlink href="#pedestal-post" title="Link to this heading"></a></h1> <blockquote> <div><p>pedestal_post()</p> </div></blockquote> <p>Collect dark current for the detector</p> <p>Updates calibration of the JUNGFRAU detector. Must be in <code class="docutils literal notranslate"><span class=pre >Idle</span></code> state.</p> <p>X-ray shutter must be closed. Recommended to run once per hour for long integration times (&gt; 100 us).</p> <p>This is async function - one needs to use <code class="docutils literal notranslate"><span class=pre >POST</span> <span class=pre >/wait_till_done</span></code> to ensure operation is done.</p> <section id=id271 > <h2 id=id271 >Example<a class=headerlink href="#id271" title="Link to this heading"></a></h2> <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 ># Collect dark current for the detector</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >pedestal_post</span><span class=p >()</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;pedestal_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=id272 > <h2 id=id272 >Parameters<a class=headerlink href="#id272" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id273 > <h2 id=id273 >Return type<a class=headerlink href="#id273" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id274 > <h2 id=id274 >Authorization<a class=headerlink href="#id274" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id275 > <h2 id=id275 >HTTP request headers<a class=headerlink href="#id275" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id276 > <h2 id=id276 >HTTP response details<a class=headerlink href="#id276" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=preview-pedestal-tiff-get > <h1 id=preview-pedestal-tiff-get ><strong>preview_pedestal_tiff_get</strong><a class=headerlink href="#preview-pedestal-tiff-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray preview_pedestal_tiff_get(gain_level, sc=sc)</p> </div></blockquote> <p>Get pedestal in TIFF format</p> <section id=id277 > <h2 id=id277 >Example<a class=headerlink href="#id277" title="Link to this heading"></a></h2> <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=n >gain_level</span> <span class=o >=</span> <span class=mi >56</span> <span class=c1 ># int | Gain level (0, 1, 2)</span>
<span class=n >sc</span> <span class=o >=</span> <span class=mi >56</span> <span class=c1 ># int | Storage cell number (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Get pedestal in TIFF format</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >preview_pedestal_tiff_get</span><span class=p >(</span><span class=n >gain_level</span><span class=p >,</span> <span class=n >sc</span><span class=o >=</span><span class=n >sc</span><span class=p >)</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;preview_pedestal_tiff_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;preview_pedestal_tiff_get: </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=id278 > <h2 id=id278 >Parameters<a class=headerlink href="#id278" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>gain_level</strong></p> <td><p><strong>int</strong></p> <td><p>Gain level (0, 1, 2)</p> <td><p></p> <tr class=row-odd ><td><p><strong>sc</strong></p> <td><p><strong>int</strong></p> <td><p>Storage cell number</p> <td><p>[optional]</p> </table> </section> <section id=id279 > <h2 id=id279 >Return type<a class=headerlink href="#id279" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id280 > <h2 id=id280 >Authorization<a class=headerlink href="#id280" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id281 > <h2 id=id281 >HTTP request headers<a class=headerlink href="#id281" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: image/tiff</p> </ul> </section> <section id=id282 > <h2 id=id282 >HTTP response details<a class=headerlink href="#id282" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Calibration image</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Invalid gain level or storage cell number</p> <td><p>-</p> <tr class=row-even ><td><p><strong>404</strong></p> <td><p>No calibration recorded so far</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=preview-plot-bin-get > <h1 id=preview-plot-bin-get ><strong>preview_plot_bin_get</strong><a class=headerlink href="#preview-plot-bin-get" title="Link to this heading"></a></h1> <blockquote> <div><p>bytearray preview_plot_bin_get(type, roi=roi)</p> </div></blockquote> <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> <section id=id283 > <h2 id=id283 >Example<a class=headerlink href="#id283" title="Link to this heading"></a></h2> <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=nb >type</span> <span class=o >=</span> <span class=s1 >'type_example'</span> <span class=c1 ># str | Type of requested plot</span>
<span class=n >roi</span> <span class=o >=</span> <span class=s1 >'roi_example'</span> <span class=c1 ># str | Name of ROI for which plot is requested (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># 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. </span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >preview_plot_bin_get</span><span class=p >(</span><span class=nb >type</span><span class=p >,</span> <span class=n >roi</span><span class=o >=</span><span class=n >roi</span><span class=p >)</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;preview_plot_bin_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;preview_plot_bin_get: </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=id284 > <h2 id=id284 >Parameters<a class=headerlink href="#id284" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>type</strong></p> <td><p><strong>str</strong></p> <td><p>Type of requested plot</p> <td><p></p> <tr class=row-odd ><td><p><strong>roi</strong></p> <td><p><strong>str</strong></p> <td><p>Name of ROI for which plot is requested</p> <td><p>[optional]</p> </table> </section> <section id=id285 > <h2 id=id285 >Return type<a class=headerlink href="#id285" title="Link to this heading"></a></h2> <p><strong>bytearray</strong></p> </section> <section id=id286 > <h2 id=id286 >Authorization<a class=headerlink href="#id286" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id287 > <h2 id=id287 >HTTP request headers<a class=headerlink href="#id287" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/octet-stream, text/plain</p> </ul> </section> <section id=id288 > <h2 id=id288 >HTTP response details<a class=headerlink href="#id288" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK.</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=preview-plot-get > <h1 id=preview-plot-get ><strong>preview_plot_get</strong><a class=headerlink href="#preview-plot-get" title="Link to this heading"></a></h1> <blockquote> <div><p>Plots preview_plot_get(type, binning=binning, fill=fill, experimental_coord=experimental_coord, azint_unit=azint_unit)</p> </div></blockquote> <p>Generate 1D plot from Jungfraujoch</p> <section id=id289 > <h2 id=id289 >Example<a class=headerlink href="#id289" title="Link to this heading"></a></h2> <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.models.plots</span> <span class=kn >import</span> <span class=n >Plots</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=nb >type</span> <span class=o >=</span> <span class=s1 >'type_example'</span> <span class=c1 ># str | Type of requested plot</span>
<span class=n >binning</span> <span class=o >=</span> <span class=mi >1</span> <span class=c1 ># int | Binning of frames for the plot (0 = default binning) (optional) (default to 1)</span>
<span class=n >fill</span> <span class=o >=</span> <span class=mf >3.4</span> <span class=c1 ># float | Fill value for elements that were missed during data collection (optional)</span>
<span class=n >experimental_coord</span> <span class=o >=</span> <span class=kc >False</span> <span class=c1 ># bool | If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored (optional) (default to False)</span>
<span class=n >azint_unit</span> <span class=o >=</span> <span class=n >Q_recipA</span> <span class=c1 ># str | Unit used for azim int. (optional) (default to Q_recipA)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Generate 1D plot from Jungfraujoch</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >preview_plot_get</span><span class=p >(</span><span class=nb >type</span><span class=p >,</span> <span class=n >binning</span><span class=o >=</span><span class=n >binning</span><span class=p >,</span> <span class=n >fill</span><span class=o >=</span><span class=n >fill</span><span class=p >,</span> <span class=n >experimental_coord</span><span class=o >=</span><span class=n >experimental_coord</span><span class=p >,</span> <span class=n >azint_unit</span><span class=o >=</span><span class=n >azint_unit</span><span class=p >)</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;preview_plot_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;preview_plot_get: </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=id290 > <h2 id=id290 >Parameters<a class=headerlink href="#id290" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>type</strong></p> <td><p><strong>str</strong></p> <td><p>Type of requested plot</p> <td><p></p> <tr class=row-odd ><td><p><strong>binning</strong></p> <td><p><strong>int</strong></p> <td><p>Binning of frames for the plot (0 = default binning)</p> <td><p>[optional] [default to 1]</p> <tr class=row-even ><td><p><strong>fill</strong></p> <td><p><strong>float</strong></p> <td><p>Fill value for elements that were missed during data collection</p> <td><p>[optional]</p> <tr class=row-odd ><td><p><strong>experimental_coord</strong></p> <td><p><strong>bool</strong></p> <td><p>If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored</p> <td><p>[optional] [default to False]</p> <tr class=row-even ><td><p><strong>azint_unit</strong></p> <td><p><strong>str</strong></p> <td><p>Unit used for azim int.</p> <td><p>[optional] [default to Q_recipA]</p> </table> </section> <section id=id291 > <h2 id=id291 >Return type<a class=headerlink href="#id291" title="Link to this heading"></a></h2> <p><a class="reference internal" href=Plots.html ><span class="std std-doc"><strong>Plots</strong></span></a></p> </section> <section id=id292 > <h2 id=id292 >Authorization<a class=headerlink href="#id292" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id293 > <h2 id=id293 >HTTP request headers<a class=headerlink href="#id293" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json, text/plain</p> </ul> </section> <section id=id294 > <h2 id=id294 >HTTP response details<a class=headerlink href="#id294" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK.</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=result-scan-get > <h1 id=result-scan-get ><strong>result_scan_get</strong><a class=headerlink href="#result-scan-get" title="Link to this heading"></a></h1> <blockquote> <div><p>ScanResult result_scan_get()</p> </div></blockquote> <p>Get full scan result</p> <section id=id295 > <h2 id=id295 >Example<a class=headerlink href="#id295" title="Link to this heading"></a></h2> <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.models.scan_result</span> <span class=kn >import</span> <span class=n >ScanResult</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 ># Get full scan result</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >result_scan_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;result_scan_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;result_scan_get: </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=id296 > <h2 id=id296 >Parameters<a class=headerlink href="#id296" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id297 > <h2 id=id297 >Return type<a class=headerlink href="#id297" title="Link to this heading"></a></h2> <p><a class="reference internal" href=ScanResult.html ><span class="std std-doc"><strong>ScanResult</strong></span></a></p> </section> <section id=id298 > <h2 id=id298 >Authorization<a class=headerlink href="#id298" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id299 > <h2 id=id299 >HTTP request headers<a class=headerlink href="#id299" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id300 > <h2 id=id300 >HTTP response details<a class=headerlink href="#id300" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK.</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>No grid scan recorded</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=start-post > <h1 id=start-post ><strong>start_post</strong><a class=headerlink href="#start-post" title="Link to this heading"></a></h1> <blockquote> <div><p>start_post(dataset_settings=dataset_settings)</p> </div></blockquote> <p>Start detector</p> <p>Start data acquisition. Detector must be in <code class="docutils literal notranslate"><span class=pre >Idle</span></code> state. Default behavior is for the call to block until detector is ready to accept soft/TTL triggers. However, this behavior can be changed by settings <code class="docutils literal notranslate"><span class=pre >async_start</span></code> to true in the request body, in which case the call will return immediately and one needs to use <code class="docutils literal notranslate"><span class=pre >/wait_until_running</span></code> to ensure detector is ready to run.</p> <section id=id301 > <h2 id=id301 >Example<a class=headerlink href="#id301" title="Link to this heading"></a></h2> <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.models.dataset_settings</span> <span class=kn >import</span> <span class=n >DatasetSettings</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=n >dataset_settings</span> <span class=o >=</span> <span class=n >jfjoch_client</span><span class=o >.</span><span class=n >DatasetSettings</span><span class=p >()</span> <span class=c1 ># DatasetSettings | (optional)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Start detector</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >start_post</span><span class=p >(</span><span class=n >dataset_settings</span><span class=o >=</span><span class=n >dataset_settings</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;start_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=id302 > <h2 id=id302 >Parameters<a class=headerlink href="#id302" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>dataset_settings</strong></p> <td><p><a class="reference internal" href=DatasetSettings.html ><span class="std std-doc"><strong>DatasetSettings</strong></span></a></p> <td><p></p> <td><p>[optional]</p> </table> </section> <section id=id303 > <h2 id=id303 >Return type<a class=headerlink href="#id303" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id304 > <h2 id=id304 >Authorization<a class=headerlink href="#id304" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id305 > <h2 id=id305 >HTTP request headers<a class=headerlink href="#id305" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: application/json</p> <li><p><strong>Accept</strong>: text/plain, application/json</p> </ul> </section> <section id=id306 > <h2 id=id306 >HTTP response details<a class=headerlink href="#id306" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Input parsing or validation error</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=statistics-calibration-get > <h1 id=statistics-calibration-get ><strong>statistics_calibration_get</strong><a class=headerlink href="#statistics-calibration-get" title="Link to this heading"></a></h1> <blockquote> <div><p>List[CalibrationStatisticsInner] statistics_calibration_get()</p> </div></blockquote> <p>Get calibration statistics</p> <p>Statistics are provided for each module/storage cell separately</p> <section id=id307 > <h2 id=id307 >Example<a class=headerlink href="#id307" title="Link to this heading"></a></h2> <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.models.calibration_statistics_inner</span> <span class=kn >import</span> <span class=n >CalibrationStatisticsInner</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 ># Get calibration statistics</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >statistics_calibration_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;statistics_calibration_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;statistics_calibration_get: </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=id308 > <h2 id=id308 >Parameters<a class=headerlink href="#id308" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id309 > <h2 id=id309 >Return type<a class=headerlink href="#id309" title="Link to this heading"></a></h2> <p><a class="reference internal" href=CalibrationStatisticsInner.html ><span class="std std-doc"><strong>List[CalibrationStatisticsInner]</strong></span></a></p> </section> <section id=id310 > <h2 id=id310 >Authorization<a class=headerlink href="#id310" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id311 > <h2 id=id311 >HTTP request headers<a class=headerlink href="#id311" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id312 > <h2 id=id312 >HTTP response details<a class=headerlink href="#id312" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=statistics-data-collection-get > <h1 id=statistics-data-collection-get ><strong>statistics_data_collection_get</strong><a class=headerlink href="#statistics-data-collection-get" title="Link to this heading"></a></h1> <blockquote> <div><p>MeasurementStatistics statistics_data_collection_get()</p> </div></blockquote> <p>Get data collection statistics</p> <p>Results of the last data collection</p> <section id=id313 > <h2 id=id313 >Example<a class=headerlink href="#id313" title="Link to this heading"></a></h2> <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.models.measurement_statistics</span> <span class=kn >import</span> <span class=n >MeasurementStatistics</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 ># Get data collection statistics</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >statistics_data_collection_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;statistics_data_collection_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;statistics_data_collection_get: </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=id314 > <h2 id=id314 >Parameters<a class=headerlink href="#id314" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id315 > <h2 id=id315 >Return type<a class=headerlink href="#id315" title="Link to this heading"></a></h2> <p><a class="reference internal" href=MeasurementStatistics.html ><span class="std std-doc"><strong>MeasurementStatistics</strong></span></a></p> </section> <section id=id316 > <h2 id=id316 >Authorization<a class=headerlink href="#id316" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id317 > <h2 id=id317 >HTTP request headers<a class=headerlink href="#id317" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id318 > <h2 id=id318 >HTTP response details<a class=headerlink href="#id318" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>No data collection performed so far</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=statistics-get > <h1 id=statistics-get ><strong>statistics_get</strong><a class=headerlink href="#statistics-get" title="Link to this heading"></a></h1> <blockquote> <div><p>JfjochStatistics statistics_get()</p> </div></blockquote> <p>Get general statistics</p> <section id=id319 > <h2 id=id319 >Example<a class=headerlink href="#id319" title="Link to this heading"></a></h2> <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.models.jfjoch_statistics</span> <span class=kn >import</span> <span class=n >JfjochStatistics</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 ># Get general statistics</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >statistics_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;statistics_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;statistics_get: </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=id320 > <h2 id=id320 >Parameters<a class=headerlink href="#id320" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id321 > <h2 id=id321 >Return type<a class=headerlink href="#id321" title="Link to this heading"></a></h2> <p><a class="reference internal" href=JfjochStatistics.html ><span class="std std-doc"><strong>JfjochStatistics</strong></span></a></p> </section> <section id=id322 > <h2 id=id322 >Authorization<a class=headerlink href="#id322" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id323 > <h2 id=id323 >HTTP request headers<a class=headerlink href="#id323" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id324 > <h2 id=id324 >HTTP response details<a class=headerlink href="#id324" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=status-get > <h1 id=status-get ><strong>status_get</strong><a class=headerlink href="#status-get" title="Link to this heading"></a></h1> <blockquote> <div><p>BrokerStatus status_get()</p> </div></blockquote> <p>Get Jungfraujoch status</p> <p>Status of the data acquisition</p> <section id=id325 > <h2 id=id325 >Example<a class=headerlink href="#id325" title="Link to this heading"></a></h2> <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.models.broker_status</span> <span class=kn >import</span> <span class=n >BrokerStatus</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 ># Get Jungfraujoch status</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >status_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;status_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;status_get: </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=id326 > <h2 id=id326 >Parameters<a class=headerlink href="#id326" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id327 > <h2 id=id327 >Return type<a class=headerlink href="#id327" title="Link to this heading"></a></h2> <p><a class="reference internal" href=BrokerStatus.html ><span class="std std-doc"><strong>BrokerStatus</strong></span></a></p> </section> <section id=id328 > <h2 id=id328 >Authorization<a class=headerlink href="#id328" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id329 > <h2 id=id329 >HTTP request headers<a class=headerlink href="#id329" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id330 > <h2 id=id330 >HTTP response details<a class=headerlink href="#id330" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Everything OK</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=trigger-post > <h1 id=trigger-post ><strong>trigger_post</strong><a class=headerlink href="#trigger-post" title="Link to this heading"></a></h1> <blockquote> <div><p>trigger_post()</p> </div></blockquote> <p>Send soft trigger to the detector</p> <p>Generate soft trigger</p> <section id=id331 > <h2 id=id331 >Example<a class=headerlink href="#id331" title="Link to this heading"></a></h2> <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 ># Send soft trigger to the detector</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >trigger_post</span><span class=p >()</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;trigger_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=id332 > <h2 id=id332 >Parameters<a class=headerlink href="#id332" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id333 > <h2 id=id333 >Return type<a class=headerlink href="#id333" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id334 > <h2 id=id334 >Authorization<a class=headerlink href="#id334" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id335 > <h2 id=id335 >HTTP request headers<a class=headerlink href="#id335" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: Not defined</p> </ul> </section> <section id=id336 > <h2 id=id336 >HTTP response details<a class=headerlink href="#id336" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Trigger sent</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=version-get > <h1 id=version-get ><strong>version_get</strong><a class=headerlink href="#version-get" title="Link to this heading"></a></h1> <blockquote> <div><p>str version_get()</p> </div></blockquote> <p>Get Jungfraujoch version of jfjoch_broker</p> <section id=id337 > <h2 id=id337 >Example<a class=headerlink href="#id337" title="Link to this heading"></a></h2> <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 ># Get Jungfraujoch version of jfjoch_broker</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >version_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;version_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;version_get: </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=id338 > <h2 id=id338 >Parameters<a class=headerlink href="#id338" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id339 > <h2 id=id339 >Return type<a class=headerlink href="#id339" title="Link to this heading"></a></h2> <p><strong>str</strong></p> </section> <section id=id340 > <h2 id=id340 >Authorization<a class=headerlink href="#id340" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id341 > <h2 id=id341 >HTTP request headers<a class=headerlink href="#id341" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: text/plain</p> </ul> </section> <section id=id342 > <h2 id=id342 >HTTP response details<a class=headerlink href="#id342" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Release number of Jungfraujoch</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=wait-till-done-post > <h1 id=wait-till-done-post ><strong>wait_till_done_post</strong><a class=headerlink href="#wait-till-done-post" title="Link to this heading"></a></h1> <blockquote> <div><p>wait_till_done_post(timeout=timeout)</p> </div></blockquote> <p>Wait for acquisition done</p> <p>Block execution of external script till initialization, data collection or pedestal is finished. Running this command does not affect (cancel) running data collection, it is only to ensure synchronous execution of other software.</p> <p>To not block web server for a indefinite period of time, the procedure is provided with a timeout. Extending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.</p> <section id=id343 > <h2 id=id343 >Example<a class=headerlink href="#id343" title="Link to this heading"></a></h2> <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=n >timeout</span> <span class=o >=</span> <span class=mi >60</span> <span class=c1 ># int | Timeout in seconds (0 == immediate response) (optional) (default to 60)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Wait for acquisition done</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >wait_till_done_post</span><span class=p >(</span><span class=n >timeout</span><span class=o >=</span><span class=n >timeout</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;wait_till_done_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=id344 > <h2 id=id344 >Parameters<a class=headerlink href="#id344" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>timeout</strong></p> <td><p><strong>int</strong></p> <td><p>Timeout in seconds (0 == immediate response)</p> <td><p>[optional] [default to 60]</p> </table> </section> <section id=id345 > <h2 id=id345 >Return type<a class=headerlink href="#id345" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id346 > <h2 id=id346 >Authorization<a class=headerlink href="#id346" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id347 > <h2 id=id347 >HTTP request headers<a class=headerlink href="#id347" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id348 > <h2 id=id348 >HTTP response details<a class=headerlink href="#id348" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Detector in `Idle` state, another data collection can start immediately</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Timeout parameter out of bounds</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>502</strong></p> <td><p>Detector is inactive mode</p> <td><p>-</p> <tr class=row-even ><td><p><strong>504</strong></p> <td><p>Timeout reached, need to restart operation</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=wait-until-running-post > <h1 id=wait-until-running-post ><strong>wait_until_running_post</strong><a class=headerlink href="#wait-until-running-post" title="Link to this heading"></a></h1> <blockquote> <div><p>wait_until_running_post(timeout=timeout)</p> </div></blockquote> <p>Wait for acquisition running</p> <p>Block execution of external script till detector and Jungfraujoch are ready to collect data. To not block web server for a indefinite period of time, the procedure is provided with a timeout. Extending timeout is possible, but requires to ensure safety that client will not close the connection and retry the connection.</p> <section id=id349 > <h2 id=id349 >Example<a class=headerlink href="#id349" title="Link to this heading"></a></h2> <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=n >timeout</span> <span class=o >=</span> <span class=mi >60</span> <span class=c1 ># int | Timeout in seconds (0 == immediate response) (optional) (default to 60)</span>
<span class=k >try</span><span class=p >:</span>
<span class=c1 ># Wait for acquisition running</span>
<span class=n >api_instance</span><span class=o >.</span><span class=n >wait_until_running_post</span><span class=p >(</span><span class=n >timeout</span><span class=o >=</span><span class=n >timeout</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;wait_until_running_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=id350 > <h2 id=id350 >Parameters<a class=headerlink href="#id350" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Name</p> <th class=head ><p>Type</p> <th class=head ><p>Description</p> <th class=head ><p>Notes</p> <tr class=row-even ><td><p><strong>timeout</strong></p> <td><p><strong>int</strong></p> <td><p>Timeout in seconds (0 == immediate response)</p> <td><p>[optional] [default to 60]</p> </table> </section> <section id=id351 > <h2 id=id351 >Return type<a class=headerlink href="#id351" title="Link to this heading"></a></h2> <p>void (empty response body)</p> </section> <section id=id352 > <h2 id=id352 >Authorization<a class=headerlink href="#id352" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id353 > <h2 id=id353 >HTTP request headers<a class=headerlink href="#id353" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id354 > <h2 id=id354 >HTTP response details<a class=headerlink href="#id354" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Detector in `Measuring` state</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>400</strong></p> <td><p>Timeout parameter out of bounds</p> <td><p>-</p> <tr class=row-even ><td><p><strong>500</strong></p> <td><p>Error within Jungfraujoch code - see output message.</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>502</strong></p> <td><p>Detector is inactive mode</p> <td><p>-</p> <tr class=row-even ><td><p><strong>504</strong></p> <td><p>Timeout reached, need to restart operation</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=xfel-event-code-get > <h1 id=xfel-event-code-get ><strong>xfel_event_code_get</strong><a class=headerlink href="#xfel-event-code-get" title="Link to this heading"></a></h1> <blockquote> <div><p>List[int] xfel_event_code_get()</p> </div></blockquote> <p>Return XFEL event codes for the current data acquisition</p> <p>Return array of XFEL event codes</p> <section id=id355 > <h2 id=id355 >Example<a class=headerlink href="#id355" title="Link to this heading"></a></h2> <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 ># Return XFEL event codes for the current data acquisition</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >xfel_event_code_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;xfel_event_code_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;xfel_event_code_get: </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=id356 > <h2 id=id356 >Parameters<a class=headerlink href="#id356" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id357 > <h2 id=id357 >Return type<a class=headerlink href="#id357" title="Link to this heading"></a></h2> <p><strong>List[int]</strong></p> </section> <section id=id358 > <h2 id=id358 >Authorization<a class=headerlink href="#id358" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id359 > <h2 id=id359 >HTTP request headers<a class=headerlink href="#id359" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id360 > <h2 id=id360 >HTTP response details<a class=headerlink href="#id360" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Event codes collected</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>Not in XFEL mode or no acquisition recorded</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></a></p> </section> </section> <section class="tex2jax_ignore mathjax_ignore" id=xfel-pulse-id-get > <h1 id=xfel-pulse-id-get ><strong>xfel_pulse_id_get</strong><a class=headerlink href="#xfel-pulse-id-get" title="Link to this heading"></a></h1> <blockquote> <div><p>List[int] xfel_pulse_id_get()</p> </div></blockquote> <p>Return XFEL pulse IDs for the current data acquisition</p> <p>Return array of XFEL pulse IDs - (-1) if image not recorded</p> <section id=id361 > <h2 id=id361 >Example<a class=headerlink href="#id361" title="Link to this heading"></a></h2> <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 ># Return XFEL pulse IDs for the current data acquisition</span>
<span class=n >api_response</span> <span class=o >=</span> <span class=n >api_instance</span><span class=o >.</span><span class=n >xfel_pulse_id_get</span><span class=p >()</span>
<span class=nb >print</span><span class=p >(</span><span class=s2 >"The response of DefaultApi-&gt;xfel_pulse_id_get:</span><span class=se >\n</span><span class=s2 >"</span><span class=p >)</span>
<span class=n >pprint</span><span class=p >(</span><span class=n >api_response</span><span class=p >)</span>
<span class=k >except</span> <span class=ne >Exception</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-&gt;xfel_pulse_id_get: </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=id362 > <h2 id=id362 >Parameters<a class=headerlink href="#id362" title="Link to this heading"></a></h2> <p>This endpoint does not need any parameter.</p> </section> <section id=id363 > <h2 id=id363 >Return type<a class=headerlink href="#id363" title="Link to this heading"></a></h2> <p><strong>List[int]</strong></p> </section> <section id=id364 > <h2 id=id364 >Authorization<a class=headerlink href="#id364" title="Link to this heading"></a></h2> <p>No authorization required</p> </section> <section id=id365 > <h2 id=id365 >HTTP request headers<a class=headerlink href="#id365" title="Link to this heading"></a></h2> <ul class=simple > <li><p><strong>Content-Type</strong>: Not defined</p> <li><p><strong>Accept</strong>: application/json</p> </ul> </section> <section id=id366 > <h2 id=id366 >HTTP response details<a class=headerlink href="#id366" title="Link to this heading"></a></h2> <table> <thead> <tr class=row-odd ><th class=head ><p>Status code</p> <th class=head ><p>Description</p> <th class=head ><p>Response headers</p> <tr class=row-even ><td><p><strong>200</strong></p> <td><p>Pulse ID collected</p> <td><p>-</p> <tr class=row-odd ><td><p><strong>404</strong></p> <td><p>Not in XFEL mode or no acquisition recorded</p> <td><p>-</p> </table> <p><a class="reference internal" href="#"><span class="xref myst">[Back to top]</span></a> <a class="reference internal" href="../README.html#documentation-for-api-endpoints"><span class="std std-ref">[Back to API list]</span></a> <a class="reference internal" href="../README.html#documentation-for-models"><span class="std std-ref">[Back to Model list]</span></a> <a class="reference internal" href="../README.html"><span class="std std-doc">[Back to README]</span></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="../README.html" title=jfjoch-client 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> jfjoch-client </span> </div> </a> </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 > &#169; 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>
Reference in New Issue View Git Blame Copy Permalink