sardana-nxsrecorder 3.24.0__tar.gz → 3.26.0__tar.gz

{sardana-nxsrecorder-3.24.0 → sardana-nxsrecorder-3.26.0}/ChangeLog

@@ -1,3 +1,11 @@
+2024-06-19 Jan Kotanski <jankotan@gmail.com>
+	* replace NeXusSkipAcquisitionModes by NeXusWriterModes variable (#127)
+	* tagged as 3.26.0
+
+2024-06-07 Jan Kotanski <jankotan@gmail.com>
+	* set NeXusMeshScanID variable (#124)
+	* tagged as 3.25.0
+
 2024-06-06 Jan Kotanski <jankotan@gmail.com>
 	* set TangoDataWriter properties from NeXusWriterProperties variable (#121)
 	* tagged as 3.24.0

{sardana-nxsrecorder-3.24.0/sardana_nxsrecorder.egg-info → sardana-nxsrecorder-3.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.24.0
+Version: 3.26.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski
@@ -249,6 +249,7 @@ The NeXus file recorder uses the following sardana environment variables
 * **MetadataScript** *(str)* - a python module file name containing ``main()``  which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
 * **ScicatMeasurements** *(dict)* - a dictionary of  measurement names indexed by ``ScanDir`` and  used by ``scingestor``, default: ``{}``
 * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
-* **NeXusSkipAcquisitionModes** *(list)* - a list of strategy modes for which acquisition is skip
 * **NeXusWriterProperties** *(dict)* - a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)
+* **NeXusMeshScanID** *(int)* - ScanID used for composed scans e.g. mesh scan combined from many linear scans
+* **NeXusWriterModes** *(list)* - a list of strategy modes e.g. ``NOINIT``, ``NOSTEP``, ``NOFINAL``, ``MESH``, ``VDS``  separated by commas
   

{sardana-nxsrecorder-3.24.0 → sardana-nxsrecorder-3.26.0}/README.rst

@@ -224,6 +224,7 @@ The NeXus file recorder uses the following sardana environment variables
 * **MetadataScript** *(str)* - a python module file name containing ``main()``  which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
 * **ScicatMeasurements** *(dict)* - a dictionary of  measurement names indexed by ``ScanDir`` and  used by ``scingestor``, default: ``{}``
 * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
-* **NeXusSkipAcquisitionModes** *(list)* - a list of strategy modes for which acquisition is skip
 * **NeXusWriterProperties** *(dict)* - a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)
+* **NeXusMeshScanID** *(int)* - ScanID used for composed scans e.g. mesh scan combined from many linear scans
+* **NeXusWriterModes** *(list)* - a list of strategy modes e.g. ``NOINIT``, ``NOSTEP``, ``NOFINAL``, ``MESH``, ``VDS``  separated by commas
   

{sardana-nxsrecorder-3.24.0 → sardana-nxsrecorder-3.26.0}/man/sardananxsrecorder.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "SARDANANXSRECORDER" "1" "Jun 04, 2024" "3.23" "Sardana NeXus Recorder"
+.TH "SARDANANXSRECORDER" "1" "Jun 11, 2024" "3.26" "Sardana NeXus Recorder"
 .SH NAME
 sardananxsrecorder \- sardananxsrecorder Documentation
 .sp
@@ -354,7 +354,11 @@ The NeXus file recorder uses the following sardana environment variables
 .IP \(bu 2
 \fBCreateMeasurementFile\fP \fI(bool)\fP \- create a measurement file with its filename releated to \fBScicatMeasurements\fP or \fBScanFile\fP, default: \fBFalse\fP
 .IP \(bu 2
-\fBNeXusSkipAcquisitionModes\fP \fI(list)\fP \- a list of strategy modes for which acquisition is skip
+\fBNeXusWriterProperties\fP \fI(dict)\fP \- a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)
+.IP \(bu 2
+\fBNeXusMeshScanID\fP \fI(int)\fP \- ScanID used for composed scans e.g. mesh scan combined from many linear scans
+.IP \(bu 2
+\fBNeXusWriterModes\fP \fI(list)\fP \- a list of strategy modes e.g. \fBNOINIT\fP, \fBNOSTEP\fP, \fBNOFINAL\fP, \fBMESH\fP, \fBVDS\fP  separated by commas
 .UNINDENT
 .sp
 Contents:

{sardana-nxsrecorder-3.24.0 → sardana-nxsrecorder-3.26.0/sardana_nxsrecorder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.24.0
+Version: 3.26.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski
@@ -249,6 +249,7 @@ The NeXus file recorder uses the following sardana environment variables
 * **MetadataScript** *(str)* - a python module file name containing ``main()``  which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
 * **ScicatMeasurements** *(dict)* - a dictionary of  measurement names indexed by ``ScanDir`` and  used by ``scingestor``, default: ``{}``
 * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
-* **NeXusSkipAcquisitionModes** *(list)* - a list of strategy modes for which acquisition is skip
 * **NeXusWriterProperties** *(dict)* - a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)
+* **NeXusMeshScanID** *(int)* - ScanID used for composed scans e.g. mesh scan combined from many linear scans
+* **NeXusWriterModes** *(list)* - a list of strategy modes e.g. ``NOINIT``, ``NOSTEP``, ``NOFINAL``, ``MESH``, ``VDS``  separated by commas
   

{sardana-nxsrecorder-3.24.0 → sardana-nxsrecorder-3.26.0}/sardananxsrecorder/__init__.py

@@ -20,4 +20,4 @@
 """ Sardana Scan Recorders """
 
 #: package version
-__version__ = "3.24.0"
+__version__ = "3.26.0"

{sardana-nxsrecorder-3.24.0 → sardana-nxsrecorder-3.26.0}/sardananxsrecorder/nxsrecorder.py

@@ -152,11 +152,15 @@ class NXS_FileRecorder(BaseFileRecorder):
         #: (:obj:`str`) module lable
         self.__moduleLabel = 'module'
 
+        #: (:obj:`int`) serialno
+        self.__serial = 0
+
         #: (:obj:`dict` <:obj:`str` , :obj:`str`>) NeXus configuration
         self.__conf = {}
 
-        #: (:obj:`list` <:obj:`str`>) skip Acquisition Modes
-        self.skipAcquisitionModes = []
+        #: (:obj:`list` <:obj:`str`>) acquisition Modes
+        self.writerModes = self.__variableList(
+            "NeXusWriterModes")
 
         #: (:obj:`dict` <:obj:`str` , `any`>) User data
         self.__udata = None
@@ -172,6 +176,26 @@ class NXS_FileRecorder(BaseFileRecorder):
         self.__setFileName(
             self.__base_filename, not appendentry, scanID)
 
+    def _serial(self, scanID):
+        serial = None
+        if "NOINIT" in self.writerModes and \
+           "MESH" in self.writerModes:
+            if self.__macro:
+                serial = self.__macro().getEnv('NeXusMeshScanID', None)
+        if serial is None:
+            if scanID is None:
+                serial = self.recordlist.getEnvironValue('serialno')
+            elif scanID >= 0:
+                if isarver >= 304 or isarver == 0:
+                    serial = scanID
+                else:
+                    serial = scanID + 1
+        if "MESH" in self.writerModes and \
+           "NOINIT" not in self.writerModes:
+            if self.__macro:
+                self.__macro().setEnv('NeXusMeshScanID', serial)
+        return serial
+
     def __command(self, server, command, *args):
         """ execute tango server (or python object) command
 
@@ -378,27 +402,22 @@ class NXS_FileRecorder(BaseFileRecorder):
 
         subs = (len([None for _ in list(re.finditer('%', filename))]) == 1)
         # construct the filename, e.g. : /dir/subdir/etcdir/prefix_00123.nxs
-        if scanID is None:
-            serial = self.recordlist.getEnvironValue('serialno')
-        elif scanID >= 0:
-            if isarver >= 304 or isarver == 0:
-                serial = scanID
-            else:
-                serial = scanID + 1
+        self.__serial = self._serial(scanID)
 
         if subs:
             try:
                 #: output file name
-                self.filename = filename % serial
+                self.filename = filename % self.__serial
             except Exception:
                 subs = False
         if not self.__raw_filename:
-            self.__raw_filename = self.__rawfilename(serial)
+            self.__raw_filename = self.__rawfilename(self.__serial)
         self.debug('Raw Filename: %s' % str(self.__raw_filename))
         if not subs and self.__raw_filename and \
            "{ScanID" in self.__raw_filename:
             try:
-                self.filename = self.__raw_filename.format(ScanID=serial)
+                self.filename = self.__raw_filename.format(
+                    ScanID=self.__serial)
                 subs = True
             except Exception:
                 pass
@@ -409,10 +428,12 @@ class NXS_FileRecorder(BaseFileRecorder):
                    filename[-4].rpartition(".")[0] and \
                    filename[-4].rpartition(".")[2] in self.formats.keys():
                     tpl = filename[-4].rpartition(".")
-                    self.filename = "%s_%05d.%s.tmp" % (tpl[0], serial, tpl[2])
+                    self.filename = "%s_%05d.%s.tmp" % (
+                        tpl[0], self.__serial, tpl[2])
                 else:
                     tpl = filename.rpartition('.')
-                    self.filename = "%s_%05d.%s" % (tpl[0], serial, tpl[2])
+                    self.filename = "%s_%05d.%s" % (
+                        tpl[0], self.__serial, tpl[2])
             else:
                 self.filename = filename
 
@@ -990,9 +1011,11 @@ class NXS_FileRecorder(BaseFileRecorder):
             appendscanid = not self.__setFileName(
                 self.__base_filename, not appendentry)
             envRec = self.recordlist.getEnviron()
-            self.__vars["vars"]["serialno"] = ("_%05i" % envRec["serialno"]) \
+            self.__vars["vars"]["serialno"] = ("_%05i" % self.__serial) \
                 if appendscanid else ""
             self.__vars["vars"]["scan_id"] = envRec["serialno"]
+            self.__vars["vars"]["acq_modes"] = \
+                ",".join(self.writerModes or [])
             self.__vars["vars"]["scan_title"] = envRec["title"]
             if self.__macro:
                 if hasattr(self.__macro(), "integ_time"):
@@ -1014,7 +1037,7 @@ class NXS_FileRecorder(BaseFileRecorder):
             # self.debug('XML: %s' % str(cnfxml))
             self.__removeDynamicComponent()
 
-            self.__vars["data"]["serialno"] = envRec["serialno"]
+            self.__vars["data"]["serialno"] = self.__serial
             self.__vars["data"]["scan_title"] = envRec["title"]
             if self.__macro:
                 if hasattr(self.__macro(), "integ_time"):
@@ -1035,8 +1058,9 @@ class NXS_FileRecorder(BaseFileRecorder):
             # self.debug('START_DATA: %s' % str(envRec))
 
             self.__nexuswriter_device.jsonrecord = rec
-            self.skipAcquisitionModes = self.__skipAcquisitionModes()
-            if "INIT" in self.skipAcquisitionModes:
+            self.writerModes = self.__variableList(
+                "NeXusWriterModes")
+            if "NOINIT" in self.writerModes:
                 self.__nexuswriter_device.skipAcquisition = True
 
             self.__command(self.__nexuswriter_device, "openEntry")
@@ -1125,7 +1149,7 @@ class NXS_FileRecorder(BaseFileRecorder):
             rec = json.dumps(
                 envrecord, cls=NXS_FileRecorder.numpyEncoder)
             self.__nexuswriter_device.jsonrecord = rec
-            if "STEP" in self.skipAcquisitionModes:
+            if "NOSTEP" in self.writerModes:
                 self.__nexuswriter_device.skipAcquisition = True
 
             # self.debug('DATA: {"data":%s}' % json.dumps(
@@ -1195,7 +1219,7 @@ class NXS_FileRecorder(BaseFileRecorder):
             rec = json.dumps(
                 envrecord, cls=NXS_FileRecorder.numpyEncoder)
             self.__nexuswriter_device.jsonrecord = rec
-            if "FINAL" in self.skipAcquisitionModes:
+            if "NOFINAL" in self.writerModes:
                 self.__nexuswriter_device.skipAcquisition = True
             self.__command(self.__nexuswriter_device, "closeEntry")
             self.__command(self.__nexuswriter_device, "closeFile")
@@ -1243,18 +1267,18 @@ class NXS_FileRecorder(BaseFileRecorder):
         beamtimeid = self.beamtime_id(bmtfpath, bmtfprefix, bmtfext)
         return beamtimeid or "00000000"
 
-    def __skipAcquisitionModes(self):
-        """ find skip acquisition modes
+    def __variableList(self, variable='NeXusWriterModes'):
+        """ read variable list
         """
         try:
-            skip_acq = self.__macro().getEnv('NeXusSkipAcquisitionModes')
+            msvar = self.__macro().getEnv(variable)
         except Exception:
-            skip_acq = []
-        if isinstance(skip_acq, str):
-            skip_acq = re.split(r"[-;,.\s]\s*", skip_acq)
-        if skip_acq:
-            self.debug('Skip Acquisition Modes: %s' % str(skip_acq))
-        return skip_acq
+            msvar = []
+        if isinstance(msvar, str):
+            msvar = re.split(r"[-;,.\s]\s*", msvar)
+        if msvar:
+            self.debug('%s: %s' % (variable, str(msvar)))
+        return msvar
 
     def __rawfilename(self, serial):
         """ find scan name
@@ -1310,7 +1334,7 @@ class NXS_FileRecorder(BaseFileRecorder):
     def __appendSciCatDataset(self, hostname=None):
         """ append dataset to SciCat ingestion list """
 
-        sid = self.__vars["vars"]["scan_id"]
+        sid = self.__serial
         fdir, fname = os.path.split(self.filename)
         sname, fext = os.path.splitext(fname)
         beamtimeid = self.beamtimeid()
@@ -1342,10 +1366,10 @@ class NXS_FileRecorder(BaseFileRecorder):
         if appendentry is True and \
                 '%' not in self.__raw_filename and \
                 "{ScanID" not in self.__raw_filename:
-            sid = self.__vars["vars"]["scan_id"]
+            sid = self.__serial
             sname = "%s::/%s_%05i;%s_%05i" % (
                 scanname, entryname, sid, scanname, sid)
-        if "INIT" in self.skipAcquisitionModes:
+        if "NOINIT" in self.writerModes:
             sname = "%s:%s" % (sname, time.time())
 
         # auto grouping
@@ -1381,7 +1405,7 @@ class NXS_FileRecorder(BaseFileRecorder):
     def __createMeasurementFile(self):
         """ create measurement file """
 
-        sid = self.__vars["vars"]["scan_id"]
+        sid = self.__serial
         fdir, fname = os.path.split(self.filename)
         sname, fext = os.path.splitext(fname)
         # beamtimeid = self.beamtimeid()