ewoksid02.utils.blissdata.get_available_dataset#
- ewoksid02.utils.blissdata.get_available_dataset(lima_name, scan_memory_url='', lima_url_template='', lima_url_template_args={}, scan_nb=None, subscan=1, last_index_read=0, max_slice_size=10, start_from_memory=True, range_index_read=None, data_filename=None)[source]#
Retrieves the available dataset from either Lima memory or an HDF5 file.
- Args:
lima_name (str): Name of the detector. scan_memory_url (str): URL to the scan memory. lima_url_template (str, optional): Template for Lima file URLs. Defaults to “”. lima_url_template_args (dict, optional): Arguments for the Lima URL template. Defaults to {}. subscan (int, optional): Subscan number. Defaults to 1. last_index_read (int, optional): Last index read from the dataset. Defaults to 0. max_slice_size (int, optional): Maximum number of frames to read in one slice. Defaults to 10. start_from_memory (bool, optional): Whether to start reading from memory. Defaults to True.
- Returns:
Optional[np.ndarray]: The retrieved dataset, or None if no data is available.
- Parameters:
lima_name (
str)scan_memory_url (
str)lima_url_template (
str)lima_url_template_args (
Dict[str,Any])scan_nb (
int)subscan (
int)last_index_read (
int)max_slice_size (
int)start_from_memory (
bool)range_index_read (
Optional[Tuple[int,int]])data_filename (
str)
- Return type:
Optional[ndarray]