blissoda.bm23.xrpd_processor.BM23XrpdProcessor#

class blissoda.bm23.xrpd_processor.BM23XrpdProcessor(config=None, defaults=None, **deprecated_defaults)[source]#

Bases: XrpdProcessor

Parameters:

  • config (Optional[Dict[str, Any]])

  • defaults (Optional[Dict[str, Any]])

  • deprecated_defaults (Dict[str, Any])

CONFIG_MODEL_CLASS#

alias of BlissAutomationConfig

DEFAULT_LIMA_URL_TEMPLATE: Optional[str] = None#
DEFAULT_WORKFLOW: Optional[str] = '/home/docs/checkouts/readthedocs.org/user_builds/blissoda/envs/latest/lib/python3.9/site-packages/blissoda/resources/xrpd/integrate_scan_with_saving.json'#
DEFAULT_WORKFLOW_NO_SAVE: Optional[str] = '/home/docs/checkouts/readthedocs.org/user_builds/blissoda/envs/latest/lib/python3.9/site-packages/blissoda/resources/xrpd/integrate_scan_without_saving.json'#
check_monitor(scan)#
Parameters:

scan (_Unavailable)

Return type:

bool

clear_plots()#
Return type:

None

copy_and_remove_parameters(shared, name)#

Copy&Remove parameters from another scope (global or session, singleton or instance).

Parameters:

  • shared (bool)

  • name (Optional[str])

Return type:

None

property data_from_memory#
property data_portal_upload#
disable()#
disable_plotting()#
enable(*detectors)#
Return type:

None

enable_plotting()#
external_output_filename(scan, lima_name)#

External filename in which the online processing saves the results. When None the online processing saves directly in the master file.

Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

Optional[str]

external_output_url(scan, lima_name)#

External URL in which the online processing saves the results. When None the online processing saves directly in the master URL.

Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

Optional[str]

property flush_period#
classmethod get_all_lima_names()#
Return type:

Set[str]

get_config_filename(lima_name)[source]#
Parameters:

lima_name (str)

Return type:

Optional[str]

get_config_inputs(scan, lima_name)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

List[dict]

get_data(scan, channel, idx=())#

Get processed data for a scan. Tries to mirror the existing scan.get_data for raw data. A list of available channels for a given lima name can be retrieved using get_data_keys.

Ex:
>>> scan = loopscan(5, 0.1, difflab6)
>>> xrpd_processor.get_data_keys(scan, 'difflab6')
['difflab6:intensity', 'difflab6:points', 'difflab6:q']
>>> xrpd_processor.get_data(scan, 'difflab6:intensity')
array([...], dtype=float32)
Parameters:

  • scan (_Unavailable)

  • channel (str)

get_data_keys(scan, lima_name)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

get_filename(scan)#
Parameters:

scan (_Unavailable)

Return type:

str

get_inputs(scan, lima_name)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

List[dict]

get_integrate_1d_inputs(scan, lima_name)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

List[dict]

get_integrate_inputs(scan, lima_name, task_identifier)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

  • task_identifier (str)

Return type:

List[dict]

get_integrate_list_inputs(scan, lima_name)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

List[dict]

get_integration_options(scan, lima_name)[source]#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

Optional[dict]

get_lima_names(scan)#
Parameters:

scan (_Unavailable)

Return type:

List[str]

get_save_inputs(scan, lima_name, task_identifier)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

  • task_identifier (str)

Return type:

List[dict]

get_submit_arguments(scan, lima_name)#
Parameters:

scan (_Unavailable)

Return type:

dict

get_workflow(scan)#

Get the workflow to execute for the scan and ensure it is located in the proposal directory for user reference and worker accessibility.

Parameters:

scan (_Unavailable)

Return type:

Optional[str]

property integration_options#
property lima_names: List[str] | None#
property lima_url_template#
property lima_url_template_args#
master_output_filename(scan)#

Filename which can be used to inspect the results after the processing.

Parameters:

scan (_Unavailable)

Return type:

str

master_output_url(scan)#

URL which can be used to inspect the results after the processing.

Parameters:

scan (_Unavailable)

Return type:

str

property monitor_name#
property number_of_scans: int#
on_new_scan(scan)#
Parameters:

scan (_Unavailable)

Return type:

Optional[Any]

on_new_scan_metadata(scan)#
Parameters:

scan (_Unavailable)

Return type:

Optional[dict]

online_output_filename(scan, lima_name)#

Filename which can be used to inspect the results during and after the processing.

Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

Optional[str]

online_output_url(scan, lima_name)#

URL which can be used to inspect the results during and after the processing.

Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

str

property plotter: plotter_class | None#
plotter_class#

alias of XrpdPlotter

property prioritize_non_native_h5items#
purge_plotting_tasks()#
Return type:

int

property pyfai_config#
property queue#
property reference#
replot()#
Return type:

None

property retry_period#
property retry_timeout#
property save_scans_separately#
scan_processed_directory(scan)#
Parameters:

scan (_Unavailable)

Return type:

str

scan_requires_processing(scan)#
Parameters:

scan (_Unavailable)

Return type:

bool

set_lima_names(*detectors)#
Return type:

None

stop_plotting_tasks()#
Return type:

int

property trigger_at: str | None#
property trigger_from_bliss#
property worker#
workflow_destination(scan, lima_name)#
Parameters:

  • scan (_Unavailable)

  • lima_name (str)

Return type:

str

property workflow_with_saving#
property workflow_without_saving#