sardananxsrecorder package

Submodules

sardananxsrecorder.nxsrecorder module

This is the macro server scan data NeXus recorder module

class sardananxsrecorder.nxsrecorder.NXS_FileRecorder(filename=None, macro=None, **pars)

Bases: sardana.macroserver.scan.recorder.storage.BaseFileRecorder

This recorder saves data to a NeXus file making use of NexDaTaS Writer

constructor

Parameters

• filename (str) – ScanFile name

• macro (sardana.macroserver.macro.Macro) – macro object

_addCustomData(value, name, group='data', remove=False, **kwargs)

adds custom data to configuration variables, i.e. from macros

Parameters

• value (any) – variable value

• name (str) – variable name

• group (str) – variable group inside variable dictionary

• remove (bool) – if True variable will be removed

_endRecordList(recordlist)

ends record process: records in FINAL mode

and closes the nexus file

Parameters

recordlist (sardana.macroserver.scan.scandata.RecordList) – sardana record list

_startRecordList(recordlist)

starts record process: creates configuration

and records in INIT mode

Parameters

recordlist (sardana.macroserver.scan.scandata.RecordList) – sardana record list

_writeRecord(record)

performs record process step: creates configuration

and records in INIT mode

Parameters

record (sardana.macroserver.scan.scandata.Record) – sardana record list

formats = {'h5': '.h5', 'ndf': '.ndf', 'nx': '.nx', 'nxs': '.nxs'}

(dict <str, str > ) recoder format

getFormat()

provides the output file format

Returns

the output file format

Return type

str

class numpyEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: json.encoder.JSONEncoder

numpy json encoder with list

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (‘, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.

default(obj)

default encoder

Parameters

obj (object or any) – numpy array object

Module contents

Sardana Scan Recorders