nanopyx.methods.esrrf_3d.run

 1from ...core.transform._le_esrrf3d import eSRRF3D
 2from ...core.transform.sr_temporal_correlations import (
 3    calculate_eSRRF3d_temporal_correlations,
 4)
 5
 6
 7def run_esrrf3d(
 8    img, correlation="AVG", framewindow=5, rollingoverlap=2, **kwargs
 9):
10    """
11    Calculate the eSRRF3D temporal correlations for the given image.
12
13    Args:
14        img: The input 3D image.
15        magnification_xy: The magnification factor for the x and y axes.
16        magnification_z: The magnification factor for the z axis.
17        radius: The radius for the xy plane.
18        radius_z: The radius for the z axis.
19        sensitivity: The sensitivity for the calculation.
20        doIntensityWeighting: Whether to perform intensity weighting.
21        run_type: The type of the run.
22        keep_gradients: Whether to keep the gradients.
23        keep_interpolated: Whether to keep the interpolated values.
24        correlation: The type of correlation to use.
25        framewindow: The window size for frame.
26        rollingoverlap: The overlap size for rolling.
27
28    Returns:
29        The calculated eSRRF3D temporal correlations.
30    """
31    esrrf_calculator = eSRRF3D()
32    return calculate_eSRRF3d_temporal_correlations(
33        esrrf_calculator.run(img, **kwargs),
34        correlation=correlation,
35        framewindow=framewindow,
36        rollingoverlap=rollingoverlap,
37    )
def run_esrrf3d(img, correlation='AVG', framewindow=5, rollingoverlap=2, **kwargs):
 8def run_esrrf3d(
 9    img, correlation="AVG", framewindow=5, rollingoverlap=2, **kwargs
10):
11    """
12    Calculate the eSRRF3D temporal correlations for the given image.
13
14    Args:
15        img: The input 3D image.
16        magnification_xy: The magnification factor for the x and y axes.
17        magnification_z: The magnification factor for the z axis.
18        radius: The radius for the xy plane.
19        radius_z: The radius for the z axis.
20        sensitivity: The sensitivity for the calculation.
21        doIntensityWeighting: Whether to perform intensity weighting.
22        run_type: The type of the run.
23        keep_gradients: Whether to keep the gradients.
24        keep_interpolated: Whether to keep the interpolated values.
25        correlation: The type of correlation to use.
26        framewindow: The window size for frame.
27        rollingoverlap: The overlap size for rolling.
28
29    Returns:
30        The calculated eSRRF3D temporal correlations.
31    """
32    esrrf_calculator = eSRRF3D()
33    return calculate_eSRRF3d_temporal_correlations(
34        esrrf_calculator.run(img, **kwargs),
35        correlation=correlation,
36        framewindow=framewindow,
37        rollingoverlap=rollingoverlap,
38    )

Calculate the eSRRF3D temporal correlations for the given image.

Args: img: The input 3D image. magnification_xy: The magnification factor for the x and y axes. magnification_z: The magnification factor for the z axis. radius: The radius for the xy plane. radius_z: The radius for the z axis. sensitivity: The sensitivity for the calculation. doIntensityWeighting: Whether to perform intensity weighting. run_type: The type of the run. keep_gradients: Whether to keep the gradients. keep_interpolated: Whether to keep the interpolated values. correlation: The type of correlation to use. framewindow: The window size for frame. rollingoverlap: The overlap size for rolling.

Returns: The calculated eSRRF3D temporal correlations.