ewoksid02.average.calculate_average#
- ewoksid02.average.calculate_average(dataset_intensity, dataset_variance=None, dataset_sum_signal=None, dataset_sum_norm=None, dataset_sum_variance=None, axis_average=1, array1_range=None, array2_range=None, Dummy=-10, calculate_variance=False, **kwargs)[source]#
Calculate the average intensity, signal normalization, variance, and sigma for a dataset.
- Inputs:
dataset_intensity (Optional[numpy.ndarray]): The intensity dataset. dataset_sum_signal (Optional[numpy.ndarray], optional): The sum signal dataset. Defaults to None. dataset_sum_norm (Optional[numpy.ndarray], optional): The sum normalization dataset. Defaults to None. dataset_sum_variance (Optional[numpy.ndarray], optional): The sum variance dataset. Defaults to None. array_ranges (Optional[List[Tuple[int, int]]], optional): The ranges for averaging. Defaults to None. axis_average (int, optional): The axis along which to average. Defaults to 1. 1 is for azimuth axis, 2 is for radial axis. Dummy (int, optional): The dummy value to replace invalid data. Defaults to -10.
- Outputs:
Tuple[Optional[numpy.ndarray], Optional[numpy.ndarray], Optional[numpy.ndarray], Optional[numpy.ndarray]]: The average intensity, signal normalization, variance, and sigma datasets.
- Parameters:
dataset_intensity (
Optional[ndarray])dataset_variance (
Optional[ndarray])dataset_sum_signal (
Optional[ndarray])dataset_sum_norm (
Optional[ndarray])dataset_sum_variance (
Optional[ndarray])axis_average (
int)array1_range (
Optional[List[Tuple[int,int]]])array2_range (
Optional[List[Tuple[int,int]]])Dummy (
int)calculate_variance (
bool)
- Return type:
Tuple[Optional[ndarray],Optional[ndarray],Optional[ndarray],Optional[ndarray]]