MCPcopy Create free account
hub / github.com/NSLS2/PyXRF / set_optional_parameters

Method set_optional_parameters

pyxrf/core/quant_analysis.py:1007–1030  ·  view source on GitHub ↗

r""" Set optional parameters in the existing dictionary with quantitative fluorescence data. The parameters include: source_scan_id (if provided), source_scan_uid (if provided), and creation time (local time). The function modifies the dictionary ``quant_fluor_data_dict``

(self, *, scan_id=None, scan_uid=None)

Source from the content-addressed store, hash-verified

1005 self.fluorescence_data_dict["distance_to_sample"] = distance_to_sample
1006
1007 def set_optional_parameters(self, *, scan_id=None, scan_uid=None):
1008 r"""
1009 Set optional parameters in the existing dictionary with quantitative fluorescence data.
1010 The parameters include: source_scan_id (if provided), source_scan_uid (if provided),
1011 and creation time (local time). The function modifies the dictionary ``quant_fluor_data_dict``
1012
1013 Parameters
1014 ----------
1015
1016 quant_fluor_data_dict: dict
1017
1018 Dictionary with XRF reference sample data. This dictionary is modified by the function.
1019 The dictionary must satisfy the '_xrf_quant_fluor_schema' schema.
1020
1021 scan_id: int or str
1022 Scan ID, must be positive int or a string representing int. If None, then the current
1023 value of Scan ID is not changed.
1024
1025 scan_uid: str
1026 Scan UID. UID has defined format, but it is not checked by the function, so it may
1027 be any string. If None, then the current value of Scan UID is not changed.
1028 """
1029
1030 set_quant_fluor_data_dict_optional(self.fluorescence_data_dict, scan_id=scan_id, scan_uid=scan_uid)
1031
1032 def get_suggested_json_fln(self):
1033 r"""

Calls 1

Tested by 2