mx/Jungfraujoch
2
1
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases 67 Wiki Activity

docs: stop advertising the removed CBF/TIFF writers

Browse Source 
The CBF/TIFF writer removal left two docs describing them as available
output: JFJOCH_WRITER.md's "Other formats" section and an aside in
HDF5.md. A user following them would issue a now-rejected request. State
that only NXmx HDF5 is written and that the CBF/TIFF enum values are
retained for wire back-compatibility but rejected.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
leonarski_f
2026-07-15 22:19:46 +02:00
co-authored by Claude Opus 4.8
parent d393ec814c
commit 8fea7f195a
2 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/HDF5.md
+1 -1
View File
@@ -8,7 +8,7 @@ extra entries do not exist in NXmx and are documented here so that the layout is
reusable.
This page documents the **file layout and the data fields**. The operational behaviour of the
writer (running, republishing, file finalisation, CBF/TIFF output) is described in
writer (running, republishing, file finalisation) is described in
[jfjoch_writer](JFJOCH_WRITER.md). The wire format that feeds the writer is described in
[CBOR messages](CBOR.md); fields below frequently correspond one-to-one to CBOR message fields, and
that document is a useful companion for their meaning.
docs/JFJOCH_WRITER.md
+4 -5
View File
@@ -153,11 +153,10 @@ If data collection was configured with a `header_appendix` containing a key `hdf
JSON object of numbers and strings, those entries are written to `/entry/user`.
## Other formats (CBF and TIFF)
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.
Also writing to TIFF files is possible, though no metadata are saved in this case.
Earlier versions could also write Crystallographic Binary File (CBF, miniCBF) and TIFF images. These
writers have been removed: Jungfraujoch now writes only NXmx HDF5. The `CBF` and `TIFF` values are
retained in the file-format enum for wire back-compatibility, but a request to write either format
is rejected.
## No file option(s)
There are two options to disable writing of files by the writer: