darfix.tasks.hdf5_scans_concatenation.concatenate_scans#

darfix.tasks.hdf5_scans_concatenation.concatenate_scans(input_file, entries_to_concatenate, output_file, detector_data_path, positioners_group_path, output_entry_name='entry_0000', overwrite=False, vds_policy=VDS_POLICY.RELATIVE)[source]#
Parameters:

  • input_file (str) – proposal file containing link to all the detector frame…

  • entries_to_concatenate (Optional[tuple]) – tuple of all entries to concatenate. Order will be preserved. If None provided then all entries will be concatenated

  • output_file (str) – location of the output file

  • detector_data_path (str) –

    path to the detector dataset. Expected to be provided as ‘{scan}/path/to/detector/dataset’ (a) or ‘{scan}/path/to/{detector}’ (b).

    • in the use case (a) the relative (to {scan}) path is fully provided and will be take ‘as such’

    • in the use case (b) only a folder path is provided and the keyword {detector} must be provided at the end. In this case the function will call the ‘find_detector_dataset’ function. And will browse the group for any detector. First groups with ‘nexus’ attributes fitting a 3D detector will be search. If none are found then it will return the first 3D dataset found.

  • positioners_group_path (str) – path to the positioners datasets (containing motor positions). Expected to be provided as a ‘{scan}/path/to/group’ pattern. Where the ‘{scan}’ part will be replaced by input file first level items.

  • output_entry_name (str) – HDF5 group name that will contain the concatenated detector data + metadata.

  • overwrite (bool) – if False and output file exist then will not overwrite it

  • vds_policy (str | VDS_POLICY) – policy regarding the VirtualDataSet. Either “absolute” or “relative”

Return type:

None