ewoksid02.utils.caving.process_data_caving

ewoksid02.utils.caving.process_data_caving(data, Center_1, Center_2, Dummy=None, filename_mask_static=None, filename_mask_reference=None, algorithm_cave='numpy', flip_caving=False, flip_horizontally_preference=True, **kwargs)

Performs the caving on a 3-dimensional dataset using numpy methods

Inputs:

• data (numpy.ndarray): data signal, 2 or 3-dimensional

• Center_1 (int): beam center in the first data dimension

• Center_2 (int): beam center in the second data dimension

• Dummy (int): pixels in data with dummy value will be replaced

• filename_mask_static (str): path to the file with the mask whose pixels we want to replace

• filename_mask_reference (str): path to the file with the mask whose pixels should not be used, that means that their symmetric brother should not be caved

• algorithm (str): implementation to perform the caving: numpy or cupy

• flip_caving (bool): if True, adds horizontal-symmetric and vertical-symmetric caving (by default, centro-symmetric caving is always performed)

• flip_horizontally_preference (bool): if flip_caving is activated, horizontal caving is done before vertical caving

• **kwargs

Outputs:

• numpy.ndarray: data with replaced pixels (caved) using numpy methods

Parameters:

• data (ndarray)

• Center_1 (int)

• Center_2 (int)

• Dummy (int)

• filename_mask_static (str)

• filename_mask_reference (str)

• algorithm_cave (str)

• flip_caving (bool)

• flip_horizontally_preference (bool)

Return type:

ndarray