mx/Jungfraujoch
2
1
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 67 Wiki Activity
Files
cf1aac3632d1c8561dbf3a9f0fbf755d5ad9ea09
Jungfraujoch/JFJOCH_WRITER.html
T
leonarski_f cf1aac3632 Deploy site
2026-04-16 12:12:54 +00:00

70 lines
52 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_writer &#8212; Jungfraujoch 1.0.0-rc.135 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=d1fa3868"></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="Integration with MX data processing software" href=SOFTWARE_INTEGRATION.html /> <link rel=prev title=jfjoch_broker href=JFJOCH_BROKER.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="#JFJOCH_WRITER" 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.135 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_writer </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.135 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.135 documentation" class="md-nav__button md-logo"> <i class=md-icon >&#xe30d</i> </a> <a href=index.html title="Jungfraujoch 1.0.0-rc.135 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 > <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_writer </label> <a href="#" class="md-nav__link md-nav__link--active">jfjoch_writer</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="#acknowledgements" class=md-nav__link >Acknowledgements</a> <li class=md-nav__item > <a href="#running-directory" class=md-nav__link >Running directory</a> <li class=md-nav__item > <a href="#usage" class=md-nav__link >Usage</a> <li class=md-nav__item > <a href="#http-interface" class=md-nav__link >HTTP interface</a> <li class=md-nav__item > <a href="#republish" class=md-nav__link >Republish</a> <li class=md-nav__item > <a href="#overwriting-files" class=md-nav__link >Overwriting files</a> <li class=md-nav__item > <a href="#finalized-files-information" class=md-nav__link >Finalized files information</a> <li class=md-nav__item > <a href="#hdf5-file-structure" class=md-nav__link >HDF5 file structure</a> <li class=md-nav__item > <a href="#other-formats-cbf-and-tiff" class=md-nav__link >Other formats (CBF and TIFF)</a> <li class=md-nav__item > <a href="#no-file-option-s" class=md-nav__link >No file option(s)</a> </ul> <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="python_client/README.html" class=md-nav__link >jfjoch-client</a> <li class=md-nav__item > <a href="python_client/README.html#license-clarification" class=md-nav__link >License Clarification</a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html" class=md-nav__link >jfjoch_client.DefaultApi</a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#cancel-post" class=md-nav__link ><strong>cancel_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-azim-int-get" class=md-nav__link ><strong>config_azim_int_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-azim-int-put" class=md-nav__link ><strong>config_azim_int_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-dark-mask-get" class=md-nav__link ><strong>config_dark_mask_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-dark-mask-put" class=md-nav__link ><strong>config_dark_mask_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-detector-get" class=md-nav__link ><strong>config_detector_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-detector-put" class=md-nav__link ><strong>config_detector_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-file-writer-get" class=md-nav__link ><strong>config_file_writer_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-file-writer-put" class=md-nav__link ><strong>config_file_writer_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-image-format-conversion-post" class=md-nav__link ><strong>config_image_format_conversion_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-image-format-get" class=md-nav__link ><strong>config_image_format_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-image-format-put" class=md-nav__link ><strong>config_image_format_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-image-format-raw-post" class=md-nav__link ><strong>config_image_format_raw_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-indexing-get" class=md-nav__link ><strong>config_indexing_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-indexing-put" class=md-nav__link ><strong>config_indexing_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-instrument-get" class=md-nav__link ><strong>config_instrument_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-instrument-put" class=md-nav__link ><strong>config_instrument_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-internal-generator-image-put" class=md-nav__link ><strong>config_internal_generator_image_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-internal-generator-image-tiff-put" class=md-nav__link ><strong>config_internal_generator_image_tiff_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-mask-get" class=md-nav__link ><strong>config_mask_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-mask-tiff-get" class=md-nav__link ><strong>config_mask_tiff_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-roi-get" class=md-nav__link ><strong>config_roi_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-roi-put" class=md-nav__link ><strong>config_roi_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-select-detector-get" class=md-nav__link ><strong>config_select_detector_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-select-detector-put" class=md-nav__link ><strong>config_select_detector_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-spot-finding-get" class=md-nav__link ><strong>config_spot_finding_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-spot-finding-put" class=md-nav__link ><strong>config_spot_finding_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-user-mask-get" class=md-nav__link ><strong>config_user_mask_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-user-mask-put" class=md-nav__link ><strong>config_user_mask_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-user-mask-tiff-get" class=md-nav__link ><strong>config_user_mask_tiff_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-user-mask-tiff-put" class=md-nav__link ><strong>config_user_mask_tiff_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-zeromq-metadata-get" class=md-nav__link ><strong>config_zeromq_metadata_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-zeromq-metadata-put" class=md-nav__link ><strong>config_zeromq_metadata_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-zeromq-preview-get" class=md-nav__link ><strong>config_zeromq_preview_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#config-zeromq-preview-put" class=md-nav__link ><strong>config_zeromq_preview_put</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#deactivate-post" class=md-nav__link ><strong>deactivate_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#detector-status-get" class=md-nav__link ><strong>detector_status_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#fpga-status-get" class=md-nav__link ><strong>fpga_status_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#image-buffer-clear-post" class=md-nav__link ><strong>image_buffer_clear_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#image-buffer-image-cbor-get" class=md-nav__link ><strong>image_buffer_image_cbor_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#image-buffer-image-jpeg-get" class=md-nav__link ><strong>image_buffer_image_jpeg_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#image-buffer-image-tiff-get" class=md-nav__link ><strong>image_buffer_image_tiff_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#image-buffer-start-cbor-get" class=md-nav__link ><strong>image_buffer_start_cbor_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#image-buffer-status-get" class=md-nav__link ><strong>image_buffer_status_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#image-pusher-status-get" class=md-nav__link ><strong>image_pusher_status_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#initialize-post" class=md-nav__link ><strong>initialize_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#pedestal-post" class=md-nav__link ><strong>pedestal_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#preview-pedestal-tiff-get" class=md-nav__link ><strong>preview_pedestal_tiff_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#preview-plot-bin-get" class=md-nav__link ><strong>preview_plot_bin_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#preview-plot-get" class=md-nav__link ><strong>preview_plot_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#result-scan-get" class=md-nav__link ><strong>result_scan_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#start-post" class=md-nav__link ><strong>start_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#statistics-calibration-get" class=md-nav__link ><strong>statistics_calibration_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#statistics-data-collection-get" class=md-nav__link ><strong>statistics_data_collection_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#statistics-get" class=md-nav__link ><strong>statistics_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#status-get" class=md-nav__link ><strong>status_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#trigger-post" class=md-nav__link ><strong>trigger_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#version-get" class=md-nav__link ><strong>version_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#wait-till-done-post" class=md-nav__link ><strong>wait_till_done_post</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#xfel-event-code-get" class=md-nav__link ><strong>xfel_event_code_get</strong></a> <li class=md-nav__item > <a href="python_client/docs/DefaultApi.html#xfel-pulse-id-get" class=md-nav__link ><strong>xfel_pulse_id_get</strong></a> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=toc > <div class=md-sidebar__scrollwrap > <div class=md-sidebar__inner > <nav class="md-nav md-nav--secondary"> <ul class=md-nav__list data-md-scrollfix=""> </ul> </nav> </div> </div> </div> <div class=md-content > <article class="md-content__inner md-typeset" role=main > <section class="tex2jax_ignore mathjax_ignore" id=jfjoch-writer > <h1 id=jfjoch-writer--page-root >jfjoch_writer<a class=headerlink href="#jfjoch-writer--page-root" title="Link to this heading"></a></h1> <p><code class="docutils literal notranslate"><span class=pre >jfjoch_writer</span></code> is NeXus compliant HDF5 file writer.</p> <section id=acknowledgements > <h2 id=acknowledgements >Acknowledgements<a class=headerlink href="#acknowledgements" title="Link to this heading"></a></h2> <ul class=simple > <li><p>Zdenek Matej (MAX IV)</p> <li><p>Felix Engelmann (MAX IV) for testing and multiple improvement suggestions.</p> </ul> </section> <section id=running-directory > <h2 id=running-directory >Running directory<a class=headerlink href="#running-directory" title="Link to this heading"></a></h2> <p>Writer needs to be running in base directory for writing files - <code class="docutils literal notranslate"><span class=pre >file_prefix</span></code> will be always relative in regard to writer running directory. Writer detects and protects for basic security issues, like <code class="docutils literal notranslate"><span class=pre >file_prefix</span></code> starting with a slash, or starting with <code class="docutils literal notranslate"><span class=pre >../</span></code>, or containing <code class="docutils literal notranslate"><span class=pre >/../</span></code>.</p> </section> <section id=usage > <h2 id=usage >Usage<a class=headerlink href="#usage" title="Link to this heading"></a></h2> <p>Writer needs to be started as a background service, with the following command:</p> <div class="highlight-default notranslate"><div class=highlight ><pre><span></span><span class=n >jfjoch_writer</span> <span class=p >{</span><span class=n >options</span><span class=p >}</span> <span class=o >&lt;</span><span class=n >address</span> <span class=n >to</span> <span class=n >connect</span> <span class=n >via</span> <span class=n >ZeroMQ</span> <span class=n >to</span> <span class=n >DCU</span><span class=o >&gt;</span>
<span class=n >Options</span><span class=p >:</span>
<span class=o >-</span><span class=n >R</span><span class=o >&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=o >|</span> <span class=o >--</span><span class=n >root_dir</span><span class=o >=&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=n >Root</span> <span class=n >directory</span> <span class=k >for</span> <span class=n >file</span> <span class=n >writing</span>
<span class=o >-</span><span class=n >H</span><span class=o >&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=o >|</span> <span class=o >--</span><span class=n >http_port</span><span class=o >=&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=n >HTTP</span> <span class=n >port</span> <span class=k >for</span> <span class=n >statistics</span>
<span class=o >-</span><span class=n >r</span><span class=o >&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=o >|</span> <span class=o >--</span><span class=n >zmq_repub_port</span><span class=o >=&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=n >ZeroMQ</span> <span class=n >port</span> <span class=k >for</span> <span class=n >PUSH</span> <span class=n >socket</span> <span class=n >to</span> <span class=n >republish</span> <span class=n >images</span>
<span class=o >-</span><span class=n >f</span><span class=o >&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=o >|</span> <span class=o >--</span><span class=n >zmq_file_port</span><span class=o >=&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=n >ZeroMQ</span> <span class=n >port</span> <span class=k >for</span> <span class=n >PUB</span> <span class=n >socket</span> <span class=k >for</span> <span class=n >notifications</span> <span class=n >on</span> <span class=n >finalized</span> <span class=n >files</span>
<span class=o >-</span><span class=n >w</span><span class=o >&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=o >|</span> <span class=o >--</span><span class=n >rcv_watermark</span><span class=o >=&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=n >Receiving</span> <span class=n >ZeroMQ</span> <span class=n >socket</span> <span class=n >watermark</span> <span class=p >(</span><span class=n >default</span> <span class=o >=</span> <span class=mi >100</span><span class=p >)</span>
<span class=o >-</span><span class=n >W</span><span class=o >&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=o >|</span> <span class=o >--</span><span class=n >repub_watermark</span><span class=o >=&lt;</span><span class=nb >int</span><span class=o >&gt;</span> <span class=n >Republish</span> <span class=n >ZeroMQ</span> <span class=n >socket</span> <span class=n >watermark</span> <span class=p >(</span><span class=n >default</span> <span class=o >=</span> <span class=mi >1000</span><span class=p >)</span>
</pre></div> </div> <p>for example:</p> <div class="highlight-default notranslate"><div class=highlight ><pre><span></span><span class=n >jfjoch_writer</span> <span class=o >-</span><span class=n >H5234</span> <span class=n >tcp</span><span class=p >:</span><span class=o >//</span><span class=n >dcu</span><span class=o >-</span><span class=n >address</span><span class=p >:</span><span class=mi >5400</span>
</pre></div> </div> </section> <section id=http-interface > <h2 id=http-interface >HTTP interface<a class=headerlink href="#http-interface" title="Link to this heading"></a></h2> <p>Writer has dedicated status interface via HTTP. It allows for two operations:</p> <ul class=simple > <li><p><em><strong>check state of the writer</strong></em> to check if the writer is properly synchronized with DCU (e.g., that <code class="docutils literal notranslate"><span class=pre >file_prefix</span></code> agrees with what was set on the DCU) and monitor progress.</p> <li><p><em><strong>cancel writing</strong></em> this will close all the HDF5 files being written and restart writer - the option should be used only if DCU process was terminated or disconnected, it SHOULD NOT be used as standard cancellation procedure (when DCU received cancel command it should properly finish writing as well)</p> </ul> </section> <section id=republish > <h2 id=republish >Republish<a class=headerlink href="#republish" title="Link to this heading"></a></h2> <p>Republish creates a PULL socket on the writer, where all the messages are republished for further use by data analysis pipeline. Republish is non-blocking, so if there is no receiver on other end or the sending queue is full - images won’t be republished. In case of START/END messages republishing will attempt sending for 100 ms, but if send times out it won’t be retried.</p> <p>Republish functionality is optional, if republish port number is omitted this functionality is not enabled.</p> </section> <section id=overwriting-files > <h2 id=overwriting-files >Overwriting files<a class=headerlink href="#overwriting-files" title="Link to this heading"></a></h2> <p>When <code class="docutils literal notranslate"><span class=pre >jfjoch_writer</span></code> creates a HDF5 file, it first adds suffix <code class="docutils literal notranslate"><span class=pre >.&lt;random&gt;.tmp</span></code>. Random value depends on current time-stamp and likely will be different from each file of the particular series. After file is all saved and closed, it is renamed to remove the suffix. By default, renaming won’t happen if this would overwrite existing file. However, this behavior can be changed by setting <code class="docutils literal notranslate"><span class=pre >overwrite</span></code> parameter to true in the file writer configuration.</p> </section> <section id=finalized-files-information > <h2 id=finalized-files-information >Finalized files information<a class=headerlink href="#finalized-files-information" title="Link to this heading"></a></h2> <p>Creates PUB socket to inform about finalized data files. For each closed file, the socket will send a JSON message, with the following structure:</p> <div class="highlight-default notranslate"><div class=highlight ><pre><span></span>{
"filename": &lt;string&gt;: HDF5 data file name (relative to writer root directory),
"nimages": &lt;int&gt; number of images in the file (counting from 1!),
"file_number": &lt;int&gt; number of file within the acquisition,
"sample_name": &lt;string&gt; name of sample,
"run_name": &lt;string&gt; name of run,
"run_number": &lt;int&gt; number of run,
"experiment_group": &lt;string&gt; number of p-group / proposal (optional),
"user_data": &lt;any json&gt; user_data,
"beam_x_pxl": &lt;float&gt; beam center (X) in pixels,
"beam_y_pxl": &lt;float&gt; beam center (Y) in pixels,
"detector_distance_m": &lt;float&gt; detector distance (X) in m,
"detector_height_pxl": &lt;int&gt; detector size (X) in pixels,
"detector_width_pxl": &lt;int&gt; detector size (Y) in pixels,
"incident_energy_eV": &lt;float&gt; photon energy of the X-ray beam,
"pixel_size_m": &lt;float&gt; pixel size in meter (assuming pixel X == Y),
"saturation": &lt;int&gt; this count and higher mean saturation,
"space_group_number": &lt;int&gt; space group number (optional),
"underload": &lt;int&gt; pixels with this count should be excluded,
"unit_cell": &lt;optinal&gt; unit cell dimensions in Angstrom/degree {
"a": &lt;float&gt;, "b": &lt;float&gt;, "c": &lt;float&gt;,
"alpha": &lt;float&gt;, "beta": &lt;float&gt;, "gamma": &lt;float&gt;
},
}
</pre></div> </div> <p><code class="docutils literal notranslate"><span class=pre >user_data</span></code> is defined as <code class="docutils literal notranslate"><span class=pre >header_appendix</span></code> in the <code class="docutils literal notranslate"><span class=pre >/start</span></code> operation in the <code class="docutils literal notranslate"><span class=pre >jfjoch_broker</span></code>. Other metadata are also carried over from <code class="docutils literal notranslate"><span class=pre >/start</span></code> operation.</p> <p>If the <code class="docutils literal notranslate"><span class=pre >header_appendix</span></code> is a string with valid JSON meaning, it will be embedded as JSON, otherwise it will be escaped as string. For example <code class="docutils literal notranslate"><span class=pre >header_appendix</span></code> of <code class="docutils literal notranslate"><span class=pre >{"param1":</span> <span class=pre >"test1",</span> <span class=pre >"param2":</span> <span class=pre >["test1",</span> <span class=pre >"test2"]}</span></code>, than example message will look as follows:</p> <div class="highlight-json notranslate"><div class=highlight ><pre><span></span><span class=p >{</span>
<span class=w > </span><span class=nt >"filename"</span><span class=p >:</span><span class=w > </span><span class=s2 >"dataset_name_data_000001.h5"</span><span class=p >,</span>
<span class=w > </span><span class=nt >"nimages"</span><span class=p >:</span><span class=w > </span><span class=mi >1000</span><span class=p >,</span>
<span class=w > </span><span class=nt >"file_number"</span><span class=p >:</span><span class=w > </span><span class=mi >0</span><span class=p >,</span>
<span class=w > </span><span class=nt >"sample_name"</span><span class=p >:</span><span class=w > </span><span class=s2 >"lysozyme"</span><span class=p >,</span>
<span class=w > </span><span class=nt >"run_name"</span><span class=p >:</span><span class=w > </span><span class=s2 >"lyso_cryo"</span><span class=p >,</span>
<span class=w > </span><span class=nt >"run_number"</span><span class=p >:</span><span class=w > </span><span class=mi >25</span><span class=p >,</span>
<span class=w > </span><span class=nt >"experiment_group"</span><span class=p >:</span><span class=w > </span><span class=s2 >"p00001"</span><span class=p >,</span>
<span class=w > </span><span class=nt >"beam_x_pxl"</span><span class=p >:</span><span class=w > </span><span class=mi >1200</span><span class=p >,</span>
<span class=w > </span><span class=nt >"beam_y_pxl"</span><span class=p >:</span><span class=w > </span><span class=mi >1500</span><span class=p >,</span>
<span class=w > </span><span class=nt >"detector_distance_m"</span><span class=p >:</span><span class=w > </span><span class=mf >0.155</span><span class=p >,</span>
<span class=w > </span><span class=nt >"detector_height_pxl"</span><span class=p >:</span><span class=w > </span><span class=mi >2164</span><span class=p >,</span>
<span class=w > </span><span class=nt >"detector_width_pxl"</span><span class=p >:</span><span class=w > </span><span class=mi >2068</span><span class=p >,</span>
<span class=w > </span><span class=nt >"image_time_s"</span><span class=p >:</span><span class=w > </span><span class=mf >0.001</span><span class=p >,</span>
<span class=w > </span><span class=nt >"nimages"</span><span class=p >:</span><span class=w > </span><span class=mi >2</span><span class=p >,</span>
<span class=w > </span><span class=nt >"incident_energy_eV"</span><span class=p >:</span><span class=w > </span><span class=mf >12400.0</span><span class=p >,</span>
<span class=w > </span><span class=nt >"pixel_size_m"</span><span class=p >:</span><span class=w > </span><span class=mf >7.5e-05</span><span class=p >,</span>
<span class=w > </span><span class=nt >"saturation"</span><span class=p >:</span><span class=w > </span><span class=mi >32766</span><span class=p >,</span>
<span class=w > </span><span class=nt >"space_group_number"</span><span class=p >:</span><span class=w > </span><span class=mi >96</span><span class=p >,</span>
<span class=w > </span><span class=nt >"underload"</span><span class=p >:</span><span class=w > </span><span class=mi >-32768</span><span class=p >,</span>
<span class=w > </span><span class=nt >"unit_cell"</span><span class=p >:</span><span class=w > </span><span class=p >{</span>
<span class=w > </span><span class=nt >"a"</span><span class=p >:</span><span class=w > </span><span class=mf >78.0</span><span class=p >,</span>
<span class=w > </span><span class=nt >"alpha"</span><span class=p >:</span><span class=w > </span><span class=mf >90.0</span><span class=p >,</span>
<span class=w > </span><span class=nt >"b"</span><span class=p >:</span><span class=w > </span><span class=mf >78.0</span><span class=p >,</span>
<span class=w > </span><span class=nt >"beta"</span><span class=p >:</span><span class=w > </span><span class=mf >90.0</span><span class=p >,</span>
<span class=w > </span><span class=nt >"c"</span><span class=p >:</span><span class=w > </span><span class=mf >39.0</span><span class=p >,</span>
<span class=w > </span><span class=nt >"gamma"</span><span class=p >:</span><span class=w > </span><span class=mf >90.0</span>
<span class=w > </span><span class=p >},</span>
<span class=w > </span><span class=nt >"user_data"</span><span class=p >:</span><span class=w > </span><span class=p >{</span>
<span class=w > </span><span class=nt >"param1"</span><span class=p >:</span><span class=w > </span><span class=s2 >"test1"</span><span class=p >,</span><span class=w > </span>
<span class=w > </span><span class=nt >"param2"</span><span class=p >:</span><span class=w > </span><span class=p >[</span><span class=s2 >"test1"</span><span class=p >,</span><span class=w > </span><span class=s2 >"test2"</span><span class=p >]</span>
<span class=w > </span><span class=p >}</span>
<span class=p >}</span>
</pre></div> </div> <p>Notifications for finalized files are optional, if notification port number is omitted this functionality is not enabled.</p> </section> <section id=hdf5-file-structure > <h2 id=hdf5-file-structure >HDF5 file structure<a class=headerlink href="#hdf5-file-structure" title="Link to this heading"></a></h2> <p>Jungfraujoch aims to generate files compliant with NXmx format.</p> <section id=master-file > <h3 id=master-file >Master file<a class=headerlink href="#master-file" title="Link to this heading"></a></h3> <p>There are custom extension to NXmx format. These will be documented in the future.</p> <p>Specifically, if data collection was configured with <code class="docutils literal notranslate"><span class=pre >header_appendix</span></code> having key equal to <code class="docutils literal notranslate"><span class=pre >hdf5</span></code> and value as JSON object with number and string values. These will be added to <code class="docutils literal notranslate"><span class=pre >/entry/user</span></code>.</p> <p>There are three versions of master file possible.</p> <section id=legacy-version-nxmxlegacy > <h4 id=legacy-version-nxmxlegacy >Legacy version (NXmxLegacy)<a class=headerlink href="#legacy-version-nxmxlegacy" title="Link to this heading"></a></h4> <p>By default, <em>legacy version</em> is used. This version is compatible with DECTRIS file writer version 1.0 format. This ensures the file compatibility of Neggia and Durin XDS plugins, as well as DECTRIS Albula viewer version 4.0. Distinct feature is that if images are split into data files, there will be multiple links in <code class="docutils literal notranslate"><span class=pre >/entry/data</span></code>, each corresponding to a data file. Yet, certain new HDF5 features, like virtual datasets, are not possible in this format since it has to be compatible with HDF5 1.8 features.</p> </section> <section id=vds-format-nxmxvds > <h4 id=vds-format-nxmxvds >VDS format (NXmxVDS)<a class=headerlink href="#vds-format-nxmxvds" title="Link to this heading"></a></h4> <p>Therefore, we have enabled format <em>VDS version</em>. This will link to all data files via a single virtual dataset <code class="docutils literal notranslate"><span class=pre >/entry/data/data</span></code>. The same way spot finding, azimuthal integration and others, will be linked between master and data files. This format allows to display processing results in currently developed Jungfraujoch Viewer. For the time being it only works with Durin XDS plugin, and require DECTRIS Albula viewer version 4.1+.</p> </section> <section id=integrated-format-nxmxintegrated > <h4 id=integrated-format-nxmxintegrated >Integrated format (NXmxIntegrated)<a class=headerlink href="#integrated-format-nxmxintegrated" title="Link to this heading"></a></h4> <p>This is format, where no data files are created, but both images and metadata are stored in the same master file. This is generally equivalent to VDS format described above.</p> </section> </section> <section id=data-file > <h3 id=data-file >Data file<a class=headerlink href="#data-file" title="Link to this heading"></a></h3> <p>Data file has the following structure:</p> <table> <thead> <tr class=row-odd ><th class=head ><p>Location</p> <th class=head ><p>Description</p> <th class="head text-center"><p>Optional</p> <th class="head text-center"><p>Linked in master file v. 2</p> <tr class=row-even ><td><p>/entry/data/data</p> <td><p>Images</p> <td class=text-center ><p></p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/detector/timestamp</p> <td><p>Timestamp of the image</p> <td class=text-center ><p></p> <td class=text-center ><p></p> <tr class=row-even ><td><p>/entry/detector/exptime</p> <td><p>Exposure time of the image</p> <td class=text-center ><p></p> <td class=text-center ><p></p> <tr class=row-odd ><td><p>/entry/detector/number</p> <td><p>Image number; if image rejection was used this will be the original image number</p> <td class=text-center ><p></p> <td class=text-center ><p></p> <tr class=row-even ><td><p>/entry/detector/det_info</p> <td><p>Debug field of the JF detector</p> <td class=text-center ><p>X</p> <td class=text-center ><p></p> <tr class=row-odd ><td><p>/entry/detector/storage_cell_image</p> <td><p>Storage cell number</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X *</p> <tr class=row-even ><td><p>/entry/detector/rcv_delay</p> <td><p>Receiver delay for the image (Jungfraujoch debugging)</p> <td class=text-center ><p>X</p> <td class=text-center ><p></p> <tr class=row-odd ><td><p>/entry/detector/rcv_free_send_buffers</p> <td><p>Receiver number of free send buffers at the time of sending the image (Jungfraujoch debugging)</p> <td class=text-center ><p>X</p> <td class=text-center ><p></p> <tr class=row-even ><td><p>/entry/detector/data_collection_efficiency_image</p> <td><p>Ratio of received and expected UDP packets</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X *</p> <tr class=row-odd ><td><p>/entry/detector/packets_expected</p> <td><p>Number of UDP packets expected for the image</p> <td class=text-center ><p>X</p> <td class=text-center ><p></p> <tr class=row-even ><td><p>/entry/detector/packets_received</p> <td><p>Number of UDP packets received for the image</p> <td class=text-center ><p>X</p> <td class=text-center ><p></p> <tr class=row-odd ><td><p>/entry/image/max_value</p> <td><p>Max viable value of the image (excl. overloads, etc.)</p> <td class=text-center ><p>X</p> <td class=text-center ><p></p> <tr class=row-even ><td><p>/entry/azint/bin_to_q</p> <td><p>Azimuthal integration - bin-to-Q mapping</p> <td class=text-center ><p>X</p> <td class=text-center ><p></p> <tr class=row-odd ><td><p>/entry/azint/image</p> <td><p>Azimuthal integration - per image</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/peakXPosRaw</p> <td><p>Peak position X (see <a class="reference external" href="https://raw.githubusercontent.com/cxidb/CXI/master/cxi_file_format.pdf">CXI format</a>)</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/peakYPosRaw</p> <td><p>Peak position Y (see <a class="reference external" href="https://raw.githubusercontent.com/cxidb/CXI/master/cxi_file_format.pdf">CXI format</a>)</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/peakTotalIntensity</p> <td><p>Peak total intensity (see <a class="reference external" href="https://raw.githubusercontent.com/cxidb/CXI/master/cxi_file_format.pdf">CXI format</a>)</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/peakH</p> <td><p>Miller index h for each detected (indexed) peak</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/peakK</p> <td><p>Miller index k for each detected (indexed) peak</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/peakL</p> <td><p>Miller index l for each detected (indexed) peak</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/peakDistEwaldSphere</p> <td><p>Distance of the peak from the Ewald sphere (prediction)</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/nPeaks</p> <td><p>Number of peaks per image (see <a class="reference external" href="https://raw.githubusercontent.com/cxidb/CXI/master/cxi_file_format.pdf">CXI format</a>)</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/strongPixels</p> <td><p>Number of strong pixel per image</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/nPeaksRingFiltered</p> <td><p>Number of peaks not belonging to rings</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/imageIndexed</p> <td><p>Image is successfully indexed</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/profileRadius</p> <td><p>Crystal profile radius for indexed images</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/latticeIndexed</p> <td><p>Crystal lattice for the image, assuming it is indexed</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/bkgEstimate</p> <td><p>Mean value of pixels in the radius of 3-5 A</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/resolutionEstimate</p> <td><p>Resolution estimate based on on-the-fly integration</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/beam_corr_x</p> <td><p>Beam center correction applied during processing (X) [pixel]</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/beam_corr_y</p> <td><p>Beam center correction applied during processing (Y) [pixel]</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/MX/niggli_class</p> <td><p>Niggli class identifier of the indexed Bravais lattice (per image) - see <a class="reference external" href="https://onlinelibrary.wiley.com/iucr/itc/Ac/ch3o1v0001/table3o1o3o1.pdf">International Tables for Crystallography A (2016). Vol. A, Table 3.1.3.1</a></p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/MX/bravais_lattice</p> <td><p>Bravais lattice short code (per image), e.g., aP, mC, oF, tI, hP, hR, cF</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/roi/{roi_name}/max</p> <td><p>Max pixel value for roi named {roi_name}</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/roi/{roi_name}/sum</p> <td><p>Sum pixel value for roi named {roi_name}</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/roi/{roi_name}/sum_sq</p> <td><p>Sum pixel values squared for roi named {roi_name}</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/roi/{roi_name}/npixel</p> <td><p>Number of valid pixel for roi named {roi_name}</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/roi/{roi_name}/x</p> <td><p>Weighted X-coordinate for roi named {roi_name}</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/roi/{roi_name}/y</p> <td><p>Weighted Y-coordinate for roi named {roi_name}</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-odd ><td><p>/entry/xfel/pulseID</p> <td><p>Pulse ID (for XFEL only)</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> <tr class=row-even ><td><p>/entry/xfel/eventCode</p> <td><p>Event code (for XFEL only)</p> <td class=text-center ><p>X</p> <td class=text-center ><p>X</p> </table> <p>* - Datasets from <code class="docutils literal notranslate"><span class=pre >/entry/detector</span></code> in data file are mapped to <code class="docutils literal notranslate"><span class=pre >/entry/instrument/detector/detectorSpecific</span></code> in master file.</p> <p>If spot finding is enabled, spots are written in the <a class="reference external" href="https://raw.githubusercontent.com/cxidb/CXI/master/cxi_file_format.pdf">CXI format</a> and are recognized by CrystFEL. The following has to be added to the CrystFEL geometry file:</p> <div class="highlight-default notranslate"><div class=highlight ><pre><span></span><span class=n >peak_list</span> <span class=o >=</span> <span class=o >/</span><span class=n >opt</span><span class=o >/</span><span class=n >MX</span>
<span class=n >peak_list_type</span> <span class=o >=</span> <span class=n >cxi</span>
</pre></div> </div> </section> </section> <section id=other-formats-cbf-and-tiff > <h2 id=other-formats-cbf-and-tiff >Other formats (CBF and TIFF)<a class=headerlink href="#other-formats-cbf-and-tiff" title="Link to this heading"></a></h2> <p>In addition to HDF5 format, Jungfraujoch allows to save images in the Crystallographic Binary File (CBF) format. CBF files are written according to miniCBF format, with only basic header, and always with 32-bit signed integer format. Dynamic range is reduced to max 2^24, negative numbers are zeroed, and masked, and/or bad pixels are set to -1.</p> <p>Also writing to TIFF files is possible, though no metadata are saved in this case.</p> </section> <section id=no-file-option-s > <h2 id=no-file-option-s >No file option(s)<a class=headerlink href="#no-file-option-s" title="Link to this heading"></a></h2> <p>There are two options to disable writing of files by the writer:</p> <ul class=simple > <li><p>Setting <code class="docutils literal notranslate"><span class=pre >file_prefix</span></code> to empty string - this will disable sending files on ZeroMQ image socket.</p> <li><p>Setting file format to <code class="docutils literal notranslate"><span class=pre >NoFile</span></code> - files are streamed over ZeroMQ socket, but <code class="docutils literal notranslate"><span class=pre >jfjoch_writer</span></code> will not write anything. This can be useful for debugging purposes, or if you only rely on republishing functionality of the <code class="docutils literal notranslate"><span class=pre >jfjoch_writer</span></code></p> </ul> </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=JFJOCH_BROKER.html title=jfjoch_broker 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_broker </span> </div> </a> <a href=SOFTWARE_INTEGRATION.html title="Integration with MX data processing software" 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> Integration with MX data processing software </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