From 6ff76d6b5e67cb83acf2938969a2a7cc3a3206f2 Mon Sep 17 00:00:00 2001 From: Aaron Brewster Date: Thu, 18 Jan 2024 14:28:20 -0800 Subject: [PATCH] Use FIELDNAME_scaling_factor and FIELDNAME_offset This resolves ambiguity if there is more than one signal For NXmx specify data_scaling_factor and data_offset since the field data is named in the NXdata group --- applications/NXmx.nxdl.xml | 16 ++++++++-------- base_classes/NXdata.nxdl.xml | 28 +++++++++++++++++++++------- 2 files changed, 29 insertions(+), 15 deletions(-) diff --git a/applications/NXmx.nxdl.xml b/applications/NXmx.nxdl.xml index 335a9d733..78be8b2ee 100644 --- a/applications/NXmx.nxdl.xml +++ b/applications/NXmx.nxdl.xml @@ -143,13 +143,13 @@ - + An optional scaling factor to apply to the values in data. The elements in data are often stored as integers for efficiency reasons and need - further correction, generating floats. The two fields scaling_factor and offset - allow linear corrections using the following convention: + further correction, generating floats. The two fields data_scaling_factor and + data_offset allow linear corrections using the following convention: .. code-block:: @@ -160,9 +160,9 @@ Use these fields to specify gain and/or pedestal constants that need to be applied to the data to correct it to physical values. For example, if the detector gain is 10 counts per photon and a constant background of 400 needs to be subtracted - off the pixels, specify scaling_factor as 0.1 and offset as -400 to specifiy the - required conversion from raw counts to pedestal-corrected photons. It is implied - processing software will apply these corrections on-the-fly during processing. + off the pixels, specify data_scaling_factor as 0.1 and data_offset as -400 to + specifiy the required conversion from raw counts to pedestal-corrected photons. It + is implied processing software will apply these corrections on-the-fly during processing. The rank of these fields should either be a single value for the full dataset, a single per-pixel array applied to every image (rank (i, j) or (i, j, k)), @@ -170,11 +170,11 @@ (np, 1), (np, i, j) or (np, i, j, k)). - + An optional offset to apply to the values in data. - See :ref:`scaling_factor </NXmx/ENTRY/DATA/scaling_factor-field>` for more information. + See :ref:`data_scaling_factor </NXmx/ENTRY/DATA/data_scaling_factor-field>` for more information. diff --git a/base_classes/NXdata.nxdl.xml b/base_classes/NXdata.nxdl.xml index 970ee94be..c468a454c 100644 --- a/base_classes/NXdata.nxdl.xml +++ b/base_classes/NXdata.nxdl.xml @@ -398,13 +398,13 @@ - + - An optional scaling factor to apply to the values in data. + An optional scaling factor to apply to the values in FIELDNAME (usually the signal). The elements in data are often stored as integers for efficiency reasons and need - further correction, generating floats. The two fields scaling_factor and offset - allow linear corrections using the following convention: + further correction, generating floats. The two fields FIELDNAME_scaling_factor and + FIELDNAME_offset allow linear corrections using the following convention: .. code-block:: @@ -413,14 +413,28 @@ This formula will derive the value to plot, when necessary. - + - An optional offset to apply to the values in data. + An optional offset to apply to the values in FIELDNAME (usually the signal). - See :ref:`scaling_factor </NXdata/scaling_factor-field>` for more information. + See :ref:`FIELDNAME_scaling_factor </NXdata/FIELDNAME_scaling_factor-field>` for more information. + + + Due to scaling_factor being ambiguous in the case of multiple signals, use + FIELDNAME_scaling_factor instead + + + + + Due to offset being ambiguous in the case of multiple signals, use + FIELDNAME_offset instead + + + +