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

14 lines
26 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>ImageFormatSettings &#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" /> <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/ImageFormatSettings" 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 > ImageFormatSettings </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 > <a href=DefaultApi.html class=md-nav__link >jfjoch_client.DefaultApi</a> <li class=md-nav__item > <a href="DefaultApi.html#cancel-post" class=md-nav__link ><strong>cancel_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-azim-int-get" class=md-nav__link ><strong>config_azim_int_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-azim-int-put" class=md-nav__link ><strong>config_azim_int_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-dark-mask-get" class=md-nav__link ><strong>config_dark_mask_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-dark-mask-put" class=md-nav__link ><strong>config_dark_mask_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-detector-get" class=md-nav__link ><strong>config_detector_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-detector-put" class=md-nav__link ><strong>config_detector_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-file-writer-get" class=md-nav__link ><strong>config_file_writer_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-file-writer-put" class=md-nav__link ><strong>config_file_writer_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-image-format-conversion-post" class=md-nav__link ><strong>config_image_format_conversion_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-image-format-get" class=md-nav__link ><strong>config_image_format_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-image-format-put" class=md-nav__link ><strong>config_image_format_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-image-format-raw-post" class=md-nav__link ><strong>config_image_format_raw_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-indexing-get" class=md-nav__link ><strong>config_indexing_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-indexing-put" class=md-nav__link ><strong>config_indexing_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-instrument-get" class=md-nav__link ><strong>config_instrument_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-instrument-put" class=md-nav__link ><strong>config_instrument_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-internal-generator-image-put" class=md-nav__link ><strong>config_internal_generator_image_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-internal-generator-image-tiff-put" class=md-nav__link ><strong>config_internal_generator_image_tiff_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-mask-get" class=md-nav__link ><strong>config_mask_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-mask-tiff-get" class=md-nav__link ><strong>config_mask_tiff_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-roi-get" class=md-nav__link ><strong>config_roi_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-roi-put" class=md-nav__link ><strong>config_roi_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-select-detector-get" class=md-nav__link ><strong>config_select_detector_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-select-detector-put" class=md-nav__link ><strong>config_select_detector_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-spot-finding-get" class=md-nav__link ><strong>config_spot_finding_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-spot-finding-put" class=md-nav__link ><strong>config_spot_finding_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-user-mask-get" class=md-nav__link ><strong>config_user_mask_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-user-mask-put" class=md-nav__link ><strong>config_user_mask_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-user-mask-tiff-get" class=md-nav__link ><strong>config_user_mask_tiff_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-user-mask-tiff-put" class=md-nav__link ><strong>config_user_mask_tiff_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-zeromq-metadata-get" class=md-nav__link ><strong>config_zeromq_metadata_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-zeromq-metadata-put" class=md-nav__link ><strong>config_zeromq_metadata_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-zeromq-preview-get" class=md-nav__link ><strong>config_zeromq_preview_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-zeromq-preview-put" class=md-nav__link ><strong>config_zeromq_preview_put</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#deactivate-post" class=md-nav__link ><strong>deactivate_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#detector-status-get" class=md-nav__link ><strong>detector_status_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#fpga-status-get" class=md-nav__link ><strong>fpga_status_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#image-buffer-clear-post" class=md-nav__link ><strong>image_buffer_clear_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#image-buffer-image-cbor-get" class=md-nav__link ><strong>image_buffer_image_cbor_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#image-buffer-image-jpeg-get" class=md-nav__link ><strong>image_buffer_image_jpeg_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#image-buffer-image-tiff-get" class=md-nav__link ><strong>image_buffer_image_tiff_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#image-buffer-start-cbor-get" class=md-nav__link ><strong>image_buffer_start_cbor_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#image-buffer-status-get" class=md-nav__link ><strong>image_buffer_status_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#image-pusher-status-get" class=md-nav__link ><strong>image_pusher_status_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#initialize-post" class=md-nav__link ><strong>initialize_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#pedestal-post" class=md-nav__link ><strong>pedestal_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#preview-pedestal-tiff-get" class=md-nav__link ><strong>preview_pedestal_tiff_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#preview-plot-bin-get" class=md-nav__link ><strong>preview_plot_bin_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#preview-plot-get" class=md-nav__link ><strong>preview_plot_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#result-scan-get" class=md-nav__link ><strong>result_scan_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#start-post" class=md-nav__link ><strong>start_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#statistics-calibration-get" class=md-nav__link ><strong>statistics_calibration_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#statistics-data-collection-get" class=md-nav__link ><strong>statistics_data_collection_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#statistics-get" class=md-nav__link ><strong>statistics_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#status-get" class=md-nav__link ><strong>status_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#trigger-post" class=md-nav__link ><strong>trigger_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#version-get" class=md-nav__link ><strong>version_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#wait-till-done-post" class=md-nav__link ><strong>wait_till_done_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#wait-until-running-post" class=md-nav__link ><strong>wait_until_running_post</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#xfel-event-code-get" class=md-nav__link ><strong>xfel_event_code_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#xfel-pulse-id-get" class=md-nav__link ><strong>xfel_pulse_id_get</strong></a> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=toc > <div class=md-sidebar__scrollwrap > <div class=md-sidebar__inner > <nav class="md-nav md-nav--secondary"> <ul class=md-nav__list data-md-scrollfix=""> </ul> </nav> </div> </div> </div> <div class=md-content > <article class="md-content__inner md-typeset" role=main > <section class="tex2jax_ignore mathjax_ignore" id=imageformatsettings > <h1 id=python-client-docs-imageformatsettings--page-root >ImageFormatSettings<a class=headerlink href="#python-client-docs-imageformatsettings--page-root" title="Link to this heading"></a></h1> <section id=properties > <h2 id=properties >Properties<a class=headerlink href="#properties" 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>summation</strong></p> <td><p><strong>bool</strong></p> <td><p>Enable summation of images to a given image_time If disabled images are saved according to original detector speed, but image count is adjusted</p> <td><p></p> <tr class=row-odd ><td><p><strong>geometry_transform</strong></p> <td><p><strong>bool</strong></p> <td><p>Place module read-out into their location on composed detector and extend multipixels</p> <td><p></p> <tr class=row-even ><td><p><strong>jungfrau_conversion</strong></p> <td><p><strong>bool</strong></p> <td><p>Convert pixel value in ADU to photon counts/energy Only affects JUNGFRAU detector</p> <td><p></p> <tr class=row-odd ><td><p><strong>jungfrau_conversion_factor_ke_v</strong></p> <td><p><strong>float</strong></p> <td><p>Used to convert energy deposited into pixel to counts If not provided incident_energy_keV is used</p> <td><p>[optional]</p> <tr class=row-even ><td><p><strong>bit_depth_image</strong></p> <td><p><strong>int</strong></p> <td><p>Bit depth of resulting image (it doesn’t affect the detector read-out value) If not provided value is adjusted automatically</p> <td><p>[optional]</p> <tr class=row-odd ><td><p><strong>signed_output</strong></p> <td><p><strong>bool</strong></p> <td><p>Controls if pixels have signed output If not provided value is adjusted automatically</p> <td><p>[optional]</p> <tr class=row-even ><td><p><strong>mask_module_edges</strong></p> <td><p><strong>bool</strong></p> <td><p>Mask 1 pixel on the module boundary</p> <td><p>[default to True]</p> <tr class=row-odd ><td><p><strong>mask_chip_edges</strong></p> <td><p><strong>bool</strong></p> <td><p>Mask multipixels on chip boundary</p> <td><p>[default to True]</p> <tr class=row-even ><td><p><strong>jungfrau_mask_pixels_without_g0</strong></p> <td><p><strong>bool</strong></p> <td><p>JUNGFRAU: mask pixels that don’t operate in G0, but do operate in G1 and G1. This should be turned off for cases, where detector is operated at room temperature with long exposure time.</p> <td><p>[optional] [default to True]</p> <tr class=row-odd ><td><p><strong>apply_mask</strong></p> <td><p><strong>bool</strong></p> <td><p>Masked pixels are set to special value in the images produced by Jungfraujoch</p> <td><p>[default to False]</p> <tr class=row-even ><td><p><strong>jungfrau_pedestal_g0_rms_limit</strong></p> <td><p><strong>int</strong></p> <td><p>Pixels with pedestal G0 RMS above the threshold are marked as masked pixels</p> <td><p>[optional] [default to 100]</p> </table> </section> <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 >from</span> <span class=nn >jfjoch_client.models.image_format_settings</span> <span class=kn >import</span> <span class=n >ImageFormatSettings</span>
<span class=c1 ># TODO update the JSON string below</span>
<span class=n >json</span> <span class=o >=</span> <span class=s2 >"</span><span class=si >{}</span><span class=s2 >"</span>
<span class=c1 ># create an instance of ImageFormatSettings from a JSON string</span>
<span class=n >image_format_settings_instance</span> <span class=o >=</span> <span class=n >ImageFormatSettings</span><span class=o >.</span><span class=n >from_json</span><span class=p >(</span><span class=n >json</span><span class=p >)</span>
<span class=c1 ># print the JSON string representation of the object</span>
<span class=nb >print</span><span class=p >(</span><span class=n >ImageFormatSettings</span><span class=o >.</span><span class=n >to_json</span><span class=p >())</span>
<span class=c1 ># convert the object into a dict</span>
<span class=n >image_format_settings_dict</span> <span class=o >=</span> <span class=n >image_format_settings_instance</span><span class=o >.</span><span class=n >to_dict</span><span class=p >()</span>
<span class=c1 ># create an instance of ImageFormatSettings from a dict</span>
<span class=n >image_format_settings_from_dict</span> <span class=o >=</span> <span class=n >ImageFormatSettings</span><span class=o >.</span><span class=n >from_dict</span><span class=p >(</span><span class=n >image_format_settings_dict</span><span class=p >)</span>
</pre></div> </div> <p><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#documentation-for-api-endpoints"><span class="std std-ref">[Back to API 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> </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