From ed15b532da502d58d7af6429224b6ba67ae24526 Mon Sep 17 00:00:00 2001
From: Mads Jakobsen <mads.jakobsen@xfel.eu>
Date: Thu, 18 Apr 2024 10:05:07 +0200
Subject: [PATCH] added documentation comments on the mask path string
---
xpcs/src/xpcs/xpcs.py | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/xpcs/src/xpcs/xpcs.py b/xpcs/src/xpcs/xpcs.py
index da7e463..c7ae062 100644
--- a/xpcs/src/xpcs/xpcs.py
+++ b/xpcs/src/xpcs/xpcs.py
@@ -2,7 +2,7 @@ import time
from pathlib import Path
import numpy as np
-from karabo.bound import NODE_ELEMENT, NDARRAY_ELEMENT, STRING_ELEMENT
+from karabo.bound import NODE_ELEMENT, NDARRAY_ELEMENT, STRING_ELEMENT, DOUBLE_ELEMENT
from fastXPCS.algos import TTCdata, do_sparse_train
from fastXPCS.fxpcs_sparse import sparsify, sparsify2
@@ -26,6 +26,14 @@ class Xpcs(BaseCorrectionAddon):
@staticmethod
def extend_device_schema(schema, prefix):
(
+ # TODO: how do the users want to input the q ranges for which XPCS should be computed?
+ # option 1: with a mask with unique values for each q range?
+ # option 2: with a list of q range intervals?
+ # option 3: with a list of q values that should then be interpolated into intervals?
+ # option 4: with a start and end q-value and number of bins?
+
+ # path no a npy file that contains a mask for what pixels to use for the XPCS.
+ # currently this may only be filled with 1's and 0's
STRING_ELEMENT(schema)
.key(f"{prefix}.mask_path")
.tags("managed")
--
GitLab