mx/Jungfraujoch
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 68 Wiki Activity
Files
fad395dc6041957ee64db53bee4bdbc02c1755cb
Jungfraujoch/python_client/docs/SpotFindingSettings.html
T
leonarski_f fad395dc60 Deploy site
2026-08-13 18:43:50 +00:00

14 lines
44 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>SpotFindingSettings &#8212; Jungfraujoch 1.0.0-rc.161 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=010ab5da"></script> <script src="../../_static/doctools.js?v=9bcbadda"></script> <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel=icon href="../../_static/jfjoch.png"/> <link rel=index title=Index href="../../genindex.html" /> <link rel=search title=Search href="../../search.html" /> <link rel=next title=StandardDetectorGeometry href=StandardDetectorGeometry.html /> <link rel=prev title=ScanResultImagesInner href=ScanResultImagesInner.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/SpotFindingSettings" 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.161 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 > SpotFindingSettings </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.161 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.161 documentation" class="md-nav__button md-logo"> <i class=md-icon >&#xe30d</i> </a> <a href="../../index.html" title="Jungfraujoch 1.0.0-rc.161 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="../../THIRD_PARTY_NOTICES.html" class=md-nav__link >Third-party software notices</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="../../RELEASE_CONTENTS.html" class=md-nav__link >Release contents</a> <li class=md-nav__item > <a href="../../REPOSITORIES.html" class=md-nav__link >Linux package repositories</a> <li class=md-nav__item > <a href="../../NAMING.html" class=md-nav__link >Naming</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="../../RUGNUX.html" class=md-nav__link >rugnux</a> <li class=md-nav__item > <a href="../../JFJOCH_VIEWER.html" class=md-nav__link >jfjoch_viewer</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="../../HDF5.html" class=md-nav__link >HDF5 / NeXus data format</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-bragg-integration-get" class=md-nav__link ><strong>config_bragg_integration_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-bragg-integration-put" class=md-nav__link ><strong>config_bragg_integration_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> <li class=md-nav__item > <a href=AzimIntSettings.html class=md-nav__link >AzimIntSettings</a> <li class=md-nav__item > <a href=BraggIntegrationSettings.html class=md-nav__link >BraggIntegrationSettings</a> <li class=md-nav__item > <a href=BrokerStatus.html class=md-nav__link >BrokerStatus</a> <li class=md-nav__item > <a href=CalibrationStatisticsInner.html class=md-nav__link >CalibrationStatisticsInner</a> <li class=md-nav__item > <a href=DarkMaskSettings.html class=md-nav__link >DarkMaskSettings</a> <li class=md-nav__item > <a href=DatasetSettings.html class=md-nav__link >DatasetSettings</a> <li class=md-nav__item > <a href=DatasetSettingsSmargon.html class=md-nav__link >DatasetSettingsSmargon</a> <li class=md-nav__item > <a href=DatasetSettingsXrayFluorescenceSpectrum.html class=md-nav__link >DatasetSettingsXrayFluorescenceSpectrum</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-bragg-integration-get" class=md-nav__link ><strong>config_bragg_integration_get</strong></a> <li class=md-nav__item > <a href="DefaultApi.html#config-bragg-integration-put" class=md-nav__link ><strong>config_bragg_integration_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> <li class=md-nav__item > <a href=Detector.html class=md-nav__link >Detector</a> <li class=md-nav__item > <a href=DetectorList.html class=md-nav__link >DetectorList</a> <li class=md-nav__item > <a href=DetectorListElement.html class=md-nav__link >DetectorListElement</a> <li class=md-nav__item > <a href=DetectorModule.html class=md-nav__link >DetectorModule</a> <li class=md-nav__item > <a href=DetectorModuleDirection.html class=md-nav__link >DetectorModuleDirection</a> <li class=md-nav__item > <a href=DetectorPowerState.html class=md-nav__link >DetectorPowerState</a> <li class=md-nav__item > <a href=DetectorSelection.html class=md-nav__link >DetectorSelection</a> <li class=md-nav__item > <a href=DetectorSettings.html class=md-nav__link >DetectorSettings</a> <li class=md-nav__item > <a href=DetectorState.html class=md-nav__link >DetectorState</a> <li class=md-nav__item > <a href=DetectorStatus.html class=md-nav__link >DetectorStatus</a> <li class=md-nav__item > <a href=DetectorTiming.html class=md-nav__link >DetectorTiming</a> <li class=md-nav__item > <a href=DetectorType.html class=md-nav__link >DetectorType</a> <li class=md-nav__item > <a href=ErrorMessage.html class=md-nav__link >ErrorMessage</a> <li class=md-nav__item > <a href=FileWriterFormat.html class=md-nav__link >FileWriterFormat</a> <li class=md-nav__item > <a href=FileWriterSettings.html class=md-nav__link >FileWriterSettings</a> <li class=md-nav__item > <a href=FpgaStatusInner.html class=md-nav__link >FpgaStatusInner</a> <li class=md-nav__item > <a href=GeomRefinementAlgorithm.html class=md-nav__link >GeomRefinementAlgorithm</a> <li class=md-nav__item > <a href=GridScan.html class=md-nav__link >GridScan</a> <li class=md-nav__item > <a href=ImageBufferStatus.html class=md-nav__link >ImageBufferStatus</a> <li class=md-nav__item > <a href=ImageFormatSettings.html class=md-nav__link >ImageFormatSettings</a> <li class=md-nav__item > <a href=ImagePusherStatus.html class=md-nav__link >ImagePusherStatus</a> <li class=md-nav__item > <a href=ImagePusherType.html class=md-nav__link >ImagePusherType</a> <li class=md-nav__item > <a href=IndexingAlgorithm.html class=md-nav__link >IndexingAlgorithm</a> <li class=md-nav__item > <a href=IndexingSettings.html class=md-nav__link >IndexingSettings</a> <li class=md-nav__item > <a href=InstrumentMetadata.html class=md-nav__link >InstrumentMetadata</a> <li class=md-nav__item > <a href=IntegrationModel.html class=md-nav__link >IntegrationModel</a> <li class=md-nav__item > <a href=JfjochSettings.html class=md-nav__link >JfjochSettings</a> <li class=md-nav__item > <a href=JfjochStatistics.html class=md-nav__link >JfjochStatistics</a> <li class=md-nav__item > <a href=MeasurementStatistics.html class=md-nav__link >MeasurementStatistics</a> <li class=md-nav__item > <a href=PcieDevicesInner.html class=md-nav__link >PcieDevicesInner</a> <li class=md-nav__item > <a href=PixelMaskStatistics.html class=md-nav__link >PixelMaskStatistics</a> <li class=md-nav__item > <a href=Plot.html class=md-nav__link >Plot</a> <li class=md-nav__item > <a href=PlotUnitX.html class=md-nav__link >PlotUnitX</a> <li class=md-nav__item > <a href=Plots.html class=md-nav__link >Plots</a> <li class=md-nav__item > <a href=RoiAzimList.html class=md-nav__link >RoiAzimList</a> <li class=md-nav__item > <a href=RoiAzimuthal.html class=md-nav__link >RoiAzimuthal</a> <li class=md-nav__item > <a href=RoiBox.html class=md-nav__link >RoiBox</a> <li class=md-nav__item > <a href=RoiBoxList.html class=md-nav__link >RoiBoxList</a> <li class=md-nav__item > <a href=RoiCircle.html class=md-nav__link >RoiCircle</a> <li class=md-nav__item > <a href=RoiCircleList.html class=md-nav__link >RoiCircleList</a> <li class=md-nav__item > <a href=RoiDefinitions.html class=md-nav__link >RoiDefinitions</a> <li class=md-nav__item > <a href=RotationAxis.html class=md-nav__link >RotationAxis</a> <li class=md-nav__item > <a href=ScanResult.html class=md-nav__link >ScanResult</a> <li class=md-nav__item > <a href=ScanResultImagesInner.html class=md-nav__link >ScanResultImagesInner</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 > SpotFindingSettings </label> <a href="#" class="md-nav__link md-nav__link--active">SpotFindingSettings</a> <nav class="md-nav md-nav--secondary"> <ul class=md-nav__list data-md-scrollfix=""> </ul> </nav> <ul class=md-nav__list > <li class=md-nav__item > <a href="#properties" class=md-nav__link >Properties</a> <li class=md-nav__item > <a href="#example" class=md-nav__link >Example</a> </ul> <li class=md-nav__item > <a href=StandardDetectorGeometry.html class=md-nav__link >StandardDetectorGeometry</a> <li class=md-nav__item > <a href=TcpSettings.html class=md-nav__link >TcpSettings</a> <li class=md-nav__item > <a href=UnitCell.html class=md-nav__link >UnitCell</a> <li class=md-nav__item > <a href=ZeromqMetadataSettings.html class=md-nav__link >ZeromqMetadataSettings</a> <li class=md-nav__item > <a href=ZeromqPreviewSettings.html class=md-nav__link >ZeromqPreviewSettings</a> <li class=md-nav__item > <a href=ZeromqSettings.html class=md-nav__link >ZeromqSettings</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=spotfindingsettings > <h1 id=python-client-docs-spotfindingsettings--page-root >SpotFindingSettings<a class=headerlink href="#python-client-docs-spotfindingsettings--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>enable</strong></p> <td><p><strong>bool</strong></p> <td><p>Enable spot finding. This is temporary setting, i.e. can be changed anytime during data collection. Even if disabled spot finding information will still be send and written, though always with zero spots.</p> <td><p>[default to True]</p> <tr class=row-odd ><td><p><strong>indexing</strong></p> <td><p><strong>bool</strong></p> <td><p>Enable indexing. This is temporary setting, i.e. can be changed anytime during data collection.</p> <td><p>[default to True]</p> <tr class=row-even ><td><p><strong>signal_to_noise_threshold</strong></p> <td><p><strong>float</strong></p> <td><p></p> <td><p></p> <tr class=row-odd ><td><p><strong>photon_count_threshold</strong></p> <td><p><strong>int</strong></p> <td><p></p> <td><p></p> <tr class=row-even ><td><p><strong>min_pix_per_spot</strong></p> <td><p><strong>int</strong></p> <td><p></p> <td><p></p> <tr class=row-odd ><td><p><strong>max_pix_per_spot</strong></p> <td><p><strong>int</strong></p> <td><p></p> <td><p></p> <tr class=row-even ><td><p><strong>high_resolution_limit</strong></p> <td><p><strong>float</strong></p> <td><p>High resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding extends as far as the detector reaches, i.e. the detection is not clipped in resolution.</p> <td><p>[optional]</p> <tr class=row-odd ><td><p><strong>low_resolution_limit</strong></p> <td><p><strong>float</strong></p> <td><p>Low resolution limit for spot finding [Angstrom]. Optional: if omitted, spot finding is not clipped at the low-resolution end. A value of 0 is accepted and means the same thing.</p> <td><p>[optional]</p> <tr class=row-even ><td><p><strong>high_resolution_limit_for_spot_count_low_res</strong></p> <td><p><strong>float</strong></p> <td><p>High resolution threshold to consider spot &amp;quot;low resolution&amp;quot; [Angstrom]</p> <td><p></p> <tr class=row-odd ><td><p><strong>quick_integration</strong></p> <td><p><strong>bool</strong></p> <td><p>Quick integration of Bragg spots in diffraction images. If enabled it will likely reduce performance of Jungfraujoch for datasets with a very high indexing rate. (experimental feature)</p> <td><p>[default to False]</p> <tr class=row-even ><td><p><strong>ice_ring_width_q_recip_a</strong></p> <td><p><strong>float</strong></p> <td><p>Half-width of the ice ring band in q (1/A). Matches the offline default in image_analysis/spot_finding/SpotFindingSettings.h, which was set from a measured ring FWHM of ~0.06; the two must agree or the same data gets a narrower ice band online.</p> <td><p>[default to 0.03]</p> <tr class=row-odd ><td><p><strong>high_res_gap_q_recip_a</strong></p> <td><p><strong>float</strong></p> <td><p>This parameter is used to remove spurious spots at a very high resolution, that sometimes appear due to very low background close to the edge of the detector. If there is a gap in (1/d)-space between spots of at least this size, spots on the side of the gap with high resolution will be discarded. This is optional parameter. This option should be turned OFF for small molecule datasets or for crystals with very low mosaicity, when it is expected to see only few spots in any case.</p> <td><p>[optional] [default to 1.5]</p> <tr class=row-even ><td><p><strong>adaptive_threshold</strong></p> <td><p><strong>bool</strong></p> <td><p>Self-calibrating spot detection: replace the fixed photon_count_threshold by a per-resolution-ring threshold derived from each image’s own noise, so the same setting works across datasets without per-dataset tuning. photon_count_threshold is then ignored and false_pixels_per_frame sets the operating point instead. Only available on detectors whose images are analysed in software (the DECTRIS/SIMPLON workflow). The JUNGFRAU and EIGER workflows find spots on the FPGA, which applies its own fixed threshold, so enabling this there is rejected rather than silently ignored.</p> <td><p>[optional] [default to False]</p> <tr class=row-odd ><td><p><strong>false_pixels_per_frame</strong></p> <td><p><strong>float</strong></p> <td><p>Operating point of the adaptive threshold: the number of noise pixels tolerated per frame. About 100 suits a multi-megapixel detector. Ignored unless adaptive_threshold is set.</p> <td><p>[optional] [default to 100.0]</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.spot_finding_settings</span> <span class=kn >import</span> <span class=n >SpotFindingSettings</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 SpotFindingSettings from a JSON string</span>
<span class=n >spot_finding_settings_instance</span> <span class=o >=</span> <span class=n >SpotFindingSettings</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 >SpotFindingSettings</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 >spot_finding_settings_dict</span> <span class=o >=</span> <span class=n >spot_finding_settings_instance</span><span class=o >.</span><span class=n >to_dict</span><span class=p >()</span>
<span class=c1 ># create an instance of SpotFindingSettings from a dict</span>
<span class=n >spot_finding_settings_from_dict</span> <span class=o >=</span> <span class=n >SpotFindingSettings</span><span class=o >.</span><span class=n >from_dict</span><span class=p >(</span><span class=n >spot_finding_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 href=ScanResultImagesInner.html title=ScanResultImagesInner 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> ScanResultImagesInner </span> </div> </a> <a href=StandardDetectorGeometry.html title=StandardDetectorGeometry class="md-flex md-footer-nav__link md-footer-nav__link--next" rel=next > <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"><span class=md-flex__ellipsis > <span class=md-footer-nav__direction > "Next" </span> StandardDetectorGeometry </span> </div> <div class="md-flex__cell md-flex__cell--shrink"><i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright > <div class=md-footer-copyright__highlight > &#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