diff --git a/ChangeLog b/ChangeLog index 30cee35a..ef45b19c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2024-07-03 Jan Kotanski + * add --id-format to nxsfileinfo metadata (#669) + * tagged as v4.7.0 + 2024-07-03 Jan Kotanski * fix wrong parsing of summer time (#666) * tagged as v4.6.2 diff --git a/man/nxscollect.1 b/man/nxscollect.1 index dd2db816..3167af05 100644 --- a/man/nxscollect.1 +++ b/man/nxscollect.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 "NXSCOLLECT" "1" "Jul 02, 2024" "4.6" "NXSTools" +.TH "NXSCOLLECT" "1" "Jul 03, 2024" "4.7" "NXSTools" .SH NAME nxscollect \- upload external images into NeXus/HDF5 file .SH DESCRIPTION @@ -66,7 +66,7 @@ show this help message and exit .TP .BI \-c \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION deflate compression rate from 0 to 9 (default: 2) or -:opt1,opt2,... e.g. \-c 32008:0,2 for +:opt1,opt2,… e.g. \-c 32008:0,2 for bitshuffle with lz4 .TP .BI \-p \ PATH\fR,\fB \ \-\-path \ PATH @@ -75,18 +75,18 @@ nexus path for the output field, e.g. .TP .BI \-i \ INPUTFILES\fR,\fB \ \-\-input_files \ INPUTFILES input data files defined with a pattern or separated -by \(aq,\(aq e.g.\(aqscan_%05d.tif:0:100\(aq +by ‘,’ e.g.’scan_%05d.tif:0:100’ .TP .BI \-\-separator \ SEPARATOR -input data files separator (default: \(aq,\(aq) +input data files separator (default: ‘,’) .TP .BI \-\-dtype \ DATATYPE datatype of input data \- only for raw data, e.g. -\(aquint8\(aq +‘uint8’ .TP .BI \-\-shape \ SHAPE shape of input data \- only for raw data, e.g. -\(aq[4096,2048]\(aq +‘[4096,2048]’ .TP .B \-s\fP,\fB \-\-skip_missing skip missing files @@ -209,99 +209,99 @@ Options: show this help message and exit .TP .BI \-t \ DTYPE\fR,\fB \ \-\-dtype \ DTYPE -datatype of the VDS field, e.g. \(aquint8\(aq +datatype of the VDS field, e.g. ‘uint8’ .TP .BI \-s \ SHAPE\fR,\fB \ \-\-shape \ SHAPE -shape of the VDS field, e.g. \(aq[U,4096,2048]\(aq or -U,4096,2048 where U means span along the field\(aq +shape of the VDS field, e.g. ‘[U,4096,2048]’ or +U,4096,2048 where U means span along the field’ .TP .BI \-f \ FILLVALUE\fR,\fB \ \-\-fill\-value \ FILLVALUE fill value for the gaps, default is 0 .TP .BI \-e \ TARGETFIELDS\fR,\fB \ \-\-target\-fields \ TARGETFIELDS external fields with their NeXus file paths defined -with a pattern or separated by \(aq,\(aq -e.g.\(aqscan_123/lambda_%05d.nxs://entry/data/\fI\%data:0:3\fP\(aq +with a pattern or separated by ‘,’ +e.g.’scan_123/lambda_%05d.nxs://entry/data/\fI\%data:0:3\fP’ .TP .BI \-\-separator \ SEPARATOR -input data files separator (default: \(aq,\(aq) +input data files separator (default: ‘,’) .TP .BI \-p \ SHAPES\fR,\fB \ \-\-shapes \ SHAPES shapes in the VDS layout hyperslab for the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g.\(aq,,;,300,;,600,0\(aq where an empty coordinate +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g.’,,;,300,;,600,0’ where an empty coordinate means 0 .TP .BI \-o \ OFFSETS\fR,\fB \ \-\-offsets \ OFFSETS offsets in the VDS layout hyperslab for the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g.\(aq,,;,300,;,600,0\(aq where an empty coordinate +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g.’,,;,300,;,600,0’ where an empty coordinate means 0 .TP .BI \-b \ BLOCKS\fR,\fB \ \-\-blocks \ BLOCKS block sizes in the VDS layout hyperslab for the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g. \(aq,256,512;,256,512;,256,512\(aq where an +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g. ‘,256,512;,256,512;,256,512’ where an empty coordinate means 1 .TP .BI \-c \ COUNTS\fR,\fB \ \-\-counts \ COUNTS count numbers in the VDS layout hyperslabfor the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g. \(aq,1,1;,1,1;,1,1\(aq where an empty coordinate +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g. ‘,1,1;,1,1;,1,1’ where an empty coordinate means span along the layout .TP .BI \-d \ STRIDES\fR,\fB \ \-\-strides \ STRIDES stride sizes in the VDS layout hyperslabfor the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g. \(aq,,;,,;,,\(aq where an empty coordinate means +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g. ‘,,;,,;,,’ where an empty coordinate means 1 .TP .BI \-l \ SLICES\fR,\fB \ \-\-slices \ SLICES mapping slices in the VDS layoutfor the corresponding -target fields with coordinates sepatated by \(aq,\(aq and -different fields separated by \(aq;\(aq or spaces e.g. -\(aq:,0:50,: :,50:100,:\(aq where U means span along the +target fields with coordinates sepatated by ‘,’ and +different fields separated by ‘;’ or spaces e.g. +‘:,0:50,: :,50:100,:’ where U means span along the layout .TP .BI \-P \ TARGETSHAPES\fR,\fB \ \-\-target\-shapes \ TARGETSHAPES -field shapes with coordinates sepatated by \(aq,\(aq and -different fields separated by \(aq;\(aq, \(aq:\(aq or spaces -e.g.\(aq,,;,300,;,600,0\(aq +field shapes with coordinates sepatated by ‘,’ and +different fields separated by ‘;’, ‘:’ or spaces +e.g.’,,;,300,;,600,0’ .TP .BI \-O \ TARGETOFFSETS\fR,\fB \ \-\-target\-offsets \ TARGETOFFSETS offsets in the view hyperslab of target fieldswith -coordinates sepatated by \(aq,\(aq and different fields -separated by \(aq;\(aq, \(aq:\(aq or spaces e.g.\(aq,,;,300,;,600,0\(aq +coordinates sepatated by ‘,’ and different fields +separated by ‘;’, ‘:’ or spaces e.g.’,,;,300,;,600,0’ where an empty coordinate means 0 .TP .BI \-B \ TARGETBLOCKS\fR,\fB \ \-\-target\-blocks \ TARGETBLOCKS block sizes in the view hyperslab of target fields -with coordinates sepatated by \(aq,\(aq and different fields -separated by \(aq;\(aq, \(aq:\(aq or spaces e.g. -\(aq,256,512;,256,512;,256,512\(aq where an empty coordinate +with coordinates sepatated by ‘,’ and different fields +separated by ‘;’, ‘:’ or spaces e.g. +‘,256,512;,256,512;,256,512’ where an empty coordinate means 1 .TP .BI \-C \ TARGETCOUNTS\fR,\fB \ \-\-target\-counts \ TARGETCOUNTS count numbers in the view hyperslab of target fields -with coordinates sepatated by \(aq,\(aq and different fields -separated by \(aq;\(aq, \(aq:\(aq or spaces e.g. \(aq,1,1;,1,1;,1,1\(aq +with coordinates sepatated by ‘,’ and different fields +separated by ‘;’, ‘:’ or spaces e.g. ‘,1,1;,1,1;,1,1’ where an empty coordinate means span along the layout .TP .BI \-D \ TARGETSTRIDES\fR,\fB \ \-\-target\-strides \ TARGETSTRIDES stride sizes numbers in the view hyperslab of target -fields with coordinates sepatated by \(aq,\(aq and different -fields separated by \(aq;\(aq, \(aq:\(aq or spaces e.g. \(aq,,;,,;,,\(aq +fields with coordinates sepatated by ‘,’ and different +fields separated by ‘;’, ‘:’ or spaces e.g. ‘,,;,,;,,’ where an empty coordinate means 1 .TP .BI \-L \ TARGETSLICES\fR,\fB \ \-\-target\-slices \ TARGETSLICES view slices of target fields with coordinates -sepatated by \(aq,\(aq and different fields separated by \(aq;\(aq -or spaces e.g. \(aq:,0:50,: :,0:50,:\(aq where U means span +sepatated by ‘,’ and different fields separated by ‘;’ +or spaces e.g. ‘:,0:50,: :,0:50,:’ where U means span along the layout .TP .B \-r\fP,\fB \-\-replace\-nexus\-file diff --git a/man/nxsconfig.1 b/man/nxsconfig.1 index 6935e7f6..d0d9881a 100644 --- a/man/nxsconfig.1 +++ b/man/nxsconfig.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 "NXSCONFIG" "1" "Jul 02, 2024" "4.6" "NXSTools" +.TH "NXSCONFIG" "1" "Jul 03, 2024" "4.7" "NXSTools" .SH NAME nxsconfig \- read NeXus Configuration Server settings .SH DESCRIPTION @@ -62,43 +62,43 @@ list names of available datasources .B list \-r [\-s ] [\-n] list names of available profiles .TP -.B show [\-s ] [\-m] [\-o ] component_name1 component_name2 ... +.B show [\-s ] [\-m] [\-o ] component_name1 component_name2 … show components with given names .TP -.B show \-d [\-s ] [\-o ] dsource_name1 dsource_name2 ... +.B show \-d [\-s ] [\-o ] dsource_name1 dsource_name2 … show datasources with given names .TP -.B show \-r [\-s ] [\-o ] profile_name1 profile_name2 ... +.B show \-r [\-s ] [\-o ] profile_name1 profile_name2 … show profiles with given names .TP -.B upload [\-s ] [\-m] [\-i ] [\-f] component_name1 component_name2 ... +.B upload [\-s ] [\-m] [\-i ] [\-f] component_name1 component_name2 … load components from given files .TP -.B upload \-d [\-s ] [\-i ] [\-f] dsource_name1 dsource_name2 ... +.B upload \-d [\-s ] [\-i ] [\-f] dsource_name1 dsource_name2 … load datasources from given files .TP -.B upload \-r [\-s ] [\-i ] [\-f] profile_name1 profile_name2 ... +.B upload \-r [\-s ] [\-i ] [\-f] profile_name1 profile_name2 … load profiles from given files .TP -.B get [\-s ] [\-n] component_name1 component_name2 ... +.B get [\-s ] [\-n] component_name1 component_name2 … get merged configuration of components .TP -.B delete [\-s ] [\-f] component_name1 component_name2 ... +.B delete [\-s ] [\-f] component_name1 component_name2 … delete components with given names .TP -.B delete \-d [\-s ] [\-f] dsource_name1 dsource_name2 ... +.B delete \-d [\-s ] [\-f] dsource_name1 dsource_name2 … delete datasources with given names .TP -.B delete \-r [\-s ] [\-f] profile_name1 profile_name2 ... +.B delete \-r [\-s ] [\-f] profile_name1 profile_name2 … delete profiles with given names .TP -.B sources [\-s ] [\-m] [\-n] component_name1 component_name2 ... +.B sources [\-s ] [\-m] [\-n] component_name1 component_name2 … get a list of component datasources .TP -.B components [\-s ] [\-n] component_name1 component_name2 ... +.B components [\-s ] [\-n] component_name1 component_name2 … get a list of dependent components .TP -.B variables [\-s ] [\-m] [\-n] component_name1 component_name2 ... +.B variables [\-s ] [\-m] [\-n] component_name1 component_name2 … get a list of component variables .TP .B data [\-s ] json_data @@ -113,19 +113,19 @@ get a list of datasource record names .B servers [\-s ] [\-n] get lists of configuration servers from the current tango host .TP -.B describe [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 ... +.B describe [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 … show all parameters of given components .TP -.B describe|info \-d [\-s ] [\-n] dsource_name1 dsource_name2 ... +.B describe|info \-d [\-s ] [\-n] dsource_name1 dsource_name2 … show all parameters of given datasources .TP -.B info [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 ... +.B info [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 … show source parameters of given components .TP -.B info \-r [\-s ] [\-n] profile_name1 profile_name2 ... +.B info \-r [\-s ] [\-n] profile_name1 profile_name2 … show general parameters of given profiles .TP -.B geometry [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 ... +.B geometry [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 … show transformation parameters of given components .UNINDENT .TP @@ -145,7 +145,7 @@ perform operation on datasources make use mandatory components as well .TP .B \-p\fP,\fB \-\-private -make use private components, i.e. starting with \(aq__\(aq +make use private components, i.e. starting with ‘__’ .TP .B \-n\fP,\fB \-\-no\-newlines split result with space characters diff --git a/man/nxscreate.1 b/man/nxscreate.1 index 676e4b0a..27f715ef 100644 --- a/man/nxscreate.1 +++ b/man/nxscreate.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 "NXSCREATE" "1" "Jul 02, 2024" "4.6" "NXSTools" +.TH "NXSCREATE" "1" "Jul 03, 2024" "4.7" "NXSTools" .SH NAME nxscreate \- create NeXus Configuration component .SH DESCRIPTION @@ -66,7 +66,7 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .UNINDENT @@ -103,7 +103,7 @@ datasource prefix, i.e. counter (useful for avoiding duplicated datasource names store datasources in Configuration Server database .TP .B \-m\fP,\fB \-\-minimal_device -device name without first \(aq0\(aq +device name without first ‘0’ .TP .BI \-r \ SERVER\fR,\fB \ \-\-server\fB= SERVER configuration server device name @@ -143,11 +143,11 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 -default is \(aqexp_mot\(aq +default is ‘exp_mot’ .IP \(bu 2 default , are taken from .UNINDENT @@ -241,11 +241,11 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 -default is \(aqexp_mot\(aq +default is ‘exp_mot’ .IP \(bu 2 default , are taken from .UNINDENT @@ -279,7 +279,7 @@ tango host port store datasources in Configuration Server database .TP .B \-n\fP,\fB \-\-no\-group -don\(aqt create common group with a name of datasource +don’t create common group with a name of datasource prefix .TP .BI \-r \ SERVER\fR,\fB \ \-\-server\fB= SERVER @@ -321,7 +321,7 @@ with \-d : datasources are created on the local filesystem .IP \(bu 2 without \-b or \-d : run in the test mode .IP \(bu 2 -default is \(aq/online_dir/online.xml\(aq +default is ‘/online_dir/online.xml’ .IP \(bu 2 default is taken from Tango DB .UNINDENT @@ -399,7 +399,7 @@ with \-d : datasources are created on the local filesystem .IP \(bu 2 without \-b or \-d : run in the test mode .IP \(bu 2 -default is \(aqALL\(aq +default is ‘ALL’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 @@ -470,15 +470,15 @@ nxscreate onlinecp [options] inputFile .UNINDENT .INDENT 0.0 .IP \(bu 2 -without \(aq\-c \(aq: show a list of possible components +without ‘\-c ’: show a list of possible components .IP \(bu 2 with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 -default is \(aq/online_dir/online.xml\(aq +default is ‘/online_dir/online.xml’ .IP \(bu 2 default is taken from Tango DB .UNINDENT @@ -570,17 +570,17 @@ nxscreate stdcomp [options] [name1 value1 [name2 value2] ...] .UNINDENT .INDENT 0.0 .IP \(bu 2 -without \(aq\-t \(aq: show a list of possible component types +without ‘\-t ’: show a list of possible component types .IP \(bu 2 -with \(aq\-t and without \-c : show a list of component variables for the given component type +with ‘\-t and without \-c : show a list of component variables for the given component type .IP \(bu 2 with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 -[name1 value1 [name2 value2] ...] sequence defines component variable values +[name1 value1 [name2 value2] …] sequence defines component variable values .UNINDENT .INDENT 0.0 .TP @@ -661,7 +661,7 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 @@ -671,7 +671,7 @@ default is NX_FLOAT .IP \(bu 2 default is SCALAR .IP \(bu 2 -default is \(dq/$var.entryname#\(aqscan\(aq$var.serialno:NXentry/instrument/collection/\(dq +default is “/$var.entryname#’scan’$var.serialno:NXentry/instrument/collection/” .UNINDENT .INDENT 0.0 .TP @@ -727,7 +727,7 @@ configuration server device name chunk format, i.e. SCALAR, SPECTRUM, IMAGE .TP .B \-m\fP,\fB \-\-minimal_device -device name without first \(aq0\(aq +device name without first ‘0’ .UNINDENT .UNINDENT .SS Example @@ -811,18 +811,18 @@ sample environment name .BI \-k \ MEANINGS\fR,\fB \ \-\-links \ MEANINGS NXlog links of physical quantities to sensors separated by comman. Default: -\(aqtemperature,magnetic_field,electric_field,stress_field,pressure\(aq +‘temperature,magnetic_field,electric_field,stress_field,pressure’ .TP .BI \-v \ ENVIRONMENTS\fR,\fB \ \-\-environments \ ENVIRONMENTS NXenvironment links of physical quantities separated -by comman. Default: \(aqtemperature,magnetic_field\(aq +by comman. Default: ‘temperature,magnetic_field’ .TP .BI \-f \ FIRST\fR,\fB \ \-\-first \ FIRST first linked targets separated by comman .TP .BI \-z \ TRANSATTRS\fR,\fB \ \-\-transformation\-attributes \ TRANSATTRS -a JSON dictionary with transformation parameters i.e, \(dqtransformation_type\(dq, \(dqvector\(dq, \(dqdepends_on\(dq. Default: -{\(dqrotation_z\(dq:{\(dqtransformation_type\(dq:\(dqrotation\(dq,\(dqvector\(dq:[0,\-1,0]}} +a JSON dictionary with transformation parameters i.e, “transformation_type”, “vector”, “depends_on”. Default: +{“rotation_z”:{“transformation_type”:”rotation”,”vector”:[0,\-1,0]}} .TP .BI \-p \ XMLPACKAGE\fR,\fB \ \-\-xml\-package \ XMLPACKAGE xml template package @@ -900,7 +900,7 @@ nxscreate compare [\-h] [\-n] online_file [online_file] .UNINDENT .INDENT 0.0 .IP \(bu 2 -default: second is \(aq/online_dir/online.xml\(aq if only file is given +default: second is ‘/online_dir/online.xml’ if only file is given .UNINDENT .INDENT 0.0 .TP diff --git a/man/nxsdata.1 b/man/nxsdata.1 index a21c64f7..a4a1d644 100644 --- a/man/nxsdata.1 +++ b/man/nxsdata.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 "NXSDATA" "1" "Jul 02, 2024" "4.6" "NXSTools" +.TH "NXSDATA" "1" "Jul 03, 2024" "4.7" "NXSTools" .SH NAME nxsdata \- run NeXus Data Writer .SH DESCRIPTION diff --git a/man/nxsetup.1 b/man/nxsetup.1 index 2493a7f6..85d2b655 100644 --- a/man/nxsetup.1 +++ b/man/nxsetup.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 "NXSETUP" "1" "Jul 02, 2024" "4.6" "NXSTools" +.TH "NXSETUP" "1" "Jul 03, 2024" "4.7" "NXSTools" .SH NAME nxsetup \- set NeXDaTaS Tango Server environment up .SH DESCRIPTION diff --git a/man/nxsfileinfo.1 b/man/nxsfileinfo.1 index 690243fd..392ab317 100644 --- a/man/nxsfileinfo.1 +++ b/man/nxsfileinfo.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 "NXSFILEINFO" "1" "Jul 02, 2024" "4.6" "NXSTools" +.TH "NXSFILEINFO" "1" "Jul 03, 2024" "4.7" "NXSTools" .SH NAME nxsfileinfo \- show metadata of the NeXus file .SH DESCRIPTION @@ -112,7 +112,7 @@ show this help message and exit names of column to be shown (separated by commas without spaces). The possible names are: depends_on, dtype, full_path, nexus_path, nexus_type, shape, source, source_name, source_type, strategy, trans_type, trans_offset, trans_vector, units, value .TP .BI \-f \ FILTERS\fR,\fB \ \-\-filters\fB= FILTERS -full_path filters (separated by commas without spaces). Default: \(aq*\(aq. E.g. \(aq\fI:NXsample/\fP\(aq +full_path filters (separated by commas without spaces). Default: ‘*’. E.g. ‘\fI:NXsample/\fP’ .TP .BI \-v \ VALUES\fR,\fB \ \-\-values\fB= VALUES field names which value should be stored (separated by commas without spaces). Default: depends_on @@ -169,7 +169,7 @@ show this help message and exit names of field or group attributes to be show (separated by commas without spaces). The default takes all attributes .TP .BI \-n \ NATTRS\fR,\fB \ \-\-hidden\-attributes \ NATTRS -names of field or group attributes to be hidden (separated by commas without spaces). The default: \(aqnexdatas_source,nexdatas_strategy\(aq +names of field or group attributes to be hidden (separated by commas without spaces). The default: ‘nexdatas_source,nexdatas_strategy’ .TP .BI \-v \ VALUES\fR,\fB \ \-\-values \ VALUES field names of more dimensional datasets which value should be shown (separated by commas without spaces) @@ -185,13 +185,13 @@ access group names separated by commas. Default is {beamtimeid}\-clbt,{beamtimeId}\-dmgt,{beamline}dmgt .TP .BI \-g \ GROUP_POSTFIX\fR,\fB \ \-\-group\-postfix \ GROUP_POSTFIX -postfix to be added to NeXus group name. The default: \(aqParameters\(aq +postfix to be added to NeXus group name. The default: ‘Parameters’ .TP .BI \-t \ ENTRYCLASSES\fR,\fB \ \-\-entry\-classes \ ENTRYCLASSES -names of entry NX_class to be shown (separated by commas without spaces). If name is \(aq\(aq all groups are shown. The default: \(aqNXentry\(aq +names of entry NX_class to be shown (separated by commas without spaces). If name is ‘’ all groups are shown. The default: ‘NXentry’ .TP .BI \-e \ ENTRYNAMES\fR,\fB \ \-\-entry\-names \ ENTRYNAMES -names of entry groups to be shown (separated by commas without spaces). If name is \(aq\(aq all groups are shown. The default: \(aq\(aq +names of entry groups to be shown (separated by commas without spaces). If name is ‘’ all groups are shown. The default: ‘’ .TP .B \-m\fP,\fB \-\-raw\-metadata do not store NXentry as scientificMetadata @@ -203,7 +203,7 @@ add empty units for fields without units add 1d values to scientificMetadata .TP .BI \-\-max\-oned\-size \ MAXONEDSIZE -add min and max (or first and last) values of 1d records to scientificMetadata if its size excides \-\-max\-oned\-size value +add min and max (or first and last) values of 1d records to scientificMetadata if its size excides –max\-oned\-size value .TP .BI \-p \ PID\fR,\fB \ \-\-pid \ PID dataset pid @@ -219,7 +219,7 @@ generate pid with file name .TP .BI \-q \ TECHNIQUES\fR,\fB \ \-\-techniques \ TECHNIQUES names of techniques (separated by commas without -spaces).The default: \(aq\(aq +spaces).The default: ‘’ .TP .BI \-j \ SAMPLEID\fR,\fB \ \-\-sample\-id \ SAMPLEID sampleId @@ -255,16 +255,16 @@ or a text file list to re\-arrange metadata .BI \-\-copy\-map\-field \ COPYMAPFIELD field json or yaml with map {output: input} or [[output, input],] or a text file list to re\-arrange metadata. The default: -\(aqscientificMetadata.nxsfileinfo_parameters.copymap.value\(aq +‘scientificMetadata.nxsfileinfo_parameters.copymap.value’ .TP .B \-\-copy\-map\-error Raise an error when the copy map file does not exist .TP .BI \-\-copy\-map\-file \ COPYMAPFILE -json or yaml file containing the copy map, see also \-\-copy\-map +json or yaml file containing the copy map, see also –copy\-map .TP .BI \-f \ FILEFORMAT\fR,\fB \ \-\-file\-format \ FILEFORMAT -input file format, e.g. \(aqnxs\(aq. Default is defined by the file extension +input file format, e.g. ‘nxs’. Default is defined by the file extension .TP .B \-\-proposal\-as\-proposal Store the DESY proposal as the SciCat proposal @@ -328,13 +328,13 @@ access group names separated by commas. Default is .TP .BI \-s \ SKIP\fR,\fB \ \-\-skip \ SKIP filters for files to be skipped (separated by commas -without spaces). Default: \(aq\(aq. E.g. -\(aq\fI\&.pyc,\fP~\(aq +without spaces). Default: ‘’. E.g. +‘\fI\&.pyc,\fP~’ .TP .BI \-a \ ADD\fR,\fB \ \-\-add \ ADD list of files to be added (separated by commas -without spaces). Default: \(aq\(aq. E.g. -\(aqscan1.nxs,scan2.nxs\(aq +without spaces). Default: ‘’. E.g. +‘scan1.nxs,scan2.nxs’ .TP .BI \-r \ RELPATH\fR,\fB \ \-\-relative\-path \ RELPATH relative path to the scan files @@ -532,7 +532,7 @@ amtimeId}\-dmgt,{beamtimeid}\-clbt,{beamtimeId}\-part,{be amline}dmgt,{beamline}staff .TP .BI \-f \ FILEFORMAT\fR,\fB \ \-\-file\-format \ FILEFORMAT -input file format, e.g. \(aqnxs\(aq. Default is defined by +input file format, e.g. ‘nxs’. Default is defined by the file extension .TP .B \-\-h5py @@ -554,7 +554,7 @@ axis/axes data name(s) separated by comma a JSON dictionary with scan\-command axes to override, axis/axes data name(s) separated by comma for detectors and by semicolon for more plots. Default: -{\(dqhklscan\(dq:\(dqh;k;l\(dq,\(dqqscan\(dq:\(dqqz;qpar\(dq} +{“hklscan”:”h;k;l”,”qscan”:”qz;qpar”} .TP .BI \-m \ FRAME\fR,\fB \ \-\-frame \ FRAME a frame number for if more 2D images in the data @@ -576,7 +576,7 @@ add plot paramters to the caption .TP .BI \-n \ NEXUSPATH\fR,\fB \ \-\-nexus\-path \ NEXUSPATH base nexus path to element to be shown. -If th path is \(aq\(aq the default group is shown. The default: \(aq\(aq +If th path is ‘’ the default group is shown. The default: ‘’ .TP .BI \-o \ OUTPUT\fR,\fB \ \-\-output \ OUTPUT output scicat metadata file diff --git a/man/nxstools.1 b/man/nxstools.1 index 5c6876be..4a4bd23a 100644 --- a/man/nxstools.1 +++ b/man/nxstools.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 "NXSTOOLS" "1" "Jul 02, 2024" "4.6" "NXSTools" +.TH "NXSTOOLS" "1" "Jul 03, 2024" "4.7" "NXSTools" .SH NAME nxstools \- nxstools Documentation .sp @@ -240,7 +240,7 @@ show this help message and exit .TP .BI \-c \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION deflate compression rate from 0 to 9 (default: 2) or -:opt1,opt2,... e.g. \-c 32008:0,2 for +:opt1,opt2,… e.g. \-c 32008:0,2 for bitshuffle with lz4 .TP .BI \-p \ PATH\fR,\fB \ \-\-path \ PATH @@ -249,18 +249,18 @@ nexus path for the output field, e.g. .TP .BI \-i \ INPUTFILES\fR,\fB \ \-\-input_files \ INPUTFILES input data files defined with a pattern or separated -by \(aq,\(aq e.g.\(aqscan_%05d.tif:0:100\(aq +by ‘,’ e.g.’scan_%05d.tif:0:100’ .TP .BI \-\-separator \ SEPARATOR -input data files separator (default: \(aq,\(aq) +input data files separator (default: ‘,’) .TP .BI \-\-dtype \ DATATYPE datatype of input data \- only for raw data, e.g. -\(aquint8\(aq +‘uint8’ .TP .BI \-\-shape \ SHAPE shape of input data \- only for raw data, e.g. -\(aq[4096,2048]\(aq +‘[4096,2048]’ .TP .B \-s\fP,\fB \-\-skip_missing skip missing files @@ -383,99 +383,99 @@ Options: show this help message and exit .TP .BI \-t \ DTYPE\fR,\fB \ \-\-dtype \ DTYPE -datatype of the VDS field, e.g. \(aquint8\(aq +datatype of the VDS field, e.g. ‘uint8’ .TP .BI \-s \ SHAPE\fR,\fB \ \-\-shape \ SHAPE -shape of the VDS field, e.g. \(aq[U,4096,2048]\(aq or -U,4096,2048 where U means span along the field\(aq +shape of the VDS field, e.g. ‘[U,4096,2048]’ or +U,4096,2048 where U means span along the field’ .TP .BI \-f \ FILLVALUE\fR,\fB \ \-\-fill\-value \ FILLVALUE fill value for the gaps, default is 0 .TP .BI \-e \ TARGETFIELDS\fR,\fB \ \-\-target\-fields \ TARGETFIELDS external fields with their NeXus file paths defined -with a pattern or separated by \(aq,\(aq -e.g.\(aqscan_123/lambda_%05d.nxs://entry/data/\fI\%data:0:3\fP\(aq +with a pattern or separated by ‘,’ +e.g.’scan_123/lambda_%05d.nxs://entry/data/\fI\%data:0:3\fP’ .TP .BI \-\-separator \ SEPARATOR -input data files separator (default: \(aq,\(aq) +input data files separator (default: ‘,’) .TP .BI \-p \ SHAPES\fR,\fB \ \-\-shapes \ SHAPES shapes in the VDS layout hyperslab for the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g.\(aq,,;,300,;,600,0\(aq where an empty coordinate +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g.’,,;,300,;,600,0’ where an empty coordinate means 0 .TP .BI \-o \ OFFSETS\fR,\fB \ \-\-offsets \ OFFSETS offsets in the VDS layout hyperslab for the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g.\(aq,,;,300,;,600,0\(aq where an empty coordinate +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g.’,,;,300,;,600,0’ where an empty coordinate means 0 .TP .BI \-b \ BLOCKS\fR,\fB \ \-\-blocks \ BLOCKS block sizes in the VDS layout hyperslab for the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g. \(aq,256,512;,256,512;,256,512\(aq where an +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g. ‘,256,512;,256,512;,256,512’ where an empty coordinate means 1 .TP .BI \-c \ COUNTS\fR,\fB \ \-\-counts \ COUNTS count numbers in the VDS layout hyperslabfor the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g. \(aq,1,1;,1,1;,1,1\(aq where an empty coordinate +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g. ‘,1,1;,1,1;,1,1’ where an empty coordinate means span along the layout .TP .BI \-d \ STRIDES\fR,\fB \ \-\-strides \ STRIDES stride sizes in the VDS layout hyperslabfor the corresponding target fields with coordinates sepatated -by \(aq,\(aq and different fields separated by \(aq;\(aq, \(aq:\(aq or -spaces e.g. \(aq,,;,,;,,\(aq where an empty coordinate means +by ‘,’ and different fields separated by ‘;’, ‘:’ or +spaces e.g. ‘,,;,,;,,’ where an empty coordinate means 1 .TP .BI \-l \ SLICES\fR,\fB \ \-\-slices \ SLICES mapping slices in the VDS layoutfor the corresponding -target fields with coordinates sepatated by \(aq,\(aq and -different fields separated by \(aq;\(aq or spaces e.g. -\(aq:,0:50,: :,50:100,:\(aq where U means span along the +target fields with coordinates sepatated by ‘,’ and +different fields separated by ‘;’ or spaces e.g. +‘:,0:50,: :,50:100,:’ where U means span along the layout .TP .BI \-P \ TARGETSHAPES\fR,\fB \ \-\-target\-shapes \ TARGETSHAPES -field shapes with coordinates sepatated by \(aq,\(aq and -different fields separated by \(aq;\(aq, \(aq:\(aq or spaces -e.g.\(aq,,;,300,;,600,0\(aq +field shapes with coordinates sepatated by ‘,’ and +different fields separated by ‘;’, ‘:’ or spaces +e.g.’,,;,300,;,600,0’ .TP .BI \-O \ TARGETOFFSETS\fR,\fB \ \-\-target\-offsets \ TARGETOFFSETS offsets in the view hyperslab of target fieldswith -coordinates sepatated by \(aq,\(aq and different fields -separated by \(aq;\(aq, \(aq:\(aq or spaces e.g.\(aq,,;,300,;,600,0\(aq +coordinates sepatated by ‘,’ and different fields +separated by ‘;’, ‘:’ or spaces e.g.’,,;,300,;,600,0’ where an empty coordinate means 0 .TP .BI \-B \ TARGETBLOCKS\fR,\fB \ \-\-target\-blocks \ TARGETBLOCKS block sizes in the view hyperslab of target fields -with coordinates sepatated by \(aq,\(aq and different fields -separated by \(aq;\(aq, \(aq:\(aq or spaces e.g. -\(aq,256,512;,256,512;,256,512\(aq where an empty coordinate +with coordinates sepatated by ‘,’ and different fields +separated by ‘;’, ‘:’ or spaces e.g. +‘,256,512;,256,512;,256,512’ where an empty coordinate means 1 .TP .BI \-C \ TARGETCOUNTS\fR,\fB \ \-\-target\-counts \ TARGETCOUNTS count numbers in the view hyperslab of target fields -with coordinates sepatated by \(aq,\(aq and different fields -separated by \(aq;\(aq, \(aq:\(aq or spaces e.g. \(aq,1,1;,1,1;,1,1\(aq +with coordinates sepatated by ‘,’ and different fields +separated by ‘;’, ‘:’ or spaces e.g. ‘,1,1;,1,1;,1,1’ where an empty coordinate means span along the layout .TP .BI \-D \ TARGETSTRIDES\fR,\fB \ \-\-target\-strides \ TARGETSTRIDES stride sizes numbers in the view hyperslab of target -fields with coordinates sepatated by \(aq,\(aq and different -fields separated by \(aq;\(aq, \(aq:\(aq or spaces e.g. \(aq,,;,,;,,\(aq +fields with coordinates sepatated by ‘,’ and different +fields separated by ‘;’, ‘:’ or spaces e.g. ‘,,;,,;,,’ where an empty coordinate means 1 .TP .BI \-L \ TARGETSLICES\fR,\fB \ \-\-target\-slices \ TARGETSLICES view slices of target fields with coordinates -sepatated by \(aq,\(aq and different fields separated by \(aq;\(aq -or spaces e.g. \(aq:,0:50,: :,0:50,:\(aq where U means span +sepatated by ‘,’ and different fields separated by ‘;’ +or spaces e.g. ‘:,0:50,: :,0:50,:’ where U means span along the layout .TP .B \-r\fP,\fB \-\-replace\-nexus\-file @@ -550,43 +550,43 @@ list names of available datasources .B list \-r [\-s ] [\-n] list names of available profiles .TP -.B show [\-s ] [\-m] [\-o ] component_name1 component_name2 ... +.B show [\-s ] [\-m] [\-o ] component_name1 component_name2 … show components with given names .TP -.B show \-d [\-s ] [\-o ] dsource_name1 dsource_name2 ... +.B show \-d [\-s ] [\-o ] dsource_name1 dsource_name2 … show datasources with given names .TP -.B show \-r [\-s ] [\-o ] profile_name1 profile_name2 ... +.B show \-r [\-s ] [\-o ] profile_name1 profile_name2 … show profiles with given names .TP -.B upload [\-s ] [\-m] [\-i ] [\-f] component_name1 component_name2 ... +.B upload [\-s ] [\-m] [\-i ] [\-f] component_name1 component_name2 … load components from given files .TP -.B upload \-d [\-s ] [\-i ] [\-f] dsource_name1 dsource_name2 ... +.B upload \-d [\-s ] [\-i ] [\-f] dsource_name1 dsource_name2 … load datasources from given files .TP -.B upload \-r [\-s ] [\-i ] [\-f] profile_name1 profile_name2 ... +.B upload \-r [\-s ] [\-i ] [\-f] profile_name1 profile_name2 … load profiles from given files .TP -.B get [\-s ] [\-n] component_name1 component_name2 ... +.B get [\-s ] [\-n] component_name1 component_name2 … get merged configuration of components .TP -.B delete [\-s ] [\-f] component_name1 component_name2 ... +.B delete [\-s ] [\-f] component_name1 component_name2 … delete components with given names .TP -.B delete \-d [\-s ] [\-f] dsource_name1 dsource_name2 ... +.B delete \-d [\-s ] [\-f] dsource_name1 dsource_name2 … delete datasources with given names .TP -.B delete \-r [\-s ] [\-f] profile_name1 profile_name2 ... +.B delete \-r [\-s ] [\-f] profile_name1 profile_name2 … delete profiles with given names .TP -.B sources [\-s ] [\-m] [\-n] component_name1 component_name2 ... +.B sources [\-s ] [\-m] [\-n] component_name1 component_name2 … get a list of component datasources .TP -.B components [\-s ] [\-n] component_name1 component_name2 ... +.B components [\-s ] [\-n] component_name1 component_name2 … get a list of dependent components .TP -.B variables [\-s ] [\-m] [\-n] component_name1 component_name2 ... +.B variables [\-s ] [\-m] [\-n] component_name1 component_name2 … get a list of component variables .TP .B data [\-s ] json_data @@ -601,19 +601,19 @@ get a list of datasource record names .B servers [\-s ] [\-n] get lists of configuration servers from the current tango host .TP -.B describe [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 ... +.B describe [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 … show all parameters of given components .TP -.B describe|info \-d [\-s ] [\-n] dsource_name1 dsource_name2 ... +.B describe|info \-d [\-s ] [\-n] dsource_name1 dsource_name2 … show all parameters of given datasources .TP -.B info [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 ... +.B info [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 … show source parameters of given components .TP -.B info \-r [\-s ] [\-n] profile_name1 profile_name2 ... +.B info \-r [\-s ] [\-n] profile_name1 profile_name2 … show general parameters of given profiles .TP -.B geometry [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 ... +.B geometry [\-s ] [\-m | \-p] [\-n] component_name1 component_name2 … show transformation parameters of given components .UNINDENT .TP @@ -633,7 +633,7 @@ perform operation on datasources make use mandatory components as well .TP .B \-p\fP,\fB \-\-private -make use private components, i.e. starting with \(aq__\(aq +make use private components, i.e. starting with ‘__’ .TP .B \-n\fP,\fB \-\-no\-newlines split result with space characters @@ -692,7 +692,7 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .UNINDENT @@ -729,7 +729,7 @@ datasource prefix, i.e. counter (useful for avoiding duplicated datasource names store datasources in Configuration Server database .TP .B \-m\fP,\fB \-\-minimal_device -device name without first \(aq0\(aq +device name without first ‘0’ .TP .BI \-r \ SERVER\fR,\fB \ \-\-server\fB= SERVER configuration server device name @@ -769,11 +769,11 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 -default is \(aqexp_mot\(aq +default is ‘exp_mot’ .IP \(bu 2 default , are taken from .UNINDENT @@ -867,11 +867,11 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 -default is \(aqexp_mot\(aq +default is ‘exp_mot’ .IP \(bu 2 default , are taken from .UNINDENT @@ -905,7 +905,7 @@ tango host port store datasources in Configuration Server database .TP .B \-n\fP,\fB \-\-no\-group -don\(aqt create common group with a name of datasource +don’t create common group with a name of datasource prefix .TP .BI \-r \ SERVER\fR,\fB \ \-\-server\fB= SERVER @@ -947,7 +947,7 @@ with \-d : datasources are created on the local filesystem .IP \(bu 2 without \-b or \-d : run in the test mode .IP \(bu 2 -default is \(aq/online_dir/online.xml\(aq +default is ‘/online_dir/online.xml’ .IP \(bu 2 default is taken from Tango DB .UNINDENT @@ -1025,7 +1025,7 @@ with \-d : datasources are created on the local filesystem .IP \(bu 2 without \-b or \-d : run in the test mode .IP \(bu 2 -default is \(aqALL\(aq +default is ‘ALL’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 @@ -1096,15 +1096,15 @@ nxscreate onlinecp [options] inputFile .UNINDENT .INDENT 0.0 .IP \(bu 2 -without \(aq\-c \(aq: show a list of possible components +without ‘\-c ’: show a list of possible components .IP \(bu 2 with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 -default is \(aq/online_dir/online.xml\(aq +default is ‘/online_dir/online.xml’ .IP \(bu 2 default is taken from Tango DB .UNINDENT @@ -1196,17 +1196,17 @@ nxscreate stdcomp [options] [name1 value1 [name2 value2] ...] .UNINDENT .INDENT 0.0 .IP \(bu 2 -without \(aq\-t \(aq: show a list of possible component types +without ‘\-t ’: show a list of possible component types .IP \(bu 2 -with \(aq\-t and without \-c : show a list of component variables for the given component type +with ‘\-t and without \-c : show a list of component variables for the given component type .IP \(bu 2 with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 -[name1 value1 [name2 value2] ...] sequence defines component variable values +[name1 value1 [name2 value2] …] sequence defines component variable values .UNINDENT .INDENT 0.0 .TP @@ -1287,7 +1287,7 @@ with \-b: datasources are created in Configuration Server database .IP \(bu 2 without \-b: datasources are created on the local filesystem in \-d .IP \(bu 2 -default is \(aq.\(aq +default is ‘.’ .IP \(bu 2 default is taken from Tango DB .IP \(bu 2 @@ -1297,7 +1297,7 @@ default is NX_FLOAT .IP \(bu 2 default is SCALAR .IP \(bu 2 -default is \(dq/$var.entryname#\(aqscan\(aq$var.serialno:NXentry/instrument/collection/\(dq +default is “/$var.entryname#’scan’$var.serialno:NXentry/instrument/collection/” .UNINDENT .INDENT 0.0 .TP @@ -1353,7 +1353,7 @@ configuration server device name chunk format, i.e. SCALAR, SPECTRUM, IMAGE .TP .B \-m\fP,\fB \-\-minimal_device -device name without first \(aq0\(aq +device name without first ‘0’ .UNINDENT .UNINDENT .SS Example @@ -1437,18 +1437,18 @@ sample environment name .BI \-k \ MEANINGS\fR,\fB \ \-\-links \ MEANINGS NXlog links of physical quantities to sensors separated by comman. Default: -\(aqtemperature,magnetic_field,electric_field,stress_field,pressure\(aq +‘temperature,magnetic_field,electric_field,stress_field,pressure’ .TP .BI \-v \ ENVIRONMENTS\fR,\fB \ \-\-environments \ ENVIRONMENTS NXenvironment links of physical quantities separated -by comman. Default: \(aqtemperature,magnetic_field\(aq +by comman. Default: ‘temperature,magnetic_field’ .TP .BI \-f \ FIRST\fR,\fB \ \-\-first \ FIRST first linked targets separated by comman .TP .BI \-z \ TRANSATTRS\fR,\fB \ \-\-transformation\-attributes \ TRANSATTRS -a JSON dictionary with transformation parameters i.e, \(dqtransformation_type\(dq, \(dqvector\(dq, \(dqdepends_on\(dq. Default: -{\(dqrotation_z\(dq:{\(dqtransformation_type\(dq:\(dqrotation\(dq,\(dqvector\(dq:[0,\-1,0]}} +a JSON dictionary with transformation parameters i.e, “transformation_type”, “vector”, “depends_on”. Default: +{“rotation_z”:{“transformation_type”:”rotation”,”vector”:[0,\-1,0]}} .TP .BI \-p \ XMLPACKAGE\fR,\fB \ \-\-xml\-package \ XMLPACKAGE xml template package @@ -1526,7 +1526,7 @@ nxscreate compare [\-h] [\-n] online_file [online_file] .UNINDENT .INDENT 0.0 .IP \(bu 2 -default: second is \(aq/online_dir/online.xml\(aq if only file is given +default: second is ‘/online_dir/online.xml’ if only file is given .UNINDENT .INDENT 0.0 .TP @@ -1704,7 +1704,7 @@ show this help message and exit names of column to be shown (separated by commas without spaces). The possible names are: depends_on, dtype, full_path, nexus_path, nexus_type, shape, source, source_name, source_type, strategy, trans_type, trans_offset, trans_vector, units, value .TP .BI \-f \ FILTERS\fR,\fB \ \-\-filters\fB= FILTERS -full_path filters (separated by commas without spaces). Default: \(aq*\(aq. E.g. \(aq\fI:NXsample/\fP\(aq +full_path filters (separated by commas without spaces). Default: ‘*’. E.g. ‘\fI:NXsample/\fP’ .TP .BI \-v \ VALUES\fR,\fB \ \-\-values\fB= VALUES field names which value should be stored (separated by commas without spaces). Default: depends_on @@ -1761,7 +1761,7 @@ show this help message and exit names of field or group attributes to be show (separated by commas without spaces). The default takes all attributes .TP .BI \-n \ NATTRS\fR,\fB \ \-\-hidden\-attributes \ NATTRS -names of field or group attributes to be hidden (separated by commas without spaces). The default: \(aqnexdatas_source,nexdatas_strategy\(aq +names of field or group attributes to be hidden (separated by commas without spaces). The default: ‘nexdatas_source,nexdatas_strategy’ .TP .BI \-v \ VALUES\fR,\fB \ \-\-values \ VALUES field names of more dimensional datasets which value should be shown (separated by commas without spaces) @@ -1777,13 +1777,13 @@ access group names separated by commas. Default is {beamtimeid}\-clbt,{beamtimeId}\-dmgt,{beamline}dmgt .TP .BI \-g \ GROUP_POSTFIX\fR,\fB \ \-\-group\-postfix \ GROUP_POSTFIX -postfix to be added to NeXus group name. The default: \(aqParameters\(aq +postfix to be added to NeXus group name. The default: ‘Parameters’ .TP .BI \-t \ ENTRYCLASSES\fR,\fB \ \-\-entry\-classes \ ENTRYCLASSES -names of entry NX_class to be shown (separated by commas without spaces). If name is \(aq\(aq all groups are shown. The default: \(aqNXentry\(aq +names of entry NX_class to be shown (separated by commas without spaces). If name is ‘’ all groups are shown. The default: ‘NXentry’ .TP .BI \-e \ ENTRYNAMES\fR,\fB \ \-\-entry\-names \ ENTRYNAMES -names of entry groups to be shown (separated by commas without spaces). If name is \(aq\(aq all groups are shown. The default: \(aq\(aq +names of entry groups to be shown (separated by commas without spaces). If name is ‘’ all groups are shown. The default: ‘’ .TP .B \-m\fP,\fB \-\-raw\-metadata do not store NXentry as scientificMetadata @@ -1795,7 +1795,7 @@ add empty units for fields without units add 1d values to scientificMetadata .TP .BI \-\-max\-oned\-size \ MAXONEDSIZE -add min and max (or first and last) values of 1d records to scientificMetadata if its size excides \-\-max\-oned\-size value +add min and max (or first and last) values of 1d records to scientificMetadata if its size excides –max\-oned\-size value .TP .BI \-p \ PID\fR,\fB \ \-\-pid \ PID dataset pid @@ -1811,7 +1811,7 @@ generate pid with file name .TP .BI \-q \ TECHNIQUES\fR,\fB \ \-\-techniques \ TECHNIQUES names of techniques (separated by commas without -spaces).The default: \(aq\(aq +spaces).The default: ‘’ .TP .BI \-j \ SAMPLEID\fR,\fB \ \-\-sample\-id \ SAMPLEID sampleId @@ -1847,16 +1847,16 @@ or a text file list to re\-arrange metadata .BI \-\-copy\-map\-field \ COPYMAPFIELD field json or yaml with map {output: input} or [[output, input],] or a text file list to re\-arrange metadata. The default: -\(aqscientificMetadata.nxsfileinfo_parameters.copymap.value\(aq +‘scientificMetadata.nxsfileinfo_parameters.copymap.value’ .TP .B \-\-copy\-map\-error Raise an error when the copy map file does not exist .TP .BI \-\-copy\-map\-file \ COPYMAPFILE -json or yaml file containing the copy map, see also \-\-copy\-map +json or yaml file containing the copy map, see also –copy\-map .TP .BI \-f \ FILEFORMAT\fR,\fB \ \-\-file\-format \ FILEFORMAT -input file format, e.g. \(aqnxs\(aq. Default is defined by the file extension +input file format, e.g. ‘nxs’. Default is defined by the file extension .TP .B \-\-proposal\-as\-proposal Store the DESY proposal as the SciCat proposal @@ -1920,13 +1920,13 @@ access group names separated by commas. Default is .TP .BI \-s \ SKIP\fR,\fB \ \-\-skip \ SKIP filters for files to be skipped (separated by commas -without spaces). Default: \(aq\(aq. E.g. -\(aq\fI\&.pyc,\fP~\(aq +without spaces). Default: ‘’. E.g. +‘\fI\&.pyc,\fP~’ .TP .BI \-a \ ADD\fR,\fB \ \-\-add \ ADD list of files to be added (separated by commas -without spaces). Default: \(aq\(aq. E.g. -\(aqscan1.nxs,scan2.nxs\(aq +without spaces). Default: ‘’. E.g. +‘scan1.nxs,scan2.nxs’ .TP .BI \-r \ RELPATH\fR,\fB \ \-\-relative\-path \ RELPATH relative path to the scan files @@ -2124,7 +2124,7 @@ amtimeId}\-dmgt,{beamtimeid}\-clbt,{beamtimeId}\-part,{be amline}dmgt,{beamline}staff .TP .BI \-f \ FILEFORMAT\fR,\fB \ \-\-file\-format \ FILEFORMAT -input file format, e.g. \(aqnxs\(aq. Default is defined by +input file format, e.g. ‘nxs’. Default is defined by the file extension .TP .B \-\-h5py @@ -2146,7 +2146,7 @@ axis/axes data name(s) separated by comma a JSON dictionary with scan\-command axes to override, axis/axes data name(s) separated by comma for detectors and by semicolon for more plots. Default: -{\(dqhklscan\(dq:\(dqh;k;l\(dq,\(dqqscan\(dq:\(dqqz;qpar\(dq} +{“hklscan”:”h;k;l”,”qscan”:”qz;qpar”} .TP .BI \-m \ FRAME\fR,\fB \ \-\-frame \ FRAME a frame number for if more 2D images in the data @@ -2168,7 +2168,7 @@ add plot paramters to the caption .TP .BI \-n \ NEXUSPATH\fR,\fB \ \-\-nexus\-path \ NEXUSPATH base nexus path to element to be shown. -If th path is \(aq\(aq the default group is shown. The default: \(aq\(aq +If th path is ‘’ the default group is shown. The default: ‘’ .TP .BI \-o \ OUTPUT\fR,\fB \ \-\-output \ OUTPUT output scicat metadata file @@ -2579,11 +2579,11 @@ Generator class creating image file names. .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfname_template\fP (\fI\%str\fP) \-\- file name template +\fBfname_template\fP (\fI\%str\fP) – file name template .IP \(bu 2 -\fBstart_index\fP (\fI\%int\fP) \-\- file start index +\fBstart_index\fP (\fI\%int\fP) – file start index .IP \(bu 2 -\fBstop_index\fP (\fI\%int\fP) \-\- file stop index +\fBstop_index\fP (\fI\%int\fP) – file stop index .UNINDENT .UNINDENT .INDENT 7.0 @@ -2604,7 +2604,7 @@ from a sliced user input .INDENT 7.0 .TP .B Parameters -\fBfile_template\fP (\fI\%str\fP) \-\- file template +\fBfile_template\fP (\fI\%str\fP) – file template .TP .B Returns filename generator object @@ -2635,9 +2635,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- treee parent +\fBtparent\fP (\fI\%FTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -2691,7 +2691,7 @@ write attribute value .INDENT 7.0 .TP .B Parameters -\fBo\fP (\fI\%any\fP) \-\- python object +\fBo\fP (\fI\%any\fP) – python object .UNINDENT .UNINDENT .UNINDENT @@ -2708,9 +2708,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- treee parent +\fBtparent\fP (\fI\%FTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -2722,13 +2722,13 @@ create a new attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- attribute name +\fBname\fP (\fI\%str\fP) – attribute name .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBshape\fP (\fBlist\(ga< :obj:\(gaint\fP>) \-\- attribute shape +\fBshape\fP (\fBlist\(ga< :obj:\(gaint\fP>) – attribute shape .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .UNINDENT .TP .B Returns @@ -2770,9 +2770,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- treee parent +\fBtparent\fP (\fI\%FTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -2870,9 +2870,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- treee parent +\fBtparent\fP (\fI\%FTObject\fP) – treee parent .UNINDENT .UNINDENT .UNINDENT @@ -2889,9 +2889,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- treee parent +\fBtparent\fP (\fI\%FTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -2929,9 +2929,9 @@ grow the field .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdim\fP (\fI\%int\fP) \-\- growing dimension +\fBdim\fP (\fI\%int\fP) – growing dimension .IP \(bu 2 -\fBdim\fP \-\- size of the grow +\fBdim\fP – size of the grow .UNINDENT .UNINDENT .UNINDENT @@ -2999,7 +2999,7 @@ write the field value .INDENT 7.0 .TP .B Parameters -\fBo\fP (\fI\%any\fP) \-\- h5 object +\fBo\fP (\fI\%any\fP) – h5 object .UNINDENT .UNINDENT .UNINDENT @@ -3016,12 +3016,12 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 \fBwriter\fP (\fBPNIWriter\fP or \fBH5PYWriter\fP -or \fBH5CppWriter\fP) \-\- writer module +or \fBH5CppWriter\fP) – writer module .UNINDENT .UNINDENT .INDENT 7.0 @@ -3095,11 +3095,11 @@ reopen attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBswmr\fP (\fI\%bool\fP) \-\- swmr flag +\fBswmr\fP (\fI\%bool\fP) – swmr flag .IP \(bu 2 -\fBlibver\fP (\fI\%str\fP) \-\- library version, default: \(aqlatest\(aq +\fBlibver\fP (\fI\%str\fP) – library version, default: ‘latest’ .UNINDENT .UNINDENT .UNINDENT @@ -3130,9 +3130,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- treee parent +\fBtparent\fP (\fI\%FTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -3157,15 +3157,15 @@ open a file tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBn\fP (\fI\%str\fP) \-\- group name +\fBn\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBtype_code\fP (\fI\%str\fP) \-\- nexus field type +\fBtype_code\fP (\fI\%str\fP) – nexus field type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) \-\- chunk +\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) – chunk .IP \(bu 2 -\fBdfilter\fP (\fI\%FTDeflate\fP) \-\- filter deflater +\fBdfilter\fP (\fI\%FTDeflate\fP) – filter deflater .UNINDENT .TP .B Returns @@ -3184,9 +3184,9 @@ open a file tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBn\fP (\fI\%str\fP) \-\- group name +\fBn\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBnxclass\fP (\fI\%str\fP) \-\- group type +\fBnxclass\fP (\fI\%str\fP) – group type .UNINDENT .TP .B Returns @@ -3205,11 +3205,11 @@ creates a virtual filed tres element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- group name +\fBname\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBlayout\fP (\fBH5CppFieldLayout\fP) \-\- virual field layout +\fBlayout\fP (\fBH5CppFieldLayout\fP) – virual field layout .IP \(bu 2 -\fBfillvalue\fP (\fI\%int\fP or \fBnp.ndarray\fP) \-\- fill value +\fBfillvalue\fP (\fI\%int\fP or \fBnp.ndarray\fP) – fill value .UNINDENT .UNINDENT .UNINDENT @@ -3222,9 +3222,9 @@ field pointed by default attributes .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBaxes\fP \-\- axes names +\fBaxes\fP – axes names .IP \(bu 2 -\fBentryname\fP (\fI\%str\fP) \-\- base nexus path to be opened +\fBentryname\fP (\fI\%str\fP) – base nexus path to be opened .UNINDENT .TP .B Returns @@ -3241,7 +3241,7 @@ if child exists .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- child name +\fBname\fP (\fI\%str\fP) – child name .TP .B Returns existing flag @@ -3270,7 +3270,7 @@ open a file tree element .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -3286,7 +3286,7 @@ open a file tree element as link .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -3332,13 +3332,13 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoffset\fP (\fI\%tuple\fP <\fI\%int\fP>) \-\- a list of offsets +\fBoffset\fP (\fI\%tuple\fP <\fI\%int\fP>) – a list of offsets .IP \(bu 2 -\fBblock\fP (\fI\%tuple\fP <\fI\%int\fP>) \-\- a list of blocks +\fBblock\fP (\fI\%tuple\fP <\fI\%int\fP>) – a list of blocks .IP \(bu 2 -\fBcount\fP (\fI\%tuple\fP <\fI\%int\fP>) \-\- a list of counts +\fBcount\fP (\fI\%tuple\fP <\fI\%int\fP>) – a list of counts .IP \(bu 2 -\fBstride\fP (\fI\%tuple\fP <\fI\%int\fP>) \-\- a list of strides +\fBstride\fP (\fI\%tuple\fP <\fI\%int\fP>) – a list of strides .UNINDENT .UNINDENT .UNINDENT @@ -3355,9 +3355,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- treee parent +\fBtparent\fP (\fI\%FTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -3405,9 +3405,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fI\%FTObject\fP) \-\- tree parent +\fBtparent\fP (\fI\%FTObject\fP) – tree parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -3417,7 +3417,7 @@ append child weakref .INDENT 7.0 .TP .B Parameters -\fBtparent\fP (\fI\%FTObject\fP) \-\- tree parent +\fBtparent\fP (\fI\%FTObject\fP) – tree parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -3481,7 +3481,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .UNINDENT .UNINDENT .INDENT 0.0 @@ -3495,7 +3495,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .UNINDENT .INDENT 7.0 .TP @@ -3506,11 +3506,11 @@ add target field to layout .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBkey\fP (\fI\%tuple\fP) \-\- slide or selection +\fBkey\fP (\fI\%tuple\fP) – slide or selection .IP \(bu 2 -\fBsource\fP (\fI\%FTTargetFieldView\fP) \-\- target field +\fBsource\fP (\fI\%FTTargetFieldView\fP) – target field .IP \(bu 2 -\fBsourcekey\fP (\fI\%tuple\fP) \-\- slide or selection +\fBsourcekey\fP (\fI\%tuple\fP) – slide or selection .UNINDENT .UNINDENT .UNINDENT @@ -3524,11 +3524,11 @@ create a new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -3545,7 +3545,7 @@ create deflate filter .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fI\%FTObject\fP) \-\- parent object +\fBparent\fP (\fI\%FTObject\fP) – parent object .TP .B Returns deflate filter object @@ -3561,7 +3561,7 @@ create deflate filter .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fI\%FTObject\fP) \-\- parent object +\fBparent\fP (\fI\%FTObject\fP) – parent object .TP .B Returns deflate filter object @@ -3577,7 +3577,7 @@ get first element if the only .INDENT 7.0 .TP .B Parameters -\fBarray\fP (\fI\%any\fP) \-\- numpy array +\fBarray\fP (\fI\%any\fP) – numpy array .TP .B Returns first element of the array @@ -3590,7 +3590,7 @@ get links .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fI\%FTObject\fP) \-\- parent object +\fBparent\fP (\fI\%FTObject\fP) – parent object .TP .B Returns list of link objects @@ -3613,11 +3613,11 @@ create link .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtarget\fP (\fI\%str\fP) \-\- file name +\fBtarget\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBparent\fP (\fI\%FTObject\fP) \-\- parent object +\fBparent\fP (\fI\%FTObject\fP) – parent object .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- link name +\fBname\fP (\fI\%str\fP) – link name .UNINDENT .TP .B Returns @@ -3636,13 +3636,13 @@ load a file from memory byte buffer .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) \-\- memory buffer +\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) – memory buffer .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -3661,11 +3661,11 @@ open the new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -3682,7 +3682,7 @@ sets writer .INDENT 7.0 .TP .B Parameters -\fBwr\fP (\fBPNIWriter\fP or \fBH5PYWriter\fP or \fBH5CppWriter\fP) \-\- writer module +\fBwr\fP (\fBPNIWriter\fP or \fBH5PYWriter\fP or \fBH5CppWriter\fP) – writer module .UNINDENT .UNINDENT .INDENT 0.0 @@ -3694,17 +3694,17 @@ create target field view for VDS .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBfieldpath\fP (\fI\%str\fP) \-\- nexus field path +\fBfieldpath\fP (\fI\%str\fP) – nexus field path .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBparent\fP (\fI\%FTObject\fP) \-\- parent object +\fBparent\fP (\fI\%FTObject\fP) – parent object .UNINDENT .TP .B Returns @@ -3721,7 +3721,7 @@ return dataspace UNLIMITED variable for the current writer module .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fI\%FTObject\fP) \-\- parent object +\fBparent\fP (\fI\%FTObject\fP) – parent object .TP .B Returns dataspace UNLIMITED variable @@ -3739,13 +3739,13 @@ creates a virtual field layout for a VDS file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBparent\fP (\fI\%FTObject\fP) \-\- parent object +\fBparent\fP (\fI\%FTObject\fP) – parent object .UNINDENT .TP .B Returns @@ -3776,9 +3776,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -3860,7 +3860,7 @@ write attribute value .INDENT 7.0 .TP .B Parameters -\fBo\fP (\fI\%any\fP) \-\- python object +\fBo\fP (\fI\%any\fP) – python object .UNINDENT .UNINDENT .UNINDENT @@ -3877,9 +3877,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -3896,13 +3896,13 @@ create a new attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- attribute name +\fBname\fP (\fI\%str\fP) – attribute name .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- attribute shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – attribute shape .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .UNINDENT .TP .B Returns @@ -3967,9 +3967,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .UNINDENT @@ -3986,9 +3986,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .UNINDENT @@ -4005,9 +4005,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -4050,9 +4050,9 @@ grow the field .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdim\fP (\fI\%int\fP) \-\- growing dimension +\fBdim\fP (\fI\%int\fP) – growing dimension .IP \(bu 2 -\fBdim\fP \-\- size of the grow +\fBdim\fP – size of the grow .UNINDENT .UNINDENT .UNINDENT @@ -4143,7 +4143,7 @@ write the field value .INDENT 7.0 .TP .B Parameters -\fBo\fP (\fI\%any\fP) \-\- h5 object +\fBo\fP (\fI\%any\fP) – h5 object .UNINDENT .UNINDENT .UNINDENT @@ -4160,9 +4160,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .UNINDENT .UNINDENT .INDENT 7.0 @@ -4220,11 +4220,11 @@ reopen file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBswmr\fP (\fI\%bool\fP) \-\- swmr flag +\fBswmr\fP (\fI\%bool\fP) – swmr flag .IP \(bu 2 -\fBlibver\fP (\fI\%str\fP) \-\- library version, default: \(aqlatest\(aq +\fBlibver\fP (\fI\%str\fP) – library version, default: ‘latest’ .UNINDENT .UNINDENT .UNINDENT @@ -4255,9 +4255,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- tree parent +\fBtparent\fP (\fBFTObject\fP) – tree parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -4269,7 +4269,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBgroup\fP \-\- group object +\fBgroup\fP – group object .UNINDENT .INDENT 7.0 .TP @@ -4312,15 +4312,15 @@ open a file tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBn\fP (\fI\%str\fP) \-\- group name +\fBn\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBtype_code\fP (\fI\%str\fP) \-\- nexus field type +\fBtype_code\fP (\fI\%str\fP) – nexus field type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) \-\- chunk +\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) – chunk .IP \(bu 2 -\fBdfilter\fP (\fI\%H5CppDataFilter\fP) \-\- filter deflater +\fBdfilter\fP (\fI\%H5CppDataFilter\fP) – filter deflater .UNINDENT .TP .B Returns @@ -4339,9 +4339,9 @@ open a file tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBn\fP (\fI\%str\fP) \-\- group name +\fBn\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBnxclass\fP (\fI\%str\fP) \-\- group type +\fBnxclass\fP (\fI\%str\fP) – group type .UNINDENT .TP .B Returns @@ -4360,11 +4360,11 @@ creates a virtual filed tres element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- field name +\fBname\fP (\fI\%str\fP) – field name .IP \(bu 2 -\fBlayout\fP (\fBH5CppFieldLayout\fP) \-\- virual field layout +\fBlayout\fP (\fBH5CppFieldLayout\fP) – virual field layout .IP \(bu 2 -\fBfillvalue\fP (\fI\%int\fP or \fBnp.ndarray\fP) \-\- fill value +\fBfillvalue\fP (\fI\%int\fP or \fBnp.ndarray\fP) – fill value .UNINDENT .UNINDENT .UNINDENT @@ -4375,7 +4375,7 @@ if child exists .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- child name +\fBname\fP (\fI\%str\fP) – child name .TP .B Returns existing flag @@ -4422,7 +4422,7 @@ open a file tree element .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -4438,7 +4438,7 @@ open a file tree element as link .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -4484,9 +4484,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -4501,7 +4501,7 @@ provides a filename from h5 node .INDENT 7.0 .TP .B Parameters -\fBobj\fP (\fBFTObject\fP) \-\- h5 node +\fBobj\fP (\fBFTObject\fP) – h5 node .TP .B Returns file name @@ -4578,15 +4578,15 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBfieldpath\fP (\fI\%str\fP) \-\- nexus field path +\fBfieldpath\fP (\fI\%str\fP) – nexus field path .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .UNINDENT .INDENT 7.0 @@ -4623,13 +4623,13 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .UNINDENT .INDENT 7.0 @@ -4641,13 +4641,13 @@ add target field to layout .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBkey\fP (\fI\%tuple\fP) \-\- slide +\fBkey\fP (\fI\%tuple\fP) – slide .IP \(bu 2 -\fBsource\fP (\fBH5PYTargetFieldView\fP) \-\- target field view +\fBsource\fP (\fBH5PYTargetFieldView\fP) – target field view .IP \(bu 2 -\fBsourcekey\fP (\fI\%tuple\fP) \-\- slide or selection +\fBsourcekey\fP (\fI\%tuple\fP) – slide or selection .IP \(bu 2 -\fBshape\fP (\fI\%tuple\fP) \-\- target shape in the layout +\fBshape\fP (\fI\%tuple\fP) – target shape in the layout .UNINDENT .UNINDENT .UNINDENT @@ -4671,11 +4671,11 @@ create a new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .IP \(bu 2 -\fBlibver\fP (\fI\%str\fP) \-\- library version: \(aqlastest\(aq or \(aqearliest\(aq +\fBlibver\fP (\fI\%str\fP) – library version: ‘lastest’ or ‘earliest’ .UNINDENT .TP .B Returns @@ -4694,17 +4694,17 @@ create data filter .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilterid\fP (\fI\%int\fP) \-\- hdf5 filter id +\fBfilterid\fP (\fI\%int\fP) – hdf5 filter id .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- filter name +\fBname\fP (\fI\%str\fP) – filter name .IP \(bu 2 -\fBoptions\fP (\fI\%tuple\fP <\fI\%int\fP>) \-\- filter cd values +\fBoptions\fP (\fI\%tuple\fP <\fI\%int\fP>) – filter cd values .IP \(bu 2 -\fBavailability\fP (\fI\%str\fP) \-\- filter availability i.e. \(aqoptional\(aq or \(aqmandatory\(aq +\fBavailability\fP (\fI\%str\fP) – filter availability i.e. ‘optional’ or ‘mandatory’ .IP \(bu 2 -\fBshuffle\fP (\fI\%bool\fP) \-\- filter shuffle +\fBshuffle\fP (\fI\%bool\fP) – filter shuffle .IP \(bu 2 -\fBrate\fP (\fI\%bool\fP) \-\- filter shuffle +\fBrate\fP (\fI\%bool\fP) – filter shuffle .UNINDENT .TP .B Returns @@ -4723,9 +4723,9 @@ create data filter .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBrate\fP (\fI\%bool\fP) \-\- filter shuffle +\fBrate\fP (\fI\%bool\fP) – filter shuffle .IP \(bu 2 -\fBshuffle\fP (\fI\%bool\fP) \-\- filter shuffle +\fBshuffle\fP (\fI\%bool\fP) – filter shuffle .UNINDENT .TP .B Returns @@ -4742,7 +4742,7 @@ get links .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .TP .B Returns list of link objects @@ -4807,11 +4807,11 @@ create link .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtarget\fP (\fI\%str\fP) \-\- nexus path name +\fBtarget\fP (\fI\%str\fP) – nexus path name .IP \(bu 2 -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- link name +\fBname\fP (\fI\%str\fP) – link name .UNINDENT .TP .B Returns @@ -4830,13 +4830,13 @@ load a file from memory byte buffer .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) \-\- memory buffer +\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) – memory buffer .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -4853,7 +4853,7 @@ converts to numpy types .INDENT 7.0 .TP .B Parameters -\fBdtype\fP (\fI\%str\fP) \-\- h5 writer type type +\fBdtype\fP (\fI\%str\fP) – h5 writer type type .TP .B Returns nupy type @@ -4871,11 +4871,11 @@ open the new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBlibver\fP (\fI\%str\fP) \-\- library version: \(aqlastest\(aq or \(aqearliest\(aq +\fBlibver\fP (\fI\%str\fP) – library version: ‘lastest’ or ‘earliest’ .UNINDENT .TP .B Returns @@ -4894,15 +4894,15 @@ create target field view for VDS .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBfieldpath\fP (\fI\%str\fP) \-\- nexus field path +\fBfieldpath\fP (\fI\%str\fP) – nexus field path .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .TP .B Returns @@ -4919,7 +4919,7 @@ return dataspace UNLIMITED variable for the current writer module .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .TP .B Returns dataspace UNLIMITED variable @@ -4937,9 +4937,9 @@ checks if hyperslab is unlimited .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBsel\fP (\fBfilewriter.FTHyperslab\fP) \-\- hyperslab selection +\fBsel\fP (\fBfilewriter.FTHyperslab\fP) – hyperslab selection .IP \(bu 2 -\fBshape\fP (\fI\%list\fP) \-\- give shape +\fBshape\fP (\fI\%list\fP) – give shape .UNINDENT .TP .B Returns @@ -4958,11 +4958,11 @@ creates a virtual field layout for a VDS file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .TP .B Returns @@ -4988,9 +4988,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -5062,7 +5062,7 @@ write attribute value .INDENT 7.0 .TP .B Parameters -\fBo\fP (\fI\%any\fP) \-\- python object +\fBo\fP (\fI\%any\fP) – python object .UNINDENT .UNINDENT .UNINDENT @@ -5079,9 +5079,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -5093,7 +5093,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBmanager\fP (\fI\%H5PYAttributeManager\fP) \-\- attribute manager +\fBmanager\fP (\fI\%H5PYAttributeManager\fP) – attribute manager .UNINDENT .INDENT 7.0 .TP @@ -5123,13 +5123,13 @@ create a new attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- attribute name +\fBname\fP (\fI\%str\fP) – attribute name .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- attribute shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – attribute shape .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .UNINDENT .TP .B Returns @@ -5194,9 +5194,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .UNINDENT @@ -5211,9 +5211,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .UNINDENT @@ -5230,9 +5230,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -5275,9 +5275,9 @@ grow the field .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdim\fP (\fI\%int\fP) \-\- growing dimension +\fBdim\fP (\fI\%int\fP) – growing dimension .IP \(bu 2 -\fBdim\fP \-\- size of the grow +\fBdim\fP – size of the grow .UNINDENT .UNINDENT .UNINDENT @@ -5358,7 +5358,7 @@ write the field value .INDENT 7.0 .TP .B Parameters -\fBo\fP (\fI\%any\fP) \-\- h5 object +\fBo\fP (\fI\%any\fP) – h5 object .UNINDENT .UNINDENT .UNINDENT @@ -5375,9 +5375,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .UNINDENT .UNINDENT .INDENT 7.0 @@ -5443,11 +5443,11 @@ reopen file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBswmr\fP (\fI\%bool\fP) \-\- swmr flag +\fBswmr\fP (\fI\%bool\fP) – swmr flag .IP \(bu 2 -\fBlibver\fP (\fI\%str\fP) \-\- library version, default: \(aqlatest\(aq +\fBlibver\fP (\fI\%str\fP) – library version, default: ‘latest’ .UNINDENT .UNINDENT .UNINDENT @@ -5478,9 +5478,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -5492,7 +5492,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBgroup\fP \-\- group object +\fBgroup\fP – group object .UNINDENT .INDENT 7.0 .TP @@ -5535,15 +5535,15 @@ creates a field tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- group name +\fBname\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBtype_code\fP (\fI\%str\fP) \-\- nexus field type +\fBtype_code\fP (\fI\%str\fP) – nexus field type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) \-\- chunk +\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) – chunk .IP \(bu 2 -\fBdfilter\fP (\fI\%H5PYDataFilter\fP) \-\- filter deflater +\fBdfilter\fP (\fI\%H5PYDataFilter\fP) – filter deflater .UNINDENT .TP .B Returns @@ -5562,9 +5562,9 @@ open a file tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBn\fP (\fI\%str\fP) \-\- group name +\fBn\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBnxclass\fP (\fI\%str\fP) \-\- group type +\fBnxclass\fP (\fI\%str\fP) – group type .UNINDENT .TP .B Returns @@ -5583,11 +5583,11 @@ creates a virtual filed tres element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- group name +\fBname\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBlayout\fP (\fBH5PYFieldLayout\fP) \-\- virual field layout +\fBlayout\fP (\fBH5PYFieldLayout\fP) – virual field layout .IP \(bu 2 -\fBfillvalue\fP (\fI\%int\fP) \-\- fill value +\fBfillvalue\fP (\fI\%int\fP) – fill value .UNINDENT .UNINDENT .UNINDENT @@ -5598,7 +5598,7 @@ if child exists .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- child name +\fBname\fP (\fI\%str\fP) – child name .TP .B Returns existing flag @@ -5640,7 +5640,7 @@ open a file tree element .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -5656,7 +5656,7 @@ open a file tree element as link .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -5697,9 +5697,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .INDENT 7.0 @@ -5714,7 +5714,7 @@ provides a filename from h5 node .INDENT 7.0 .TP .B Parameters -\fBobj\fP (\fBFTObject\fP) \-\- h5 node +\fBobj\fP (\fBFTObject\fP) – h5 node .TP .B Returns file name @@ -5798,9 +5798,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .UNINDENT .INDENT 7.0 @@ -5822,9 +5822,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .UNINDENT .INDENT 7.0 @@ -5836,13 +5836,13 @@ add target field to layout .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBkey\fP (\fI\%tuple\fP) \-\- slide +\fBkey\fP (\fI\%tuple\fP) – slide .IP \(bu 2 -\fBsource\fP (\fI\%H5PYTargetFieldView\fP) \-\- target field view +\fBsource\fP (\fI\%H5PYTargetFieldView\fP) – target field view .IP \(bu 2 -\fBsourcekey\fP (\fI\%tuple\fP) \-\- slide or selection +\fBsourcekey\fP (\fI\%tuple\fP) – slide or selection .IP \(bu 2 -\fBshape\fP (\fI\%tuple\fP) \-\- target shape in the layout +\fBshape\fP (\fI\%tuple\fP) – target shape in the layout .UNINDENT .UNINDENT .UNINDENT @@ -5861,11 +5861,11 @@ create a new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -5884,17 +5884,17 @@ create data filter .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilterid\fP (\fI\%int\fP) \-\- hdf5 filter id +\fBfilterid\fP (\fI\%int\fP) – hdf5 filter id .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- filter name +\fBname\fP (\fI\%str\fP) – filter name .IP \(bu 2 -\fBoptions\fP (\fI\%tuple\fP <\fI\%int\fP>) \-\- filter cd values +\fBoptions\fP (\fI\%tuple\fP <\fI\%int\fP>) – filter cd values .IP \(bu 2 -\fBavailability\fP (\fI\%str\fP) \-\- filter availability i.e. \(aqoptional\(aq or \(aqmandatory\(aq +\fBavailability\fP (\fI\%str\fP) – filter availability i.e. ‘optional’ or ‘mandatory’ .IP \(bu 2 -\fBshuffle\fP (\fI\%bool\fP) \-\- filter shuffle +\fBshuffle\fP (\fI\%bool\fP) – filter shuffle .IP \(bu 2 -\fBrate\fP (\fI\%bool\fP) \-\- filter shuffle +\fBrate\fP (\fI\%bool\fP) – filter shuffle .UNINDENT .TP .B Returns @@ -5913,9 +5913,9 @@ create data filter .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBrate\fP (\fI\%bool\fP) \-\- filter shuffle +\fBrate\fP (\fI\%bool\fP) – filter shuffle .IP \(bu 2 -\fBshuffle\fP (\fI\%bool\fP) \-\- filter shuffle +\fBshuffle\fP (\fI\%bool\fP) – filter shuffle .UNINDENT .TP .B Returns @@ -5932,7 +5932,7 @@ get links .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .TP .B Returns list of link objects @@ -6023,11 +6023,11 @@ create link .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtarget\fP (\fI\%str\fP) \-\- file name +\fBtarget\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- link name +\fBname\fP (\fI\%str\fP) – link name .UNINDENT .TP .B Returns @@ -6046,13 +6046,13 @@ load a file from memory byte buffer .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) \-\- memory buffer +\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) – memory buffer .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -6069,7 +6069,7 @@ converts to numpy types .INDENT 7.0 .TP .B Parameters -\fBdtype\fP (\fI\%str\fP) \-\- h5 writer type type +\fBdtype\fP (\fI\%str\fP) – h5 writer type type .TP .B Returns nupy type @@ -6087,11 +6087,11 @@ open the new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -6110,15 +6110,15 @@ create target field view for VDS .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBfieldpath\fP (\fI\%str\fP) \-\- nexus field path +\fBfieldpath\fP (\fI\%str\fP) – nexus field path .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .TP .B Returns @@ -6135,7 +6135,7 @@ return dataspace UNLIMITED variable for the current writer module .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .TP .B Returns dataspace UNLIMITED variable @@ -6153,9 +6153,9 @@ checks if hyperslab is unlimited .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBsel\fP (\fBfilewriter.FTHyperslab\fP) \-\- hyperslab selection +\fBsel\fP (\fBfilewriter.FTHyperslab\fP) – hyperslab selection .IP \(bu 2 -\fBshape\fP (\fI\%list\fP) \-\- give shape +\fBshape\fP (\fI\%list\fP) – give shape .UNINDENT .TP .B Returns @@ -6174,11 +6174,11 @@ creates a virtual field layout for a VDS file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .TP .B Returns @@ -6204,11 +6204,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTAttribute\fP) \-\- h5 implementation attribute +\fBh5imp\fP (\fBfilewriter.FTAttribute\fP) – h5 implementation attribute .UNINDENT .UNINDENT .UNINDENT @@ -6225,11 +6225,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTAttributeManager\fP) \-\- h5 implementation attributemanager +\fBh5imp\fP (\fBfilewriter.FTAttributeManager\fP) – h5 implementation attributemanager .UNINDENT .UNINDENT .INDENT 7.0 @@ -6241,13 +6241,13 @@ create a new attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- attribute name +\fBname\fP (\fI\%str\fP) – attribute name .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- attribute shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – attribute shape .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .UNINDENT .TP .B Returns @@ -6271,11 +6271,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTDataFilter\fP) \-\- h5 implementation data filter +\fBh5imp\fP (\fBfilewriter.FTDataFilter\fP) – h5 implementation data filter .UNINDENT .UNINDENT .UNINDENT @@ -6292,11 +6292,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTDataFilter\fP) \-\- h5 implementation data filter +\fBh5imp\fP (\fBfilewriter.FTDataFilter\fP) – h5 implementation data filter .UNINDENT .UNINDENT .UNINDENT @@ -6313,11 +6313,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTField\fP) \-\- h5 implementation field +\fBh5imp\fP (\fBfilewriter.FTField\fP) – h5 implementation field .UNINDENT .UNINDENT .INDENT 7.0 @@ -6329,9 +6329,9 @@ append device parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device value +\fBvalue\fP (\fI\%any\fP) – device value .IP \(bu 2 -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -6344,9 +6344,9 @@ append scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan parameter value +\fBvalue\fP (\fI\%any\fP) – scan parameter value .IP \(bu 2 -\fBkeys\fP \-\- scan parameter value +\fBkeys\fP – scan parameter value .UNINDENT .UNINDENT .UNINDENT @@ -6359,9 +6359,9 @@ scan object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- stream name +\fBname\fP (\fI\%str\fP) – stream name .IP \(bu 2 -\fBscan\fP (\fBStream\fP) \-\- stream object +\fBscan\fP (\fBStream\fP) – stream object .UNINDENT .UNINDENT .UNINDENT @@ -6385,7 +6385,7 @@ get scan info parameters .INDENT 7.0 .TP .B Parameters -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .TP .B Returns value device parameter value @@ -6401,7 +6401,7 @@ get scan info parameters .INDENT 7.0 .TP .B Parameters -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .TP .B Returns value device parameter value @@ -6417,7 +6417,7 @@ get scan info parameters .INDENT 7.0 .TP .B Parameters -\fBkeys\fP \-\- scan parameter value +\fBkeys\fP – scan parameter value .TP .B Returns value scan parameter value @@ -6435,11 +6435,11 @@ set scan attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcommand\fP (\fI\%str\fP) \-\- scan command +\fBcommand\fP (\fI\%str\fP) – scan command .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fIany\fP>) \-\- function list arguments +\fBargs\fP (\fI\%list\fP <\fIany\fP>) – function list arguments .IP \(bu 2 -\fBkwargs\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- function dict arguments +\fBkwargs\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – function dict arguments .UNINDENT .TP .B Returns @@ -6456,7 +6456,7 @@ get scan attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%str\fP) \-\- scan attr +\fBattr\fP (\fI\%str\fP) – scan attr .TP .B Returns scan attr value @@ -6474,9 +6474,9 @@ set attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBattr\fP (\fI\%str\fP) \-\- scan attr +\fBattr\fP (\fI\%str\fP) – scan attr .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan attr value +\fBvalue\fP (\fI\%any\fP) – scan attr value .UNINDENT .UNINDENT .UNINDENT @@ -6489,9 +6489,9 @@ set device parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device parameter value +\fBvalue\fP (\fI\%any\fP) – device parameter value .IP \(bu 2 -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -6504,9 +6504,9 @@ set device parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device parameter value +\fBvalue\fP (\fI\%any\fP) – device parameter value .IP \(bu 2 -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -6519,9 +6519,9 @@ scan object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBscan\fP \-\- scan object +\fBscan\fP – scan object .IP \(bu 2 -\fBtype\fP \-\- \fBScan\fP +\fBtype\fP – \fBScan\fP .UNINDENT .UNINDENT .UNINDENT @@ -6534,9 +6534,9 @@ set scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan parameter value +\fBvalue\fP (\fI\%any\fP) – scan parameter value .IP \(bu 2 -\fBkeys\fP \-\- scan parameter value +\fBkeys\fP – scan parameter value .UNINDENT .UNINDENT .UNINDENT @@ -6554,13 +6554,13 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTFile\fP) \-\- h5 implementation file +\fBh5imp\fP (\fBfilewriter.FTFile\fP) – h5 implementation file .IP \(bu 2 -\fBredisurl\fP (\fI\%str\fP) \-\- redis url string +\fBredisurl\fP (\fI\%str\fP) – redis url string .UNINDENT .UNINDENT .INDENT 7.0 @@ -6572,9 +6572,9 @@ append device info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device parameter value +\fBvalue\fP (\fI\%any\fP) – device parameter value .IP \(bu 2 -\fBkeys\fP \-\- device parameter value +\fBkeys\fP – device parameter value .UNINDENT .UNINDENT .UNINDENT @@ -6587,11 +6587,11 @@ append scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan parameter value +\fBvalue\fP (\fI\%any\fP) – scan parameter value .IP \(bu 2 -\fBkeys\fP \-\- scan parameter value +\fBkeys\fP – scan parameter value .IP \(bu 2 -\fBdirect\fP (\fI\%any\fP) \-\- scan info direct flag +\fBdirect\fP (\fI\%any\fP) – scan info direct flag .UNINDENT .UNINDENT .UNINDENT @@ -6604,9 +6604,9 @@ scan object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- stream name +\fBname\fP (\fI\%str\fP) – stream name .IP \(bu 2 -\fBscan\fP (\fBStream\fP) \-\- stream object +\fBscan\fP (\fBStream\fP) – stream object .UNINDENT .UNINDENT .UNINDENT @@ -6622,7 +6622,7 @@ get channel info parameters .INDENT 7.0 .TP .B Parameters -\fBkeys\fP \-\- channel parameter keys +\fBkeys\fP – channel parameter keys .TP .B Returns value channel parameter value @@ -6638,7 +6638,7 @@ get devices info parameters .INDENT 7.0 .TP .B Parameters -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .TP .B Returns value device parameter value @@ -6656,9 +6656,9 @@ get scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBkeys\fP \-\- scan parameter value +\fBkeys\fP – scan parameter value .IP \(bu 2 -\fBdirect\fP (\fI\%any\fP) \-\- scan info direct flag +\fBdirect\fP (\fI\%any\fP) – scan info direct flag .UNINDENT .TP .B Returns value @@ -6680,7 +6680,7 @@ reset scan info .INDENT 7.0 .TP .B Parameters -\fBentryname\fP (\fI\%str\fP) \-\- NXentry group name +\fBentryname\fP (\fI\%str\fP) – NXentry group name .UNINDENT .UNINDENT .INDENT 7.0 @@ -6705,11 +6705,11 @@ set scan attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcommand\fP (\fI\%str\fP) \-\- scan command +\fBcommand\fP (\fI\%str\fP) – scan command .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fIany\fP>) \-\- function list arguments +\fBargs\fP (\fI\%list\fP <\fIany\fP>) – function list arguments .IP \(bu 2 -\fBkwargs\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- function dict arguments +\fBkwargs\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – function dict arguments .UNINDENT .TP .B Returns @@ -6726,7 +6726,7 @@ get scan attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%str\fP) \-\- scan attr +\fBattr\fP (\fI\%str\fP) – scan attr .TP .B Returns scan attr value @@ -6744,9 +6744,9 @@ set attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBattr\fP (\fI\%str\fP) \-\- scan attr +\fBattr\fP (\fI\%str\fP) – scan attr .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan attr value +\fBvalue\fP (\fI\%any\fP) – scan attr value .UNINDENT .UNINDENT .UNINDENT @@ -6759,9 +6759,9 @@ set channel info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- channel parameter value +\fBvalue\fP (\fI\%any\fP) – channel parameter value .IP \(bu 2 -\fBkeys\fP \-\- channel parameter keys +\fBkeys\fP – channel parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -6774,9 +6774,9 @@ set device info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device parameter value +\fBvalue\fP (\fI\%any\fP) – device parameter value .IP \(bu 2 -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -6787,7 +6787,7 @@ set entry name .INDENT 7.0 .TP .B Parameters -\fBentryname\fP (\fI\%str\fP) \-\- entry name +\fBentryname\fP (\fI\%str\fP) – entry name .UNINDENT .UNINDENT .INDENT 7.0 @@ -6797,7 +6797,7 @@ set instrument name .INDENT 7.0 .TP .B Parameters -\fBinsname\fP (\fI\%str\fP) \-\- instrument name +\fBinsname\fP (\fI\%str\fP) – instrument name .UNINDENT .UNINDENT .INDENT 7.0 @@ -6807,7 +6807,7 @@ scan object .INDENT 7.0 .TP .B Parameters -\fBscan\fP (\fBScan\fP) \-\- scan object +\fBscan\fP (\fBScan\fP) – scan object .UNINDENT .UNINDENT .INDENT 7.0 @@ -6819,11 +6819,11 @@ set scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan parameter value +\fBvalue\fP (\fI\%any\fP) – scan parameter value .IP \(bu 2 -\fBkeys\fP \-\- scan parameter value +\fBkeys\fP – scan parameter value .IP \(bu 2 -\fBdirect\fP (\fI\%any\fP) \-\- scan info direct flag +\fBdirect\fP (\fI\%any\fP) – scan info direct flag .UNINDENT .UNINDENT .UNINDENT @@ -6846,15 +6846,15 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- tree parent +\fBtparent\fP (\fBFTObject\fP) – tree parent .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTGroup\fP) \-\- h5 implementation group +\fBh5imp\fP (\fBfilewriter.FTGroup\fP) – h5 implementation group .IP \(bu 2 -\fBredis\fP (\fI\%any\fP) \-\- redis object +\fBredis\fP (\fI\%any\fP) – redis object .IP \(bu 2 -\fBnxclass\fP (\fI\%str\fP) \-\- nxclass +\fBnxclass\fP (\fI\%str\fP) – nxclass .UNINDENT .UNINDENT .INDENT 7.0 @@ -6866,7 +6866,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBgroup\fP (\fI\%H5RedisGroup\fP) \-\- group object +\fBgroup\fP (\fI\%H5RedisGroup\fP) – group object .UNINDENT .INDENT 7.0 .TP @@ -6891,9 +6891,9 @@ append device parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device value +\fBvalue\fP (\fI\%any\fP) – device value .IP \(bu 2 -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -6906,11 +6906,11 @@ append scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan parameter value +\fBvalue\fP (\fI\%any\fP) – scan parameter value .IP \(bu 2 -\fBkeys\fP \-\- scan parameter keys +\fBkeys\fP – scan parameter keys .IP \(bu 2 -\fBdirect\fP (\fI\%any\fP) \-\- scan info direct flag +\fBdirect\fP (\fI\%any\fP) – scan info direct flag .UNINDENT .UNINDENT .UNINDENT @@ -6923,9 +6923,9 @@ scan object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- stream name +\fBname\fP (\fI\%str\fP) – stream name .IP \(bu 2 -\fBscan\fP (\fBStream\fP) \-\- stream object +\fBscan\fP (\fBStream\fP) – stream object .UNINDENT .UNINDENT .UNINDENT @@ -6951,15 +6951,15 @@ open a file tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBn\fP (\fI\%str\fP) \-\- group name +\fBn\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBtype_code\fP (\fI\%str\fP) \-\- nexus field type +\fBtype_code\fP (\fI\%str\fP) – nexus field type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) \-\- chunk +\fBchunk\fP (\fI\%list\fP < \fI\%int\fP >) – chunk .IP \(bu 2 -\fBdfilter\fP (\fBH5CppDataFilter\fP) \-\- filter deflater +\fBdfilter\fP (\fBH5CppDataFilter\fP) – filter deflater .UNINDENT .TP .B Returns @@ -6978,9 +6978,9 @@ open a file tree element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBn\fP (\fI\%str\fP) \-\- group name +\fBn\fP (\fI\%str\fP) – group name .IP \(bu 2 -\fBnxclass\fP (\fI\%str\fP) \-\- group type +\fBnxclass\fP (\fI\%str\fP) – group type .UNINDENT .TP .B Returns @@ -6999,11 +6999,11 @@ creates a virtual filed tres element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- field name +\fBname\fP (\fI\%str\fP) – field name .IP \(bu 2 -\fBlayout\fP (\fBH5CppFieldLayout\fP) \-\- virual field layout +\fBlayout\fP (\fBH5CppFieldLayout\fP) – virual field layout .IP \(bu 2 -\fBfillvalue\fP (\fI\%int\fP or \fBnp.ndarray\fP) \-\- fill value +\fBfillvalue\fP (\fI\%int\fP or \fBnp.ndarray\fP) – fill value .UNINDENT .TP .B Returns @@ -7020,7 +7020,7 @@ get scan info parameters .INDENT 7.0 .TP .B Parameters -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .TP .B Returns value device parameter value @@ -7036,7 +7036,7 @@ get scan info parameters .INDENT 7.0 .TP .B Parameters -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .TP .B Returns value device parameter value @@ -7054,9 +7054,9 @@ get scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBkeys\fP \-\- scan parameter keys +\fBkeys\fP – scan parameter keys .IP \(bu 2 -\fBdirect\fP (\fI\%any\fP) \-\- scan info direct flag +\fBdirect\fP (\fI\%any\fP) – scan info direct flag .UNINDENT .TP .B Returns value @@ -7073,7 +7073,7 @@ open a file tree element .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -7089,7 +7089,7 @@ open a file tree element as link .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- element name +\fBname\fP (\fI\%str\fP) – element name .TP .B Returns file tree object @@ -7105,7 +7105,7 @@ reset scan info .INDENT 7.0 .TP .B Parameters -\fBentryname\fP (\fI\%str\fP) \-\- NXentry group name +\fBentryname\fP (\fI\%str\fP) – NXentry group name .UNINDENT .UNINDENT .INDENT 7.0 @@ -7117,11 +7117,11 @@ set scan attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcommand\fP (\fI\%str\fP) \-\- scan command +\fBcommand\fP (\fI\%str\fP) – scan command .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fIany\fP>) \-\- function list arguments +\fBargs\fP (\fI\%list\fP <\fIany\fP>) – function list arguments .IP \(bu 2 -\fBkwargs\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- function dict arguments +\fBkwargs\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – function dict arguments .UNINDENT .TP .B Returns @@ -7138,7 +7138,7 @@ get scan attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%str\fP) \-\- scan attr +\fBattr\fP (\fI\%str\fP) – scan attr .TP .B Returns scan attr value @@ -7156,9 +7156,9 @@ set attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBattr\fP (\fI\%str\fP) \-\- scan attr +\fBattr\fP (\fI\%str\fP) – scan attr .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan attr value +\fBvalue\fP (\fI\%any\fP) – scan attr value .UNINDENT .UNINDENT .UNINDENT @@ -7171,9 +7171,9 @@ set device parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device parameter value +\fBvalue\fP (\fI\%any\fP) – device parameter value .IP \(bu 2 -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -7186,9 +7186,9 @@ set device parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- device parameter value +\fBvalue\fP (\fI\%any\fP) – device parameter value .IP \(bu 2 -\fBkeys\fP \-\- device parameter keys +\fBkeys\fP – device parameter keys .UNINDENT .UNINDENT .UNINDENT @@ -7199,7 +7199,7 @@ set entry name .INDENT 7.0 .TP .B Parameters -\fBentryname\fP (\fI\%str\fP) \-\- entry name +\fBentryname\fP (\fI\%str\fP) – entry name .UNINDENT .UNINDENT .INDENT 7.0 @@ -7209,7 +7209,7 @@ set instrument name .INDENT 7.0 .TP .B Parameters -\fBinsname\fP (\fI\%str\fP) \-\- instrument name +\fBinsname\fP (\fI\%str\fP) – instrument name .UNINDENT .UNINDENT .INDENT 7.0 @@ -7221,9 +7221,9 @@ scan object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBscan\fP \-\- scan object +\fBscan\fP – scan object .IP \(bu 2 -\fBtype\fP \-\- \fBScan\fP +\fBtype\fP – \fBScan\fP .UNINDENT .UNINDENT .UNINDENT @@ -7236,11 +7236,11 @@ set scan info parameters .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%any\fP) \-\- scan parameter value +\fBvalue\fP (\fI\%any\fP) – scan parameter value .IP \(bu 2 -\fBkeys\fP \-\- scan parameter keys +\fBkeys\fP – scan parameter keys .IP \(bu 2 -\fBdirect\fP (\fI\%any\fP) \-\- scan info direct flag +\fBdirect\fP (\fI\%any\fP) – scan info direct flag .UNINDENT .UNINDENT .UNINDENT @@ -7258,9 +7258,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBtparent\fP (\fBFTObject\fP) \-\- treee parent +\fBtparent\fP (\fBFTObject\fP) – treee parent .UNINDENT .UNINDENT .UNINDENT @@ -7277,17 +7277,17 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBfieldpath\fP (\fI\%str\fP) \-\- nexus field path +\fBfieldpath\fP (\fI\%str\fP) – nexus field path .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTTargetFieldView\fP) \-\- h5 implementation targetfieldview +\fBh5imp\fP (\fBfilewriter.FTTargetFieldView\fP) – h5 implementation targetfieldview .UNINDENT .UNINDENT .UNINDENT @@ -7304,15 +7304,15 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBh5object\fP (\fI\%any\fP) \-\- h5 object +\fBh5object\fP (\fI\%any\fP) – h5 object .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBh5imp\fP (\fBfilewriter.FTVirtualFieldLayout\fP) \-\- h5 implementation virtual field layout +\fBh5imp\fP (\fBfilewriter.FTVirtualFieldLayout\fP) – h5 implementation virtual field layout .UNINDENT .UNINDENT .UNINDENT @@ -7325,13 +7325,13 @@ create a new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBoverwrite\fP (\fI\%bool\fP) \-\- overwrite flag +\fBoverwrite\fP (\fI\%bool\fP) – overwrite flag .IP \(bu 2 -\fBlibver\fP (\fI\%str\fP) \-\- library version: \(aqlastest\(aq or \(aqearliest\(aq +\fBlibver\fP (\fI\%str\fP) – library version: ‘lastest’ or ‘earliest’ .IP \(bu 2 -\fBredisurl\fP (\fI\%str\fP) \-\- redis URL +\fBredisurl\fP (\fI\%str\fP) – redis URL .UNINDENT .TP .B Returns @@ -7350,17 +7350,17 @@ create data filter .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilterid\fP (\fI\%int\fP) \-\- hdf5 filter id +\fBfilterid\fP (\fI\%int\fP) – hdf5 filter id .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- filter name +\fBname\fP (\fI\%str\fP) – filter name .IP \(bu 2 -\fBoptions\fP (\fI\%tuple\fP <\fI\%int\fP>) \-\- filter cd values +\fBoptions\fP (\fI\%tuple\fP <\fI\%int\fP>) – filter cd values .IP \(bu 2 -\fBavailability\fP (\fI\%str\fP) \-\- filter availability i.e. \(aqoptional\(aq or \(aqmandatory\(aq +\fBavailability\fP (\fI\%str\fP) – filter availability i.e. ‘optional’ or ‘mandatory’ .IP \(bu 2 -\fBshuffle\fP (\fI\%bool\fP) \-\- filter shuffle +\fBshuffle\fP (\fI\%bool\fP) – filter shuffle .IP \(bu 2 -\fBrate\fP (\fI\%bool\fP) \-\- filter shuffle +\fBrate\fP (\fI\%bool\fP) – filter shuffle .UNINDENT .TP .B Returns @@ -7379,9 +7379,9 @@ create data filter .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBrate\fP (\fI\%bool\fP) \-\- filter shuffle +\fBrate\fP (\fI\%bool\fP) – filter shuffle .IP \(bu 2 -\fBshuffle\fP (\fI\%bool\fP) \-\- filter shuffle +\fBshuffle\fP (\fI\%bool\fP) – filter shuffle .UNINDENT .TP .B Returns @@ -7398,7 +7398,7 @@ get links .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .TP .B Returns list of link objects @@ -7463,11 +7463,11 @@ create link .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtarget\fP (\fI\%str\fP) \-\- nexus path name +\fBtarget\fP (\fI\%str\fP) – nexus path name .IP \(bu 2 -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- link name +\fBname\fP (\fI\%str\fP) – link name .UNINDENT .TP .B Returns @@ -7486,13 +7486,13 @@ load a file from memory byte buffer .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) \-\- memory buffer +\fBmembuffer\fP (\fI\%bytes\fP or \fI\%io.BytesIO\fP) – memory buffer .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) \-\- parameters +\fBpars\fP (\fI\%dict\fP < \fI\%str\fP, \fI\%str\fP>) – parameters .UNINDENT .TP .B Returns @@ -7509,7 +7509,7 @@ converts to numpy types .INDENT 7.0 .TP .B Parameters -\fBdtype\fP (\fI\%str\fP) \-\- h5 writer type type +\fBdtype\fP (\fI\%str\fP) – h5 writer type type .TP .B Returns nupy type @@ -7527,13 +7527,13 @@ open the new file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBreadonly\fP (\fI\%bool\fP) \-\- readonly flag +\fBreadonly\fP (\fI\%bool\fP) – readonly flag .IP \(bu 2 -\fBredisurl\fP (\fI\%str\fP) \-\- redis URL +\fBredisurl\fP (\fI\%str\fP) – redis URL .IP \(bu 2 -\fBlibver\fP (\fI\%str\fP) \-\- library version: \(aqlastest\(aq or \(aqearliest\(aq +\fBlibver\fP (\fI\%str\fP) – library version: ‘lastest’ or ‘earliest’ .UNINDENT .TP .B Returns @@ -7552,9 +7552,9 @@ split string separated by space .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtext\fP (\fI\%list\fP <\fI\%str\fP>) \-\- text to split +\fBtext\fP (\fI\%list\fP <\fI\%str\fP>) – text to split .IP \(bu 2 -\fBtext\fP \-\- split text +\fBtext\fP – split text .UNINDENT .UNINDENT .UNINDENT @@ -7567,15 +7567,15 @@ create target field view for VDS .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBfieldpath\fP (\fI\%str\fP) \-\- nexus field path +\fBfieldpath\fP (\fI\%str\fP) – nexus field path .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .TP .B Returns @@ -7592,7 +7592,7 @@ return dataspace UNLIMITED variable for the current writer module .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fBFTObject\fP) \-\- parent object +\fBparent\fP (\fBFTObject\fP) – parent object .TP .B Returns dataspace UNLIMITED variable @@ -7610,9 +7610,9 @@ checks if hyperslab is unlimited .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBsel\fP (\fBfilewriter.FTHyperslab\fP) \-\- hyperslab selection +\fBsel\fP (\fBfilewriter.FTHyperslab\fP) – hyperslab selection .IP \(bu 2 -\fBshape\fP (\fI\%list\fP) \-\- give shape +\fBshape\fP (\fI\%list\fP) – give shape .UNINDENT .TP .B Returns @@ -7631,11 +7631,11 @@ creates a virtual field layout for a VDS file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .IP \(bu 2 -\fBdtype\fP (\fI\%str\fP) \-\- attribute type +\fBdtype\fP (\fI\%str\fP) – attribute type .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) \-\- shape +\fBmaxshape\fP (\fI\%list\fP < \fI\%int\fP >) – shape .UNINDENT .TP .B Returns @@ -7666,7 +7666,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBkwargs\fP \-\- \fI\%argparse.ArgumentParser\fP +\fBkwargs\fP – \fI\%argparse.ArgumentParser\fP parameter dictionary .UNINDENT .INDENT 7.0 @@ -7689,7 +7689,7 @@ error handler .INDENT 7.0 .TP .B Parameters -\fBmessage\fP (\fI\%str\fP) \-\- error message +\fBmessage\fP (\fI\%str\fP) – error message .UNINDENT .UNINDENT .UNINDENT @@ -7704,7 +7704,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -7733,7 +7733,7 @@ run commandthe main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -7755,17 +7755,17 @@ The constructor creates the collector object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnexusfilename\fP (\fI\%str\fP) \-\- the nexus file name +\fBnexusfilename\fP (\fI\%str\fP) – the nexus file name .IP \(bu 2 -\fBcompression\fP (\fI\%int\fP) \-\- compression rate +\fBcompression\fP (\fI\%int\fP) – compression rate .IP \(bu 2 -\fBskipmissing\fP (\fI\%bool\fP) \-\- if skip missing images +\fBskipmissing\fP (\fI\%bool\fP) – if skip missing images .IP \(bu 2 -\fBstoreold\fP (\fI\%bool\fP) \-\- if backup the input file +\fBstoreold\fP (\fI\%bool\fP) – if backup the input file .IP \(bu 2 -\fBtestmode\fP (\fI\%bool\fP) \-\- if run in a test mode +\fBtestmode\fP (\fI\%bool\fP) – if run in a test mode .IP \(bu 2 -\fBwriter\fP (\fI\%str\fP) \-\- the writer module +\fBwriter\fP (\fI\%str\fP) – the writer module .UNINDENT .UNINDENT .INDENT 7.0 @@ -7781,13 +7781,13 @@ or appends specific data if path and inputfiles are given .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpath\fP (\fI\%str\fP) \-\- nexus path of the data field +\fBpath\fP (\fI\%str\fP) – nexus path of the data field .IP \(bu 2 -\fBinputfiles\fP (\fI\%list\fP <\fI\%str\fP>) \-\- a list of file strings +\fBinputfiles\fP (\fI\%list\fP <\fI\%str\fP>) – a list of file strings .IP \(bu 2 -\fBdatatype\fP (\fI\%str\fP) \-\- field data type +\fBdatatype\fP (\fI\%str\fP) – field data type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP <\fI\%int\fP >) \-\- field shape +\fBshape\fP (\fI\%list\fP <\fI\%int\fP >) – field shape .UNINDENT .UNINDENT .UNINDENT @@ -7803,7 +7803,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -7832,7 +7832,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -7847,9 +7847,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBhyperslab\fP (\fBfilewriter.FTHyperslab\fP) \-\- target field object +\fBhyperslab\fP (\fBfilewriter.FTHyperslab\fP) – target field object .IP \(bu 2 -\fBhyperslab\fP \-\- field hyperslab or slices +\fBhyperslab\fP – field hyperslab or slices .UNINDENT .UNINDENT .INDENT 7.0 @@ -7884,7 +7884,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -7913,7 +7913,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -7930,15 +7930,15 @@ The constructor creates the collector object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnexusfilepath\fP (\fI\%str\fP) \-\- the nexus file name and nexus path +\fBnexusfilepath\fP (\fI\%str\fP) – the nexus file name and nexus path .IP \(bu 2 -\fBtarget\fP (\fI\%str\fP) \-\- the nexus file name and nexus path +\fBtarget\fP (\fI\%str\fP) – the nexus file name and nexus path .IP \(bu 2 -\fBstoreold\fP (\fI\%bool\fP) \-\- if backup the input file +\fBstoreold\fP (\fI\%bool\fP) – if backup the input file .IP \(bu 2 -\fBtestmode\fP (\fI\%bool\fP) \-\- if run in a test mode +\fBtestmode\fP (\fI\%bool\fP) – if run in a test mode .IP \(bu 2 -\fBwriter\fP (\fI\%str\fP) \-\- the writer module +\fBwriter\fP (\fI\%str\fP) – the writer module .UNINDENT .UNINDENT .INDENT 7.0 @@ -7960,15 +7960,15 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- file name +\fBfilename\fP (\fI\%str\fP) – file name .IP \(bu 2 -\fBpath\fP (\fI\%str\fP) \-\- nexus field path with its name +\fBpath\fP (\fI\%str\fP) – nexus field path with its name .IP \(bu 2 -\fBshape\fP (\fI\%list\fP <\fI\%int\fP>) \-\- field shape +\fBshape\fP (\fI\%list\fP <\fI\%int\fP>) – field shape .IP \(bu 2 -\fBhyperslab\fP (\fBfilewriter.FTHyperslab\fP) \-\- field hyperslab or slices +\fBhyperslab\fP (\fBfilewriter.FTHyperslab\fP) – field hyperslab or slices .IP \(bu 2 -\fBmaxshape\fP (\fI\%list\fP <\fI\%int\fP>) \-\- maximal field shape +\fBmaxshape\fP (\fI\%list\fP <\fI\%int\fP>) – maximal field shape .UNINDENT .UNINDENT .INDENT 7.0 @@ -8013,13 +8013,13 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBexfieldpaths\fP (\fI\%str\fP) \-\- target field paths +\fBexfieldpaths\fP (\fI\%str\fP) – target field paths .IP \(bu 2 -\fBexfieldshapes\fP (\fI\%str\fP) \-\- target field shapes +\fBexfieldshapes\fP (\fI\%str\fP) – target field shapes .IP \(bu 2 -\fBshapes\fP (\fBlist\(ga<:obj:\(gatuple\(ga<:obj:\(gaint\fP> >) \-\- target field shapes +\fBshapes\fP (\fBlist\(ga<:obj:\(gatuple\(ga<:obj:\(gaint\fP> >) – target field shapes .IP \(bu 2 -\fBexfieldpaths\fP \-\- separator of field path strings +\fBexfieldpaths\fP – separator of field path strings .UNINDENT .UNINDENT .INDENT 7.0 @@ -8031,13 +8031,13 @@ add layout hyperslabs .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoffsets\fP (\fI\%str\fP) \-\- layout offsets +\fBoffsets\fP (\fI\%str\fP) – layout offsets .IP \(bu 2 -\fBblocks\fP (\fI\%str\fP) \-\- layout blocks +\fBblocks\fP (\fI\%str\fP) – layout blocks .IP \(bu 2 -\fBcounts\fP (\fI\%str\fP) \-\- layout counts +\fBcounts\fP (\fI\%str\fP) – layout counts .IP \(bu 2 -\fBstrides\fP (\fI\%str\fP) \-\- layout strides +\fBstrides\fP (\fI\%str\fP) – layout strides .UNINDENT .UNINDENT .UNINDENT @@ -8048,7 +8048,7 @@ add layout slices .INDENT 7.0 .TP .B Parameters -\fBslices\fP (\fI\%str\fP) \-\- layout slices +\fBslices\fP (\fI\%str\fP) – layout slices .UNINDENT .UNINDENT .INDENT 7.0 @@ -8060,13 +8060,13 @@ add target hyperslabs .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoffsets\fP (\fI\%str\fP) \-\- target offsets +\fBoffsets\fP (\fI\%str\fP) – target offsets .IP \(bu 2 -\fBblocks\fP (\fI\%str\fP) \-\- target blocks +\fBblocks\fP (\fI\%str\fP) – target blocks .IP \(bu 2 -\fBcounts\fP (\fI\%str\fP) \-\- target counts +\fBcounts\fP (\fI\%str\fP) – target counts .IP \(bu 2 -\fBstrides\fP (\fI\%str\fP) \-\- target strides +\fBstrides\fP (\fI\%str\fP) – target strides .UNINDENT .UNINDENT .UNINDENT @@ -8077,7 +8077,7 @@ add taget slices .INDENT 7.0 .TP .B Parameters -\fBslices\fP (\fI\%str\fP) \-\- target slices +\fBslices\fP (\fI\%str\fP) – target slices .UNINDENT .UNINDENT .UNINDENT @@ -8092,7 +8092,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8121,7 +8121,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -8138,11 +8138,11 @@ The constructor creates the collector object .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnexusfilepath\fP (\fI\%str\fP) \-\- the nexus file name and nexus path +\fBnexusfilepath\fP (\fI\%str\fP) – the nexus file name and nexus path .IP \(bu 2 -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .IP \(bu 2 -\fBwriter\fP (\fI\%str\fP) \-\- the writer module +\fBwriter\fP (\fI\%str\fP) – the writer module .UNINDENT .UNINDENT .INDENT 7.0 @@ -8158,7 +8158,7 @@ convert coorinate to int or None or Unlimited .INDENT 7.0 .TP .B Parameters -\fBcrd\fP (\fIcordinate as string\fP) \-\- cordinate as string +\fBcrd\fP (\fIcordinate as string\fP) – cordinate as string .TP .B Returns converted coordinate @@ -8174,7 +8174,7 @@ provides file name generator from file string .INDENT 7.0 .TP .B Parameters -\fBfilestr\fP \-\- file string +\fBfilestr\fP – file string .TP .B Type filestr: \fI\%str\fP @@ -8192,16 +8192,16 @@ file name generator or a list of file names .INDENT 7.0 .TP .B converts compression string to a deflate level parameter -or list with [filterid, opt1, opt2, ...] +or list with [filterid, opt1, opt2, …] .UNINDENT .INDENT 7.0 .TP .B Parameters -\fBcompression\fP (\fI\%str\fP) \-\- compression string +\fBcompression\fP (\fI\%str\fP) – compression string .TP .B Returns deflate level parameter -or list with [filterid, opt1, opt2, ...] +or list with [filterid, opt1, opt2, …] .TP .B Return type \fI\%int\fP or \fI\%list\fP < \fI\%int\fP > or \fINone\fP @@ -8219,7 +8219,7 @@ splits coordinate string .INDENT 7.0 .TP .B Parameters -\fBcrdstr\fP (\fIcordinate string\fP) \-\- cordinate string +\fBcrdstr\fP (\fIcordinate string\fP) – cordinate string .TP .B Returns a list ofr coordinates in tuples @@ -8235,7 +8235,7 @@ splits coordinate string .INDENT 7.0 .TP .B Parameters -\fBcrdstr\fP (\fIcordinate string\fP) \-\- cordinate string +\fBcrdstr\fP (\fIcordinate string\fP) – cordinate string .TP .B Returns a list ofr coordinates in tuples @@ -8258,7 +8258,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8282,7 +8282,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8305,9 +8305,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdevice\fP (\fI\%str\fP) \-\- device name of the configuration server +\fBdevice\fP (\fI\%str\fP) – device name of the configuration server .IP \(bu 2 -\fBnonewline\fP (\fI\%bool\fP) \-\- if the output should not be separated +\fBnonewline\fP (\fI\%bool\fP) – if the output should not be separated by the new line character .UNINDENT .UNINDENT @@ -8323,7 +8323,7 @@ lists components of the components .INDENT 7.0 .TP .B Parameters -\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) \-\- given components +\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) – given components .TP .B Returns list of component names @@ -8339,7 +8339,7 @@ provides varaible values .INDENT 7.0 .TP .B Parameters -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .TP .B Returns JSON with variables @@ -8357,13 +8357,13 @@ delete the DB items .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBds\fP (\fI\%bool\fP) \-\- flag set True for datasources +\fBds\fP (\fI\%bool\fP) – flag set True for datasources .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .IP \(bu 2 -\fBask\fP (\fI\%bool\fP) \-\- ask flag +\fBask\fP (\fI\%bool\fP) – ask flag .IP \(bu 2 -\fBprofiles\fP (\fI\%bool\fP) \-\- flag set True for profiles +\fBprofiles\fP (\fI\%bool\fP) – flag set True for profiles .UNINDENT .TP .B Returns @@ -8382,17 +8382,17 @@ provides description of configuration elements .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBds\fP (\fI\%bool\fP) \-\- flag set True for datasources +\fBds\fP (\fI\%bool\fP) – flag set True for datasources .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .IP \(bu 2 -\fBmd\fP (\fI\%bool\fP) \-\- flag set True for mandatory components +\fBmd\fP (\fI\%bool\fP) – flag set True for mandatory components .IP \(bu 2 -\fBpr\fP (\fI\%str\fP) \-\- flag set True for private components +\fBpr\fP (\fI\%str\fP) – flag set True for private components .IP \(bu 2 -\fBpr\fP \-\- column headers +\fBpr\fP – column headers .IP \(bu 2 -\fBfilters\fP (\fI\%str\fP) \-\- filters for first column names separated by comma +\fBfilters\fP (\fI\%str\fP) – filters for first column names separated by comma .UNINDENT .TP .B Returns @@ -8411,11 +8411,11 @@ provides geometry info for given elements .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .IP \(bu 2 -\fBmd\fP (\fI\%bool\fP) \-\- flag set True for mandatory components +\fBmd\fP (\fI\%bool\fP) – flag set True for mandatory components .IP \(bu 2 -\fBpr\fP (\fI\%bool\fP) \-\- flag set True for private components +\fBpr\fP (\fI\%bool\fP) – flag set True for private components .UNINDENT .TP .B Returns @@ -8432,7 +8432,7 @@ provides final configuration .INDENT 7.0 .TP .B Parameters -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .TP .B Returns XML configuration string @@ -8450,15 +8450,15 @@ Provides info for given elements .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBds\fP (\fI\%bool\fP) \-\- flag set True for datasources +\fBds\fP (\fI\%bool\fP) – flag set True for datasources .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .IP \(bu 2 -\fBmd\fP (\fI\%bool\fP) \-\- flag set True for mandatory components +\fBmd\fP (\fI\%bool\fP) – flag set True for mandatory components .IP \(bu 2 -\fBpr\fP (\fI\%bool\fP) \-\- flag set True for private components +\fBpr\fP (\fI\%bool\fP) – flag set True for private components .IP \(bu 2 -\fBprofiles\fP (\fI\%bool\fP) \-\- flag set True for profiles +\fBprofiles\fP (\fI\%bool\fP) – flag set True for profiles .UNINDENT .TP .B Returns @@ -8477,13 +8477,13 @@ lists the DB item names .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBds\fP (\fI\%bool\fP) \-\- flag set True for datasources +\fBds\fP (\fI\%bool\fP) – flag set True for datasources .IP \(bu 2 -\fBmandatory\fP (\fI\%bool\fP) \-\- flag set True for mandatory components +\fBmandatory\fP (\fI\%bool\fP) – flag set True for mandatory components .IP \(bu 2 -\fBprivate\fP (\fI\%bool\fP) \-\- flag set True for components starting with \(aq__\(aq +\fBprivate\fP (\fI\%bool\fP) – flag set True for components starting with ‘__’ .IP \(bu 2 -\fBprofiles\fP (\fI\%bool\fP) \-\- flag set True for profiles +\fBprofiles\fP (\fI\%bool\fP) – flag set True for profiles .UNINDENT .TP .B Returns @@ -8500,7 +8500,7 @@ provides merged components .INDENT 7.0 .TP .B Parameters -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .TP .B Returns XML configuration string with merged components @@ -8518,9 +8518,9 @@ lists datasources of the component .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBds\fP (\fI\%bool\fP) \-\- flag set True for datasources +\fBds\fP (\fI\%bool\fP) – flag set True for datasources .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- given component or datasource +\fBname\fP (\fI\%str\fP) – given component or datasource .UNINDENT .TP .B Returns @@ -8539,15 +8539,15 @@ shows the DB items .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBds\fP (\fI\%bool\fP) \-\- flag set True for datasources +\fBds\fP (\fI\%bool\fP) – flag set True for datasources .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .IP \(bu 2 -\fBmandatory\fP (\fI\%bool\fP) \-\- flag set True for mandatory components +\fBmandatory\fP (\fI\%bool\fP) – flag set True for mandatory components .IP \(bu 2 -\fBprofiles\fP (\fI\%bool\fP) \-\- flag set True for profiles +\fBprofiles\fP (\fI\%bool\fP) – flag set True for profiles .IP \(bu 2 -\fBdirectory\fP (\fI\%str\fP) \-\- output file directory +\fBdirectory\fP (\fI\%str\fP) – output file directory .UNINDENT .TP .B Returns @@ -8564,7 +8564,7 @@ lists datasources of the components .INDENT 7.0 .TP .B Parameters -\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) \-\- given components +\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) – given components .TP .B Returns list of datasource names @@ -8582,19 +8582,19 @@ upload the DB items from files .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBds\fP (\fI\%bool\fP) \-\- flag set True for datasources +\fBds\fP (\fI\%bool\fP) – flag set True for datasources .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of item names +\fBargs\fP (\fI\%list\fP <\fI\%str\fP>) – list of item names .IP \(bu 2 -\fBforce\fP (\fI\%bool\fP) \-\- force flag +\fBforce\fP (\fI\%bool\fP) – force flag .IP \(bu 2 -\fBprofiles\fP (\fI\%bool\fP) \-\- flag set True for profiles +\fBprofiles\fP (\fI\%bool\fP) – flag set True for profiles .IP \(bu 2 -\fBdirectory\fP (\fI\%str\fP) \-\- input file directory +\fBdirectory\fP (\fI\%str\fP) – input file directory .IP \(bu 2 -\fBmandatory\fP (\fI\%bool\fP) \-\- mandatory flag +\fBmandatory\fP (\fI\%bool\fP) – mandatory flag .IP \(bu 2 -\fBexternal\fP (\fI\%str\fP) \-\- external import type +\fBexternal\fP (\fI\%str\fP) – external import type .UNINDENT .TP .B Returns @@ -8611,7 +8611,7 @@ lists variable of the components .INDENT 7.0 .TP .B Parameters -\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) \-\- given components +\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) – given components .TP .B Returns list of datasource names @@ -8632,7 +8632,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8656,7 +8656,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8677,7 +8677,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8701,7 +8701,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8722,7 +8722,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8746,7 +8746,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8767,7 +8767,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8791,7 +8791,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8812,7 +8812,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8836,7 +8836,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8857,7 +8857,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8881,7 +8881,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8902,7 +8902,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8926,7 +8926,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8947,7 +8947,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -8971,7 +8971,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -8992,7 +8992,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9016,7 +9016,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -9037,7 +9037,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9061,7 +9061,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -9082,7 +9082,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9106,7 +9106,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -9127,7 +9127,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9151,7 +9151,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -9172,7 +9172,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9196,7 +9196,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -9217,7 +9217,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9241,7 +9241,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -9270,7 +9270,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9294,7 +9294,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9309,7 +9309,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9333,7 +9333,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9348,7 +9348,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9377,7 +9377,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9392,7 +9392,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9416,7 +9416,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9431,7 +9431,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9460,7 +9460,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9475,7 +9475,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9504,7 +9504,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9524,7 +9524,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9553,7 +9553,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9568,7 +9568,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9592,7 +9592,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9607,7 +9607,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9631,7 +9631,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9646,7 +9646,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -9670,7 +9670,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -9695,11 +9695,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP <\fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -9754,11 +9754,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -9780,11 +9780,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -9815,11 +9815,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -9841,11 +9841,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -9895,9 +9895,9 @@ sets attribute and datasource group of online.xml device .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtangohost\fP (\fI\%str\fP) \-\- tango host +\fBtangohost\fP (\fI\%str\fP) – tango host .IP \(bu 2 -\fBclientlike\fP (\fI\%bool\fP) \-\- tango motors to be client like +\fBclientlike\fP (\fI\%bool\fP) – tango motors to be client like .UNINDENT .UNINDENT .UNINDENT @@ -9908,7 +9908,7 @@ sets sardana device name and sardana host/port of online.xml device .INDENT 7.0 .TP .B Parameters -\fBtangohost\fP (\fI\%str\fP) \-\- tango host +\fBtangohost\fP (\fI\%str\fP) – tango host .UNINDENT .UNINDENT .INDENT 7.0 @@ -9963,7 +9963,7 @@ sets sardana name .INDENT 7.0 .TP .B Parameters -\fBtolower\fP (\fI\%bool\fP) \-\- If True name in lowercase +\fBtolower\fP (\fI\%bool\fP) – If True name in lowercase .UNINDENT .UNINDENT .INDENT 7.0 @@ -10015,11 +10015,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -10042,11 +10042,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -10094,11 +10094,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP <\fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -10145,11 +10145,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP <\fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -10181,11 +10181,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -10202,19 +10202,19 @@ create SECoP datasource .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdsname\fP (\fI\%str\fP) \-\- datasource name +\fBdsname\fP (\fI\%str\fP) – datasource name .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- secop command +\fBmessage\fP (\fI\%str\fP) – secop command .IP \(bu 2 -\fBgroup\fP (\fI\%str\fP) \-\- secop group name +\fBgroup\fP (\fI\%str\fP) – secop group name .IP \(bu 2 -\fBaccess\fP (\fI\%str\fP) \-\- secop attribute access list +\fBaccess\fP (\fI\%str\fP) – secop attribute access list .IP \(bu 2 -\fBhost\fP (\fI\%str\fP) \-\- secop host name +\fBhost\fP (\fI\%str\fP) – secop host name .IP \(bu 2 -\fBport\fP (\fI\%str\fP or \fI\%float\fP) \-\- secop port name +\fBport\fP (\fI\%str\fP or \fI\%float\fP) – secop port name .IP \(bu 2 -\fBport\fP \-\- minimum timeout +\fBport\fP – minimum timeout .UNINDENT .UNINDENT .UNINDENT @@ -10227,15 +10227,15 @@ create SECoP datasource .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBentryname\fP (\fI\%str\fP) \-\- secop entry name +\fBentryname\fP (\fI\%str\fP) – secop entry name .IP \(bu 2 -\fBsamplename\fP (\fI\%str\fP) \-\- secop sample name +\fBsamplename\fP (\fI\%str\fP) – secop sample name .IP \(bu 2 -\fBsampleenvname\fP (\fI\%str\fP) \-\- secop sample name +\fBsampleenvname\fP (\fI\%str\fP) – secop sample name .IP \(bu 2 -\fBmeanings\fP (\fI\%str\fP) \-\- secop meanings list +\fBmeanings\fP (\fI\%str\fP) – secop meanings list .IP \(bu 2 -\fBenvironments\fP (\fI\%str\fP) \-\- secop environments list +\fBenvironments\fP (\fI\%str\fP) – secop environments list .UNINDENT .UNINDENT .UNINDENT @@ -10271,11 +10271,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -10323,11 +10323,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fBoptparse.Values\fP) \-\- command options +\fBoptions\fP (\fBoptparse.Values\fP) – command options .IP \(bu 2 -\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) \-\- command arguments +\fBargs\fP (\fI\%list\fP < \fI\%str\fP >) – command arguments .IP \(bu 2 -\fBprintouts\fP (\fI\%bool\fP) \-\- if printout is enable +\fBprintouts\fP (\fI\%bool\fP) – if printout is enable .UNINDENT .UNINDENT .INDENT 7.0 @@ -10357,7 +10357,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -10381,7 +10381,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -10402,7 +10402,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -10426,7 +10426,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -10447,7 +10447,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBdevice\fP (\fI\%str\fP) \-\- device name of configuration server +\fBdevice\fP (\fI\%str\fP) – device name of configuration server .UNINDENT .INDENT 7.0 .TP @@ -10466,7 +10466,7 @@ opens an entry .INDENT 7.0 .TP .B Parameters -\fBxmlconfig\fP (\fI\%str\fP) \-\- xml configuration string +\fBxmlconfig\fP (\fI\%str\fP) – xml configuration string .UNINDENT .UNINDENT .INDENT 7.0 @@ -10476,7 +10476,7 @@ opens the h5 file .INDENT 7.0 .TP .B Parameters -\fBfilename\fP (\fI\%str\fP) \-\- h5 file name +\fBfilename\fP (\fI\%str\fP) – h5 file name .UNINDENT .UNINDENT .INDENT 7.0 @@ -10486,7 +10486,7 @@ records one step .INDENT 7.0 .TP .B Parameters -\fBjsondata\fP (\fI\%str\fP) \-\- step JSON data +\fBjsondata\fP (\fI\%str\fP) – step JSON data .UNINDENT .UNINDENT .INDENT 7.0 @@ -10496,7 +10496,7 @@ sets the global JSON data .INDENT 7.0 .TP .B Parameters -\fBjsondata\fP (\fI\%str\fP) \-\- global JSON data +\fBjsondata\fP (\fI\%str\fP) – global JSON data .UNINDENT .UNINDENT .INDENT 7.0 @@ -10516,7 +10516,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -10540,7 +10540,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -10561,7 +10561,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -10590,7 +10590,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -10611,7 +10611,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -10635,7 +10635,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -10656,7 +10656,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -10680,7 +10680,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -10701,7 +10701,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -10725,7 +10725,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -10759,7 +10759,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBpackagename\fP (\fI\%str\fP) \-\- full package name +\fBpackagename\fP (\fI\%str\fP) – full package name .UNINDENT .INDENT 7.0 .TP @@ -10768,7 +10768,7 @@ load xml template module variables .INDENT 7.0 .TP .B Parameters -\fBpackagename\fP (\fI\%str\fP) \-\- full package name +\fBpackagename\fP (\fI\%str\fP) – full package name .UNINDENT .UNINDENT .UNINDENT @@ -10779,7 +10779,7 @@ provides server device name if only one or error in the other case .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- server name +\fBname\fP (\fI\%str\fP) – server name .TP .B Returns server device name or empty string if error appears @@ -10800,7 +10800,7 @@ finds class name .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- device name +\fBname\fP (\fI\%str\fP) – device name .TP .B Returns class name @@ -10818,11 +10818,11 @@ generates device names .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBprefix\fP (\fI\%str\fP) \-\- device name prefix +\fBprefix\fP (\fI\%str\fP) – device name prefix .IP \(bu 2 -\fBfirst\fP (\fI\%int\fP) \-\- first device index +\fBfirst\fP (\fI\%int\fP) – first device index .IP \(bu 2 -\fBlast\fP (\fI\%int\fP) \-\- last device index +\fBlast\fP (\fI\%int\fP) – last device index .UNINDENT .TP .B Returns @@ -10841,11 +10841,11 @@ provides a list of device attributes .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdevice\fP (\fI\%str\fP) \-\- tango device name +\fBdevice\fP (\fI\%str\fP) – tango device name .IP \(bu 2 -\fBhost\fP (\fI\%str\fP) \-\- device host +\fBhost\fP (\fI\%str\fP) – device host .IP \(bu 2 -\fBport\fP (\fI\%int\fP) \-\- device port +\fBport\fP (\fI\%int\fP) – device port .UNINDENT .TP .B Returns @@ -10862,7 +10862,7 @@ provides device class name .INDENT 7.0 .TP .B Parameters -\fBdevicename\fP (\fI\%str\fP) \-\- device name +\fBdevicename\fP (\fI\%str\fP) – device name .TP .B Returns class name @@ -10880,9 +10880,9 @@ gets datasource components .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver\fP (\fI\%str\fP) \-\- configuration server +\fBserver\fP (\fI\%str\fP) – configuration server .IP \(bu 2 -\fBverbose\fP (\fI\%bool\fP) \-\- additional printouts +\fBverbose\fP (\fI\%bool\fP) – additional printouts .UNINDENT .TP .B Returns @@ -10899,7 +10899,7 @@ fetches the server tango_host:tango_port .INDENT 7.0 .TP .B Parameters -\fBserver\fP (\fI\%str\fP) \-\- tango server +\fBserver\fP (\fI\%str\fP) – tango server .TP .B Returns tango host @@ -10915,7 +10915,7 @@ provides server device names .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- server instance name +\fBname\fP (\fI\%str\fP) – server instance name .TP .B Returns list of the server device names @@ -10936,7 +10936,7 @@ finds server names .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- server instance name +\fBname\fP (\fI\%str\fP) – server instance name .TP .B Returns server list @@ -10974,7 +10974,7 @@ opens connection to the configuration server .INDENT 7.0 .TP .B Parameters -\fBconfiguration\fP (\fI\%str\fP) \-\- server device name +\fBconfiguration\fP (\fI\%str\fP) – server device name .TP .B Returns configuration server proxy @@ -11005,13 +11005,13 @@ stores components in Configuration Server .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- component name +\fBname\fP (\fI\%str\fP) – component name .IP \(bu 2 -\fBxml\fP (\fI\%str\fP) \-\- component xml string +\fBxml\fP (\fI\%str\fP) – component xml string .IP \(bu 2 -\fBserver\fP (\fI\%str\fP) \-\- configuration server +\fBserver\fP (\fI\%str\fP) – configuration server .IP \(bu 2 -\fBmandatory\fP (\fI\%bool\fP) \-\- set component as mandatory +\fBmandatory\fP (\fI\%bool\fP) – set component as mandatory .UNINDENT .UNINDENT .UNINDENT @@ -11024,11 +11024,11 @@ stores datasources in Configuration Server .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- datasource name +\fBname\fP (\fI\%str\fP) – datasource name .IP \(bu 2 -\fBxml\fP (\fI\%str\fP) \-\- datasource xml string +\fBxml\fP (\fI\%str\fP) – datasource xml string .IP \(bu 2 -\fBserver\fP (\fI\%str\fP) \-\- configuration server +\fBserver\fP (\fI\%str\fP) – configuration server .UNINDENT .UNINDENT .UNINDENT @@ -11061,7 +11061,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11090,7 +11090,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11105,7 +11105,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11129,7 +11129,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11144,7 +11144,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11168,7 +11168,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11183,7 +11183,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11207,7 +11207,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11222,7 +11222,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11246,7 +11246,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11267,13 +11267,13 @@ changes property name .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver\fP (\fI\%str\fP) \-\- server name +\fBserver\fP (\fI\%str\fP) – server name .IP \(bu 2 -\fBoldname\fP (\fI\%str\fP) \-\- old property name +\fBoldname\fP (\fI\%str\fP) – old property name .IP \(bu 2 -\fBnewname\fP (\fI\%str\fP) \-\- new property name +\fBnewname\fP (\fI\%str\fP) – new property name .IP \(bu 2 -\fBsclass\fP (\fI\%str\fP) \-\- server class name +\fBsclass\fP (\fI\%str\fP) – server class name .UNINDENT .TP .B Returns @@ -11292,13 +11292,13 @@ changes/sets property value .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver\fP (\fI\%str\fP) \-\- server name +\fBserver\fP (\fI\%str\fP) – server name .IP \(bu 2 -\fBnewvalue\fP (\fI\%str\fP) \-\- new property value +\fBnewvalue\fP (\fI\%str\fP) – new property value .IP \(bu 2 -\fBnewname\fP (\fI\%str\fP) \-\- new property name +\fBnewname\fP (\fI\%str\fP) – new property name .IP \(bu 2 -\fBsclass\fP (\fI\%str\fP) \-\- server class name +\fBsclass\fP (\fI\%str\fP) – server class name .UNINDENT .TP .B Returns @@ -11317,9 +11317,9 @@ adds a new recorder path .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpath\fP (\fI\%str\fP) \-\- new recorder path +\fBpath\fP (\fI\%str\fP) – new recorder path .IP \(bu 2 -\fBinstance\fP (\fI\%str\fP) \-\- MacroServer instance name +\fBinstance\fP (\fI\%str\fP) – MacroServer instance name .UNINDENT .TP .B Returns @@ -11338,15 +11338,15 @@ creates configuration server .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBbeamline\fP (\fI\%str\fP) \-\- beamline name +\fBbeamline\fP (\fI\%str\fP) – beamline name .IP \(bu 2 -\fBmasterhost\fP (\fI\%str\fP) \-\- master host of data writer +\fBmasterhost\fP (\fI\%str\fP) – master host of data writer .IP \(bu 2 -\fBjsonsettings\fP (\fI\%str\fP) \-\- connection settings to DB in json +\fBjsonsettings\fP (\fI\%str\fP) – connection settings to DB in json .IP \(bu 2 -\fBhostname\fP (\fI\%str\fP) \-\- host to run the config server +\fBhostname\fP (\fI\%str\fP) – host to run the config server .IP \(bu 2 -\fBpostpone\fP (\fI\%bool\fP) \-\- postpone starting flag +\fBpostpone\fP (\fI\%bool\fP) – postpone starting flag .UNINDENT .TP .B Returns @@ -11365,11 +11365,11 @@ creates data writer .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBbeamline\fP (\fI\%str\fP) \-\- beamline name +\fBbeamline\fP (\fI\%str\fP) – beamline name .IP \(bu 2 -\fBmasterhost\fP (\fI\%str\fP) \-\- master host of data writer +\fBmasterhost\fP (\fI\%str\fP) – master host of data writer .IP \(bu 2 -\fBpostpone\fP (\fI\%bool\fP) \-\- postpone starting flag +\fBpostpone\fP (\fI\%bool\fP) – postpone starting flag .UNINDENT .TP .B Returns @@ -11388,15 +11388,15 @@ creates selector server .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBbeamline\fP (\fI\%str\fP) \-\- beamline name +\fBbeamline\fP (\fI\%str\fP) – beamline name .IP \(bu 2 -\fBmasterhost\fP (\fI\%str\fP) \-\- master host of data writer +\fBmasterhost\fP (\fI\%str\fP) – master host of data writer .IP \(bu 2 -\fBwriter\fP (\fI\%str\fP) \-\- writer device name +\fBwriter\fP (\fI\%str\fP) – writer device name .IP \(bu 2 -\fBcserver\fP (\fI\%str\fP) \-\- configuration server device name +\fBcserver\fP (\fI\%str\fP) – configuration server device name .IP \(bu 2 -\fBpostpone\fP (\fI\%bool\fP) \-\- postpone starting flag +\fBpostpone\fP (\fI\%bool\fP) – postpone starting flag .UNINDENT .TP .B Returns @@ -11415,19 +11415,19 @@ creates tango server in DB .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver_name\fP (\fI\%str\fP) \-\- server name +\fBserver_name\fP (\fI\%str\fP) – server name .IP \(bu 2 -\fBbeamline\fP (\fI\%str\fP) \-\- beamline name +\fBbeamline\fP (\fI\%str\fP) – beamline name .IP \(bu 2 -\fBmasterhost\fP (\fI\%str\fP) \-\- master host of data writer +\fBmasterhost\fP (\fI\%str\fP) – master host of data writer .IP \(bu 2 -\fBhostname\fP (\fI\%str\fP) \-\- host to run the config server +\fBhostname\fP (\fI\%str\fP) – host to run the config server .IP \(bu 2 -\fBclass_name\fP \-\- class name +\fBclass_name\fP – class name .IP \(bu 2 -\fBjsondeviceproperties\fP (\fI\%str\fP) \-\- json device properties +\fBjsondeviceproperties\fP (\fI\%str\fP) – json device properties .IP \(bu 2 -\fBpostpone\fP (\fI\%bool\fP) \-\- postpone starting flag +\fBpostpone\fP (\fI\%bool\fP) – postpone starting flag .UNINDENT .TP .B Returns @@ -11454,7 +11454,7 @@ restarts server .INDENT 7.0 .TP .B Parameters -\fBhost\fP (\fI\%str\fP) \-\- server host name +\fBhost\fP (\fI\%str\fP) – server host name .TP .B Returns starter device name @@ -11476,19 +11476,19 @@ restarts server .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- server name +\fBname\fP (\fI\%str\fP) – server name .IP \(bu 2 -\fBhost\fP (\fI\%str\fP) \-\- server host name +\fBhost\fP (\fI\%str\fP) – server host name .IP \(bu 2 -\fBlevel\fP (\fI\%int\fP) \-\- start up level +\fBlevel\fP (\fI\%int\fP) – start up level .IP \(bu 2 -\fBrestart\fP (\fI\%bool\fP) \-\- if server should be restarted +\fBrestart\fP (\fI\%bool\fP) – if server should be restarted .IP \(bu 2 -\fBstopstart\fP (\fI\%bool\fP) \-\- if server should be stopped and started +\fBstopstart\fP (\fI\%bool\fP) – if server should be stopped and started .IP \(bu 2 -\fBwait\fP (\fI\%bool\fP) \-\- script should wait for the server +\fBwait\fP (\fI\%bool\fP) – script should wait for the server .IP \(bu 2 -\fBtimeout\fP (\fI\%float\fP) \-\- timeout for start +\fBtimeout\fP (\fI\%float\fP) – timeout for start .UNINDENT .UNINDENT .UNINDENT @@ -11501,9 +11501,9 @@ restarts server .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- server name +\fBname\fP (\fI\%str\fP) – server name .IP \(bu 2 -\fBhost\fP (\fI\%str\fP) \-\- server host name +\fBhost\fP (\fI\%str\fP) – server host name .UNINDENT .UNINDENT .UNINDENT @@ -11516,17 +11516,17 @@ wait until device is exported and server is running .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver\fP (\fI\%str\fP) \-\- server name, check if running when not None +\fBserver\fP (\fI\%str\fP) – server name, check if running when not None .IP \(bu 2 -\fBdevice\fP (\fI\%str\fP) \-\- device name, check if exported when not None +\fBdevice\fP (\fI\%str\fP) – device name, check if exported when not None .IP \(bu 2 -\fBadminproxy\fP (\fI\%tango.DeviceProxy\fP) \-\- Starter device proxy +\fBadminproxy\fP (\fI\%tango.DeviceProxy\fP) – Starter device proxy .IP \(bu 2 -\fBmaxcnt\fP (\fI\%int\fP) \-\- maximal waiting time in 10ms +\fBmaxcnt\fP (\fI\%int\fP) – maximal waiting time in 10ms .IP \(bu 2 -\fBverbose\fP (\fI\%bool\fP) \-\- verbose mode +\fBverbose\fP (\fI\%bool\fP) – verbose mode .IP \(bu 2 -\fBwaitforproc\fP \-\- wait for process list update +\fBwaitforproc\fP – wait for process list update .UNINDENT .TP .B Returns @@ -11545,17 +11545,17 @@ wait until device is exported and server is running .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver\fP (\fI\%str\fP) \-\- server name, check if running when not None +\fBserver\fP (\fI\%str\fP) – server name, check if running when not None .IP \(bu 2 -\fBdevice\fP (\fI\%str\fP) \-\- device name, check if exported when not None +\fBdevice\fP (\fI\%str\fP) – device name, check if exported when not None .IP \(bu 2 -\fBadminproxy\fP (\fI\%tango.DeviceProxy\fP) \-\- Starter device proxy +\fBadminproxy\fP (\fI\%tango.DeviceProxy\fP) – Starter device proxy .IP \(bu 2 -\fBmaxcnt\fP (\fI\%int\fP) \-\- maximal waiting time in 10ms +\fBmaxcnt\fP (\fI\%int\fP) – maximal waiting time in 10ms .IP \(bu 2 -\fBverbose\fP (\fI\%bool\fP) \-\- verbose mode +\fBverbose\fP (\fI\%bool\fP) – verbose mode .IP \(bu 2 -\fBwaitforproc\fP \-\- wait for process list update +\fBwaitforproc\fP – wait for process list update .UNINDENT .TP .B Returns @@ -11582,7 +11582,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11606,7 +11606,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11621,7 +11621,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11645,7 +11645,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11660,7 +11660,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11684,7 +11684,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -11713,7 +11713,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -11724,9 +11724,9 @@ get metadata from nexus and beamtime file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBroot\fP (\fBfilewriter.FTGroup\fP) \-\- nexus file root +\fBroot\fP (\fBfilewriter.FTGroup\fP) – nexus file root .IP \(bu 2 -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .TP .B Returns @@ -11763,7 +11763,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -11781,9 +11781,9 @@ the main function .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .IP \(bu 2 -\fBroot\fP (\fBfilewriter.FTGroup\fP) \-\- nexus file root +\fBroot\fP (\fBfilewriter.FTGroup\fP) – nexus file root .UNINDENT .UNINDENT .UNINDENT @@ -11797,7 +11797,7 @@ loader constructor .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .INDENT 7.0 .TP @@ -11808,13 +11808,13 @@ overwrite metadata with dictionary .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .IP \(bu 2 -\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) \-\- overwrite dictionary +\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) – overwrite dictionary .IP \(bu 2 -\fBclist\fP (\fI\%list\fP < [\fI\%str\fP, \fI\%str\fP] >) \-\- copy list to overwrite metadata +\fBclist\fP (\fI\%list\fP < [\fI\%str\fP, \fI\%str\fP] >) – copy list to overwrite metadata .IP \(bu 2 -\fBcmapfield\fP (\fI\%str\fP) \-\- copy map nexus field +\fBcmapfield\fP (\fI\%str\fP) – copy map nexus field .UNINDENT .TP .B Returns @@ -11857,9 +11857,9 @@ generate technique dictionary .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtechniques\fP (\fI\%list\fP <\fI\%str\fP>) \-\- a list of techniques splitted by comma +\fBtechniques\fP (\fI\%list\fP <\fI\%str\fP>) – a list of techniques splitted by comma .IP \(bu 2 -\fBtechniques_pids\fP (\fI\%list\fP <\fI\%str\fP>) \-\- a list of technique pids splitted by comma +\fBtechniques_pids\fP (\fI\%list\fP <\fI\%str\fP>) – a list of technique pids splitted by comma .UNINDENT .TP .B Returns @@ -11876,7 +11876,7 @@ update metadata with dictionary .INDENT 7.0 .TP .B Parameters -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .TP .B Returns metadata dictionary @@ -11892,7 +11892,7 @@ merge copy lists .INDENT 7.0 .TP .B Parameters -\fBclist\fP \-\- overwrite copy list +\fBclist\fP – overwrite copy list .TP .B Returns metadata dictionary @@ -11908,7 +11908,7 @@ merge copy maps .INDENT 7.0 .TP .B Parameters -\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) \-\- overwrite dictionary +\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) – overwrite dictionary .TP .B Returns metadata dictionary @@ -11919,7 +11919,7 @@ metadata dictionary .UNINDENT .INDENT 7.0 .TP -.B newbtmdmap = {\(aqcontactEmail\(aq: [\(aqpi.email\(aq, \(aqapplicant.email\(aq], \(aqdescription\(aq: [\(aqtitle\(aq], \(aqendTime\(aq: [\(aqeventEnd\(aq], \(aqowner\(aq: [\(aqleader.lastname\(aq, \(aqapplicant.lastname\(aq], \(aqownerEmail\(aq: [\(aqleader.email\(aq, \(aqapplicant.email\(aq], \(aqprincipalInvestigator\(aq: [\(aqapplicant.email\(aq], \(aqproposalId\(aq: [\(aqbeamtimeId\(aq], \(aqsourceFolder\(aq: [\(aqcorePath\(aq]} +.B newbtmdmap = {\(aqcontactEmail\(aq: [\(aqpi.email\(aq, \(aqapplicant.email\(aq], \(aqdescription\(aq: [\(aqtitle\(aq], \(aqendTime\(aq: [\(aqeventEnd\(aq], \(aqowner\(aq: [\(aqleader.lastname\(aq, \(aqapplicant.lastname\(aq], \(aqownerEmail\(aq: [\(aqleader.email\(aq, \(aqapplicant.email\(aq], \(aqprincipalInvestigator\(aq: [\(aqapplicant.email\(aq], \(aqsourceFolder\(aq: [\(aqcorePath\(aq]} .UNINDENT .INDENT 7.0 .TP @@ -11934,13 +11934,13 @@ overwrite metadata with dictionary .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .IP \(bu 2 -\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) \-\- copy map to overwrite dictionary +\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) – copy map to overwrite dictionary .IP \(bu 2 -\fBclist\fP (\fI\%list\fP < [\fI\%str\fP, \fI\%str\fP] >) \-\- copy list to overwrite metadata +\fBclist\fP (\fI\%list\fP < [\fI\%str\fP, \fI\%str\fP] >) – copy list to overwrite metadata .IP \(bu 2 -\fBcmapfield\fP (\fI\%str\fP) \-\- copy map nexus field +\fBcmapfield\fP (\fI\%str\fP) – copy map nexus field .UNINDENT .TP .B Returns @@ -11963,13 +11963,13 @@ in the copy map .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .IP \(bu 2 -\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) \-\- overwrite dictionary +\fBcmap\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) – overwrite dictionary .IP \(bu 2 -\fBclist\fP (\fI\%list\fP < [\fI\%str\fP, \fI\%str\fP] >) \-\- copy list to overwrite metadata +\fBclist\fP (\fI\%list\fP < [\fI\%str\fP, \fI\%str\fP] >) – copy list to overwrite metadata .IP \(bu 2 -\fBcmapfield\fP (\fI\%str\fP) \-\- copy map nexus field +\fBcmapfield\fP (\fI\%str\fP) – copy map nexus field .UNINDENT .TP .B Returns @@ -11986,7 +11986,7 @@ runner for DESY beamtime file parser .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns metadata dictionary @@ -11997,7 +11997,7 @@ metadata dictionary .UNINDENT .INDENT 7.0 .TP -.B strcre = {\(aqaccessGroups\(aq: [\(aq{beamtimeId}\-dmgt\(aq, \(aq{beamtimeId}\-clbt\(aq, \(aq{beamtimeId}\-part\(aq, \(aq{beamline}dmgt\(aq, \(aq{beamline}staff\(aq], \(aqcreationLocation\(aq: \(aq/DESY/{facility}/{beamlineAlias}\(aq, \(aqinstrumentId\(aq: \(aq/{facility}/{beamline}\(aq, \(aqisPublished\(aq: False, \(aqkeywords\(aq: [\(aqscan\(aq], \(aqownerGroup\(aq: \(aq{beamtimeId}\-dmgt\(aq, \(aqtype\(aq: \(aqraw\(aq} +.B strcre = {\(aqaccessGroups\(aq: [\(aq{beamtimeId}\-dmgt\(aq, \(aq{beamtimeId}\-clbt\(aq, \(aq{beamtimeId}\-part\(aq, \(aq{beamline}dmgt\(aq, \(aq{beamline}staff\(aq], \(aqcreationLocation\(aq: \(aq/DESY/{facility}/{beamlineAlias}\(aq, \(aqinstrumentId\(aq: \(aq/{facility}/{beamline}\(aq, \(aqisPublished\(aq: False, \(aqkeywords\(aq: [\(aqscan\(aq], \(aqownerGroup\(aq: \(aq{beamtimeId}\-dmgt\(aq, \(aqproposalId\(aq: \(aq{proposalId}.{beamtimeId}\(aq, \(aqtype\(aq: \(aqraw\(aq} .UNINDENT .INDENT 7.0 .TP @@ -12006,7 +12006,7 @@ update instrument id .INDENT 7.0 .TP .B Parameters -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .TP .B Returns metadata dictionary @@ -12024,13 +12024,13 @@ update pid metadata with dictionary .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- nexus filename +\fBfilename\fP (\fI\%str\fP) – nexus filename .IP \(bu 2 -\fBpuuid\fP (\fI\%bool\fP) \-\- pid with uuid +\fBpuuid\fP (\fI\%bool\fP) – pid with uuid .IP \(bu 2 -\fBpfname\fP (\fI\%bool\fP) \-\- pid with file name +\fBpfname\fP (\fI\%bool\fP) – pid with file name .UNINDENT .TP .B Returns @@ -12049,11 +12049,11 @@ update sampleid .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .IP \(bu 2 -\fBsampleid\fP (\fI\%str\fP) \-\- sample id +\fBsampleid\fP (\fI\%str\fP) – sample id .IP \(bu 2 -\fBsidfromname\fP (\fI\%bool\fP) \-\- sample id from its name +\fBsidfromname\fP (\fI\%bool\fP) – sample id from its name .UNINDENT .TP .B Returns @@ -12072,9 +12072,9 @@ update techniques .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- metadata dictionary to merge in +\fBmetadata\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – metadata dictionary to merge in .IP \(bu 2 -\fBtechniques\fP (\fI\%str\fP) \-\- a list of techniques splitted by comma +\fBtechniques\fP (\fI\%str\fP) – a list of techniques splitted by comma .UNINDENT .TP .B Returns @@ -12096,7 +12096,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -12125,7 +12125,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12143,9 +12143,9 @@ the main function .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .IP \(bu 2 -\fBroot\fP (class:\fIfilewriter.FTGroup\fP) \-\- nexus file root +\fBroot\fP (class:\fIfilewriter.FTGroup\fP) – nexus file root .UNINDENT .UNINDENT .UNINDENT @@ -12161,7 +12161,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -12187,9 +12187,9 @@ parse entry of nexus file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBentry\fP (\fBfilewriter.FTGroup\fP) \-\- nexus entry node +\fBentry\fP (\fBfilewriter.FTGroup\fP) – nexus entry node .IP \(bu 2 -\fBdescription\fP (\fI\%list\fP <\fI\%dict\fP <\fI\%str\fP, \fIany\fP > >) \-\- dict description list +\fBdescription\fP (\fI\%list\fP <\fI\%dict\fP <\fI\%str\fP, \fIany\fP > >) – dict description list .UNINDENT .TP .B Returns @@ -12211,7 +12211,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12227,7 +12227,7 @@ show general informations .INDENT 7.0 .TP .B Parameters -\fBroot\fP (class:\fIfilewriter.FTGroup\fP) \-\- nexus file root +\fBroot\fP (class:\fIfilewriter.FTGroup\fP) – nexus file root .UNINDENT .UNINDENT .UNINDENT @@ -12242,7 +12242,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -12282,7 +12282,7 @@ group scan metadata .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns [grouped metadata, @@ -12329,7 +12329,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12345,7 +12345,7 @@ the main function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .INDENT 7.0 @@ -12364,7 +12364,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -12388,7 +12388,7 @@ create instrument metadata .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12409,7 +12409,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12425,7 +12425,7 @@ the main function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -12440,7 +12440,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -12466,9 +12466,9 @@ get metadata from nexus and beamtime file .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBroot\fP (\fBfilewriter.FTGroup\fP) \-\- nexus file root +\fBroot\fP (\fBfilewriter.FTGroup\fP) – nexus file root .IP \(bu 2 -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .TP .B Returns @@ -12490,7 +12490,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12508,9 +12508,9 @@ the main function .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .IP \(bu 2 -\fBroot\fP (\fBfilewriter.FTGroup\fP) \-\- nexus file root +\fBroot\fP (\fBfilewriter.FTGroup\fP) – nexus file root .UNINDENT .UNINDENT .UNINDENT @@ -12526,7 +12526,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -12540,7 +12540,7 @@ dump scan datablock JSON .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12592,7 +12592,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12608,7 +12608,7 @@ the main function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -12623,7 +12623,7 @@ parser creator .INDENT 7.0 .TP .B Parameters -\fBparser\fP (\fBNXSFileInfoArgParser\fP) \-\- option parser +\fBparser\fP (\fBNXSFileInfoArgParser\fP) – option parser .UNINDENT .INDENT 7.0 .TP @@ -12652,7 +12652,7 @@ the main program function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12668,7 +12668,7 @@ create sample metadata .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .TP .B Returns output information @@ -12684,7 +12684,7 @@ the main function .INDENT 7.0 .TP .B Parameters -\fBoptions\fP (\fI\%argparse.Namespace\fP) \-\- parser options +\fBoptions\fP (\fI\%argparse.Namespace\fP) – parser options .UNINDENT .UNINDENT .UNINDENT @@ -12699,7 +12699,7 @@ with respect to newline and space characters .INDENT 7.0 .TP .B Parameters -\fBtext\fP (\fI\%str\fP) \-\- parser options +\fBtext\fP (\fI\%str\fP) – parser options .TP .B Returns a list of list @@ -12722,9 +12722,9 @@ split text to lines .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtext\fP (\fI\%str\fP) \-\- parser options +\fBtext\fP (\fI\%str\fP) – parser options .IP \(bu 2 -\fBlmax\fP (\fI\%int\fP) \-\- maximal line length +\fBlmax\fP (\fI\%int\fP) – maximal line length .UNINDENT .TP .B Returns @@ -12748,7 +12748,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBroot\fP (\fI\%str\fP) \-\- fio file content +\fBroot\fP (\fI\%str\fP) – fio file content .UNINDENT .INDENT 7.0 .TP @@ -12777,7 +12777,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBroot\fP (\fBfilewriter.FTGroup\fP) \-\- nexus root node +\fBroot\fP (\fBfilewriter.FTGroup\fP) – nexus root node .UNINDENT .INDENT 7.0 .TP @@ -12796,7 +12796,7 @@ converts full_path with NX_classes into nexus_path .INDENT 7.0 .TP .B Parameters -\fBpath\fP (\fI\%str\fP) \-\- nexus full_path +\fBpath\fP (\fI\%str\fP) – nexus full_path .UNINDENT .UNINDENT .INDENT 7.0 @@ -12832,7 +12832,7 @@ provides datasource name from datasource xml string .INDENT 7.0 .TP .B Parameters -\fBxmlstring\fP (\fI\%str\fP) \-\- datasource xml string +\fBxmlstring\fP (\fI\%str\fP) – datasource xml string .UNINDENT .UNINDENT .INDENT 0.0 @@ -12842,7 +12842,7 @@ provides source from datasource xml string .INDENT 7.0 .TP .B Parameters -\fBxmlstring\fP (\fI\%str\fP) \-\- datasource xml string +\fBxmlstring\fP (\fI\%str\fP) – datasource xml string .UNINDENT .UNINDENT .INDENT 0.0 @@ -12852,7 +12852,7 @@ provides datasource type from datasource xml string .INDENT 7.0 .TP .B Parameters -\fBxmlstring\fP (\fI\%str\fP) \-\- datasource xml string +\fBxmlstring\fP (\fI\%str\fP) – datasource xml string .UNINDENT .UNINDENT .INDENT 0.0 @@ -12867,7 +12867,7 @@ convert date to iso format .INDENT 7.0 .TP .B Parameters -\fBtext\fP (\fI\%str\fP) \-\- date text to convert +\fBtext\fP (\fI\%str\fP) – date text to convert .TP .B Returns date in iso format @@ -12913,12 +12913,12 @@ indent level. An indent level of 0 will only insert newlines. None is the most compact representation. .sp If specified, separators should be an (item_separator, key_separator) -tuple. The default is (\(aq, \(aq, \(aq: \(aq) if \fIindent\fP is \fBNone\fP and -(\(aq,\(aq, \(aq: \(aq) otherwise. To get the most compact JSON representation, -you should specify (\(aq,\(aq, \(aq:\(aq) to eliminate whitespace. +tuple. The default is (’, ‘, ‘: ‘) if \fIindent\fP is \fBNone\fP and +(‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, +you should specify (‘,’, ‘:’) to eliminate whitespace. .sp If specified, default is a function that gets called for objects -that can\(aqt otherwise be serialized. It should return a JSON encodable +that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a \fBTypeError\fP\&. .INDENT 7.0 .TP @@ -12927,7 +12927,7 @@ default encoder .INDENT 7.0 .TP .B Parameters -\fBobj\fP (\fI\%object\fP or \fIany\fP) \-\- numpy array object +\fBobj\fP (\fI\%object\fP or \fIany\fP) – numpy array object .UNINDENT .UNINDENT .UNINDENT @@ -12968,12 +12968,12 @@ indent level. An indent level of 0 will only insert newlines. None is the most compact representation. .sp If specified, separators should be an (item_separator, key_separator) -tuple. The default is (\(aq, \(aq, \(aq: \(aq) if \fIindent\fP is \fBNone\fP and -(\(aq,\(aq, \(aq: \(aq) otherwise. To get the most compact JSON representation, -you should specify (\(aq,\(aq, \(aq:\(aq) to eliminate whitespace. +tuple. The default is (’, ‘, ‘: ‘) if \fIindent\fP is \fBNone\fP and +(‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, +you should specify (‘,’, ‘:’) to eliminate whitespace. .sp If specified, default is a function that gets called for objects -that can\(aqt otherwise be serialized. It should return a JSON encodable +that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a \fBTypeError\fP\&. .INDENT 7.0 .TP @@ -13007,7 +13007,7 @@ converts ESRF xml configuration to nxsdatawriter format .INDENT 7.0 .TP .B Parameters -\fBtext\fP (\fI\%str\fP) \-\- input xml string +\fBtext\fP (\fI\%str\fP) – input xml string .TP .B Returns output xml string @@ -13030,7 +13030,7 @@ fetches record name or query from datasource node .INDENT 7.0 .TP .B Parameters -\fBnode\fP (\fBlxml.etree.Element\fP) \-\- datasource node +\fBnode\fP (\fBlxml.etree.Element\fP) – datasource node .TP .B Returns record name or query @@ -13050,7 +13050,7 @@ to one output xml string .INDENT 7.0 .TP .B Parameters -\fBxmls\fP (\fI\%list\fP <\fI\%str\fP>) \-\- a list of xml string with definitions +\fBxmls\fP (\fI\%list\fP <\fI\%str\fP>) – a list of xml string with definitions .TP .B Returns one output xml string @@ -13066,7 +13066,7 @@ provides datasources and its records from xml string .INDENT 7.0 .TP .B Parameters -\fBxmlc\fP (\fI\%str\fP) \-\- xml string +\fBxmlc\fP (\fI\%str\fP) – xml string .TP .B Returns list of datasource descriptions @@ -13082,7 +13082,7 @@ provides datasources and its records from xml string .INDENT 7.0 .TP .B Parameters -\fBxmlc\fP (\fI\%str\fP) \-\- xml string +\fBxmlc\fP (\fI\%str\fP) – xml string .TP .B Returns list of datasource descriptions @@ -13098,7 +13098,7 @@ provides datasources and its records from xml string .INDENT 7.0 .TP .B Parameters -\fBxmlc\fP (\fI\%str\fP) \-\- xml string +\fBxmlc\fP (\fI\%str\fP) – xml string .TP .B Returns list of datasource descriptions @@ -13114,7 +13114,7 @@ provides datasources and its records from xml string .INDENT 7.0 .TP .B Parameters -\fBxmlc\fP (\fI\%str\fP) \-\- xml string +\fBxmlc\fP (\fI\%str\fP) – xml string .TP .B Returns list of datasource descriptions @@ -13130,7 +13130,7 @@ provides source record from xml string .INDENT 7.0 .TP .B Parameters -\fBxmlc\fP (\fI\%str\fP) \-\- xml string +\fBxmlc\fP (\fI\%str\fP) – xml string .TP .B Returns source record @@ -13153,9 +13153,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdescription\fP (\fI\%list\fP <\fI\%str\fP>) \-\- description list +\fBdescription\fP (\fI\%list\fP <\fI\%str\fP>) – description list .IP \(bu 2 -\fBnonone\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of parameters which have to exist to be shown +\fBnonone\fP (\fI\%list\fP <\fI\%str\fP>) – list of parameters which have to exist to be shown .UNINDENT .UNINDENT .INDENT 7.0 @@ -13196,13 +13196,13 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdescription\fP (\fI\%list\fP <\fI\%str\fP>) \-\- description list +\fBdescription\fP (\fI\%list\fP <\fI\%str\fP>) – description list .IP \(bu 2 -\fBnonone\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of parameters which have to exist to be shown +\fBnonone\fP (\fI\%list\fP <\fI\%str\fP>) – list of parameters which have to exist to be shown .IP \(bu 2 -\fBheaders\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of output parameters +\fBheaders\fP (\fI\%list\fP <\fI\%str\fP>) – list of output parameters .IP \(bu 2 -\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) \-\- filters for first column names +\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) – filters for first column names .UNINDENT .UNINDENT .INDENT 7.0 @@ -13235,7 +13235,7 @@ loads description .INDENT 7.0 .TP .B Parameters -\fBdescription\fP (\fI\%list\fP <\fI\%str\fP>) \-\- description list +\fBdescription\fP (\fI\%list\fP <\fI\%str\fP>) – description list .UNINDENT .UNINDENT .INDENT 7.0 @@ -13260,11 +13260,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBnameAttr\fP (\fI\%str\fP) \-\- name attribute +\fBnameAttr\fP (\fI\%str\fP) – name attribute .IP \(bu 2 -\fBtypeAttr\fP (\fI\%str\fP) \-\- type attribute +\fBtypeAttr\fP (\fI\%str\fP) – type attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -13276,14 +13276,14 @@ sets the attribute strategy .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmode\fP (\fI\%str\fP) \-\- mode data writing, i.e. INIT, STEP, FINAL, POSTRUN +\fBmode\fP (\fI\%str\fP) – mode data writing, i.e. INIT, STEP, FINAL, POSTRUN .IP \(bu 2 -\fBtrigger\fP (\fI\%str\fP) \-\- for asynchronous writting, +\fBtrigger\fP (\fI\%str\fP) – for asynchronous writting, e.g. with different subentries .IP \(bu 2 -\fBvalue\fP (\fI\%str\fP) \-\- label for postrun mode +\fBvalue\fP (\fI\%str\fP) – label for postrun mode .IP \(bu 2 -\fBcanfail\fP (\fI\%bool\fP) \-\- can fail strategy flag +\fBcanfail\fP (\fI\%bool\fP) – can fail strategy flag .UNINDENT .UNINDENT .UNINDENT @@ -13299,7 +13299,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .UNINDENT .INDENT 7.0 .TP @@ -13308,7 +13308,7 @@ adds doc tag content .INDENT 7.0 .TP .B Parameters -\fBdoc\fP (\fI\%str\fP) \-\- doc tag content +\fBdoc\fP (\fI\%str\fP) – doc tag content .UNINDENT .UNINDENT .INDENT 7.0 @@ -13320,9 +13320,9 @@ sets paramters for Client data .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- name of datasource +\fBname\fP (\fI\%str\fP) – name of datasource .IP \(bu 2 -\fBrecordName\fP (\fI\%str\fP) \-\- name of the data object +\fBrecordName\fP (\fI\%str\fP) – name of the data object .UNINDENT .UNINDENT .UNINDENT @@ -13335,29 +13335,29 @@ sets parameters of DataBase .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- name of datasource +\fBname\fP (\fI\%str\fP) – name of datasource .IP \(bu 2 -\fBdbname\fP (\fI\%str\fP) \-\- name of used DataBase +\fBdbname\fP (\fI\%str\fP) – name of used DataBase .IP \(bu 2 -\fBquery\fP (\fI\%str\fP) \-\- database query +\fBquery\fP (\fI\%str\fP) – database query .IP \(bu 2 -\fBdbtype\fP (\fI\%str\fP) \-\- type of the database, i.e. MYSQL, PGSQL, ORACLE +\fBdbtype\fP (\fI\%str\fP) – type of the database, i.e. MYSQL, PGSQL, ORACLE .IP \(bu 2 -\fBrank\fP (\fI\%str\fP) \-\- rank of the query output, i.e. SCALAR, SPECTRUM, IMAGE +\fBrank\fP (\fI\%str\fP) – rank of the query output, i.e. SCALAR, SPECTRUM, IMAGE .IP \(bu 2 -\fBmycnf\fP (\fI\%str\fP) \-\- MYSQL config file +\fBmycnf\fP (\fI\%str\fP) – MYSQL config file .IP \(bu 2 -\fBuser\fP (\fI\%str\fP) \-\- database user name +\fBuser\fP (\fI\%str\fP) – database user name .IP \(bu 2 -\fBpasswd\fP (\fI\%str\fP) \-\- database user password +\fBpasswd\fP (\fI\%str\fP) – database user password .IP \(bu 2 -\fBdsn\fP (\fI\%str\fP) \-\- DSN string to initialize ORACLE and PGSQL databases +\fBdsn\fP (\fI\%str\fP) – DSN string to initialize ORACLE and PGSQL databases .IP \(bu 2 -\fBmode\fP (\fI\%str\fP) \-\- mode for ORACLE databases, i.e. SYSDBA or SYSOPER +\fBmode\fP (\fI\%str\fP) – mode for ORACLE databases, i.e. SYSDBA or SYSOPER .IP \(bu 2 -\fBhost\fP (\fI\%str\fP) \-\- name of the host +\fBhost\fP (\fI\%str\fP) – name of the host .IP \(bu 2 -\fBport\fP (\fI\%str\fP) \-\- port number +\fBport\fP (\fI\%str\fP) – port number .UNINDENT .UNINDENT .UNINDENT @@ -13370,20 +13370,20 @@ sets paramters for Tango device .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- name of datasource +\fBname\fP (\fI\%str\fP) – name of datasource .IP \(bu 2 -\fBdevice\fP (\fI\%str\fP) \-\- device name +\fBdevice\fP (\fI\%str\fP) – device name .IP \(bu 2 -\fBmemberType\fP (\fI\%str\fP) \-\- type of the data object, i.e. attribute, +\fBmemberType\fP (\fI\%str\fP) – type of the data object, i.e. attribute, property, command .IP \(bu 2 -\fBrecordName\fP (\fI\%str\fP) \-\- name of the data object +\fBrecordName\fP (\fI\%str\fP) – name of the data object .IP \(bu 2 -\fBhost\fP (\fI\%str\fP) \-\- host name +\fBhost\fP (\fI\%str\fP) – host name .IP \(bu 2 -\fBport\fP (\fI\%str\fP) \-\- port +\fBport\fP (\fI\%str\fP) – port .IP \(bu 2 -\fBencoding\fP (\fI\%str\fP) \-\- encoding of DevEncoded data +\fBencoding\fP (\fI\%str\fP) – encoding of DevEncoded data .UNINDENT .UNINDENT .UNINDENT @@ -13401,17 +13401,17 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBdeviceName\fP (\fI\%str\fP) \-\- tango device name +\fBdeviceName\fP (\fI\%str\fP) – tango device name .IP \(bu 2 -\fBnameAttr\fP (\fI\%str\fP) \-\- name attribute +\fBnameAttr\fP (\fI\%str\fP) – name attribute .IP \(bu 2 -\fBtypeAttr\fP (\fI\%str\fP) \-\- type attribute +\fBtypeAttr\fP (\fI\%str\fP) – type attribute .IP \(bu 2 -\fBcommands\fP (\fI\%bool\fP) \-\- if we call the commands +\fBcommands\fP (\fI\%bool\fP) – if we call the commands .IP \(bu 2 -\fBblackAttrs\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of excluded attributes +\fBblackAttrs\fP (\fI\%list\fP <\fI\%str\fP>) – list of excluded attributes .UNINDENT .UNINDENT .INDENT 7.0 @@ -13438,11 +13438,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBindexAttr\fP (\fI\%str\fP) \-\- index attribute +\fBindexAttr\fP (\fI\%str\fP) – index attribute .IP \(bu 2 -\fBvalueAttr\fP (\fI\%str\fP) \-\- value attribute +\fBvalueAttr\fP (\fI\%str\fP) – value attribute .UNINDENT .UNINDENT .UNINDENT @@ -13459,9 +13459,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBrankAttr\fP (\fI\%str\fP) \-\- rank attribute +\fBrankAttr\fP (\fI\%str\fP) – rank attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -13473,9 +13473,9 @@ adds dim tag .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBindexAttr\fP (\fI\%str\fP) \-\- index attribute +\fBindexAttr\fP (\fI\%str\fP) – index attribute .IP \(bu 2 -\fBvalueAttr\fP (\fI\%str\fP) \-\- value attribute +\fBvalueAttr\fP (\fI\%str\fP) – value attribute .UNINDENT .UNINDENT .UNINDENT @@ -13499,11 +13499,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBnameAttr\fP (\fI\%str\fP) \-\- name attribute +\fBnameAttr\fP (\fI\%str\fP) – name attribute .IP \(bu 2 -\fBtypeAttr\fP (\fI\%str\fP) \-\- type attribute +\fBtypeAttr\fP (\fI\%str\fP) – type attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -13515,11 +13515,11 @@ adds attribute tag .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBattrName\fP (\fI\%str\fP) \-\- name attribute +\fBattrName\fP (\fI\%str\fP) – name attribute .IP \(bu 2 -\fBattrType\fP (\fI\%str\fP) \-\- type attribute +\fBattrType\fP (\fI\%str\fP) – type attribute .IP \(bu 2 -\fBattrValue\fP (\fI\%str\fP) \-\- content of the attribute tag +\fBattrValue\fP (\fI\%str\fP) – content of the attribute tag .UNINDENT .UNINDENT .UNINDENT @@ -13530,7 +13530,7 @@ adds doc tag content .INDENT 7.0 .TP .B Parameters -\fBdoc\fP (\fI\%str\fP) \-\- doc tag content +\fBdoc\fP (\fI\%str\fP) – doc tag content .UNINDENT .UNINDENT .INDENT 7.0 @@ -13542,22 +13542,22 @@ sets the field strategy .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmode\fP (\fI\%str\fP) \-\- mode data writing, i.e. INIT, STEP, FINAL, POSTRUN +\fBmode\fP (\fI\%str\fP) – mode data writing, i.e. INIT, STEP, FINAL, POSTRUN .IP \(bu 2 -\fBtrigger\fP (\fI\%str\fP) \-\- for asynchronous writting, +\fBtrigger\fP (\fI\%str\fP) – for asynchronous writting, e.g. with different subentries .IP \(bu 2 -\fBvalue\fP (\fI\%str\fP) \-\- label for postrun mode +\fBvalue\fP (\fI\%str\fP) – label for postrun mode .IP \(bu 2 -\fBgrows\fP (\fI\%str\fP) \-\- growing dimension +\fBgrows\fP (\fI\%str\fP) – growing dimension .IP \(bu 2 -\fBcompression\fP (\fI\%str\fP) \-\- flag if compression shuold be applied +\fBcompression\fP (\fI\%str\fP) – flag if compression shuold be applied .IP \(bu 2 -\fBrate\fP (\fI\%str\fP) \-\- compression rate +\fBrate\fP (\fI\%str\fP) – compression rate .IP \(bu 2 -\fBshuffle\fP (\fI\%str\fP) \-\- flag if compression shuffle +\fBshuffle\fP (\fI\%str\fP) – flag if compression shuffle .IP \(bu 2 -\fBcanfail\fP (\fI\%bool\fP) \-\- can fail strategy flag +\fBcanfail\fP (\fI\%bool\fP) – can fail strategy flag .UNINDENT .UNINDENT .UNINDENT @@ -13568,7 +13568,7 @@ sets the field unit .INDENT 7.0 .TP .B Parameters -\fBunitsAttr\fP (\fI\%str\fP) \-\- the field unit +\fBunitsAttr\fP (\fI\%str\fP) – the field unit .UNINDENT .UNINDENT .UNINDENT @@ -13585,11 +13585,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBnameAttr\fP (\fI\%str\fP) \-\- name attribute +\fBnameAttr\fP (\fI\%str\fP) – name attribute .IP \(bu 2 -\fBtypeAttr\fP (\fI\%str\fP) \-\- type attribute +\fBtypeAttr\fP (\fI\%str\fP) – type attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -13601,11 +13601,11 @@ adds attribute: tag .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBattrName\fP (\fI\%str\fP) \-\- name attribute +\fBattrName\fP (\fI\%str\fP) – name attribute .IP \(bu 2 -\fBattrType\fP (\fI\%str\fP) \-\- type attribute +\fBattrType\fP (\fI\%str\fP) – type attribute .IP \(bu 2 -\fBattrValue\fP (\fI\%str\fP) \-\- content of the attribute tag +\fBattrValue\fP (\fI\%str\fP) – content of the attribute tag .UNINDENT .UNINDENT .UNINDENT @@ -13616,7 +13616,7 @@ adds doc tag content .INDENT 7.0 .TP .B Parameters -\fBdoc\fP (\fI\%str\fP) \-\- doc tag content +\fBdoc\fP (\fI\%str\fP) – doc tag content .UNINDENT .UNINDENT .UNINDENT @@ -13633,11 +13633,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBnameAttr\fP (\fI\%str\fP) \-\- name attribute +\fBnameAttr\fP (\fI\%str\fP) – name attribute .IP \(bu 2 -\fBgTarget\fP (\fI\%str\fP) \-\- target attribute +\fBgTarget\fP (\fI\%str\fP) – target attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -13647,7 +13647,7 @@ adds doc tag content .INDENT 7.0 .TP .B Parameters -\fBdoc\fP (\fI\%str\fP) \-\- doc tag content +\fBdoc\fP (\fI\%str\fP) – doc tag content .UNINDENT .UNINDENT .UNINDENT @@ -13664,13 +13664,13 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBparent\fP (\fI\%NTag\fP) \-\- parent tag element +\fBparent\fP (\fI\%NTag\fP) – parent tag element .IP \(bu 2 -\fBtagName\fP (\fI\%str\fP) \-\- tag name +\fBtagName\fP (\fI\%str\fP) – tag name .IP \(bu 2 -\fBnameAttr\fP (\fI\%str\fP) \-\- value of name attribute +\fBnameAttr\fP (\fI\%str\fP) – value of name attribute .IP \(bu 2 -\fBtypeAttr\fP (\fI\%str\fP) \-\- value of type attribute +\fBtypeAttr\fP (\fI\%str\fP) – value of type attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -13682,9 +13682,9 @@ adds tag attribute .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- attribute name +\fBname\fP (\fI\%str\fP) – attribute name .IP \(bu 2 -\fBvalue\fP (\fI\%str\fP) \-\- attribute value +\fBvalue\fP (\fI\%str\fP) – attribute value .UNINDENT .UNINDENT .UNINDENT @@ -13695,7 +13695,7 @@ adds tag content .INDENT 7.0 .TP .B Parameters -\fBtext\fP (\fI\%str\fP) \-\- tag content +\fBtext\fP (\fI\%str\fP) – tag content .UNINDENT .UNINDENT .INDENT 7.0 @@ -13710,7 +13710,7 @@ sets tag content .INDENT 7.0 .TP .B Parameters -\fBtext\fP (\fI\%str\fP) \-\- tag content +\fBtext\fP (\fI\%str\fP) – tag content .UNINDENT .UNINDENT .UNINDENT @@ -13725,7 +13725,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBfname\fP (\fI\%str\fP) \-\- XML file name +\fBfname\fP (\fI\%str\fP) – XML file name .UNINDENT .INDENT 7.0 .TP @@ -13754,7 +13754,7 @@ prints pretty XML making use of etree .INDENT 7.0 .TP .B Parameters -\fBetNode\fP (\fBlxml.etree.Element\fP) \-\- node +\fBetNode\fP (\fBlxml.etree.Element\fP) – node .UNINDENT .UNINDENT .INDENT 7.0 @@ -13766,9 +13766,9 @@ sets tag content .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) \-\- component dependencies +\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) – component dependencies .IP \(bu 2 -\fBentry\fP (\fBlxml.etree.Element\fP) \-\- entry node +\fBentry\fP (\fBlxml.etree.Element\fP) – entry node .UNINDENT .UNINDENT .UNINDENT diff --git a/nxstools/nxsfileinfo.py b/nxstools/nxsfileinfo.py index ba80adc4..adf04523 100644 --- a/nxstools/nxsfileinfo.py +++ b/nxstools/nxsfileinfo.py @@ -391,7 +391,7 @@ class BeamtimeLoader(object): # "createdAt": ["generated"], # ?? should be automatic # "updatedAt": ["generated"], # ?? should be automatic # "proposalId": "proposalId", - "proposalId": ["beamtimeId"], + # "proposalId": ["beamtimeId"], } oldbtmdmap = { @@ -405,6 +405,7 @@ class BeamtimeLoader(object): "type": "raw", "keywords": ["scan"], "isPublished": False, + "proposalId": "{proposalId}.{beamtimeId}", "ownerGroup": "{beamtimeId}-dmgt", "accessGroups": ["{beamtimeId}-dmgt", "{beamtimeId}-clbt", @@ -481,6 +482,9 @@ def __init__(self, options): self.btmdmap.update(self.oldbtmdmap) self.__pid = options.pid self.__pap = options.pap + self.__idformat = "" + if hasattr(options, "idformat") and options.idformat: + self.__idformat = options.idformat self.__relpath = options.relpath self.__ownergroup = options.ownergroup self.__accessgroups = None @@ -546,7 +550,10 @@ def run(self): break if not found: print("%s cannot be found" % ds) - for sc, vl in self.strcre.items(): + strcre2 = dict(self.strcre) + if self.__idformat: + strcre2["proposalId"] = self.__idformat + for sc, vl in strcre2.items(): if isinstance(vl, list): self.__metadata[sc] = [ (vv.format(**self.__btmeta) @@ -1190,6 +1197,12 @@ def create(self): self._parser.add_argument( "-i", "--beamtimeid", dest="beamtimeid", help=("beamtime id")) + self._parser.add_argument( + "--id-format", dest="idformat", + default="{beamtimeId}", + # default="{proposalId}.{beamtimeId}", + help=("format of scicat proposal id. " + "Default is {beamtimeId}")) self._parser.add_argument( "-u", "--pid-with-uuid", action="store_true", default=False, dest="puuid", diff --git a/nxstools/release.py b/nxstools/release.py index cc9683ad..5d8d58b7 100644 --- a/nxstools/release.py +++ b/nxstools/release.py @@ -19,4 +19,4 @@ """ NXS tools release version""" #: (:obj:`str`) package version -__version__ = "4.6.2" +__version__ = "4.7.0" diff --git a/test/NXSFileInfo_test.py b/test/NXSFileInfo_test.py index 7d68b063..22e93e58 100644 --- a/test/NXSFileInfo_test.py +++ b/test/NXSFileInfo_test.py @@ -8776,16 +8776,20 @@ def test_beamtime_commission(self): commands = [ ('nxsfileinfo metadata -k4 %s -b %s -s %s -o %s -u' + ' --id-format {proposalId}.{beamtimeId} ' % (self.flags, btfname, smfname, ofname)).split(), ('nxsfileinfo metadata -k4 %s ' ' --beamtime-meta %s ' + ' --id-format {proposalId}.{beamtimeId} ' ' --scientific-meta %s ' ' --output %s ' % (self.flags, btfname, smfname, ofname)).split(), ('nxsfileinfo metadata -k4 %s -b %s -s %s -o %s' + ' --id-format {proposalId}.{beamtimeId} ' ' --pid-with-uuid' % (self.flags, btfname, smfname, ofname)).split(), ('nxsfileinfo metadata -k4 %s ' + ' --id-format {proposalId}.{beamtimeId} ' ' --beamtime-meta %s ' ' --scientific-meta %s ' ' --output %s ' @@ -8839,7 +8843,7 @@ def test_beamtime_commission(self): 'p01dmgt', 'p01staff'], "ownerEmail": "cute.cute@cute.com", "principalInvestigator": "cute.cute@cute.com", - "proposalId": "16171271", + "proposalId": "65300407.16171271", "scientificMetadata": { "beamtimeId": "16171271", "DOOR_proposalId": "65300407",