ranch.filtering package

Submodules

ranch.filtering.filters module

class ranch.filtering.filters.Kernels

Bases: object

Helpers to instantiate structuring elements

static assemble_separables(*h) → ndarray

TODO

static gaussian_1d(n: int) → ndarray

TODO

static uniform_1d(n: int) → ndarray

TODO

ranch.filtering.filters.filter_channels(cube: Cube, kernel: ndarray, filtering_mode: str = 'linear', padding_mode: str = 'constant', cval: float = 0)

TODO

ranch.filtering.filters.filter_cube(cube: Cube, kernel: ndarray, filtering_mode: str = 'linear', padding_mode: str = 'constant', cval: float = 0)

TODO

ranch.filtering.filters.filter_map(map: Map, kernel: ndarray, filtering_mode: str = 'linear', padding_mode: str = 'constant', cval: float = 0)

TODO

ranch.filtering.filters.filter_pixels(cube: Cube, kernel: ndarray, filtering_mode: str = 'linear', padding_mode: str = 'constant', cval: float = 0)

TODO

ranch.filtering.filters.filter_profile(profile: Profile, kernel: ndarray, filtering_mode: str = 'linear', padding_mode: str = 'constant', cval: float = 0)

TODO

ranch.filtering.morphology module

class ranch.filtering.morphology.StructuringElements

Bases: object

Helpers to instantiate structuring elements

static ball(r: int, filled: bool = True) → ndarray

TODO

static cube(c: int, filled=True) → ndarray

TODO

static cuboid(a: int, b: int, c: int, filled: bool = True) → ndarray

TODO

static disk(r: int, filled: bool = True) → ndarray

TODO

static ellipse(a: int, b: int, theta: float, filled: bool = True) → ndarray

TODO

static ellipsoid(rx: int, ry: int, rz: int, theta: float = 0.0, phi: float = 0.0, filled: bool = True) → ndarray

TODO

static rectangle(a: int, b: int, filled: bool = True) → ndarray

TODO

static segment(lg: int, filled: bool = True) → ndarray

TODO

static square(c: int, filled: bool = True) → ndarray

TODO

ranch.filtering.morphology.closing(input: Cube, se: ndarray) → Cube

ranch.filtering.morphology.closing(input: Map, se: ndarray) → Map

ranch.filtering.morphology.closing(input: Profile, se: ndarray) → Profile

TODO

ranch.filtering.morphology.dilation(input: Cube, se: ndarray) → Cube

ranch.filtering.morphology.dilation(input: Map, se: ndarray) → Map

ranch.filtering.morphology.dilation(input: Profile, se: ndarray) → Profile

TODO

ranch.filtering.morphology.erosion(input: Cube, se: ndarray) → Cube

ranch.filtering.morphology.erosion(input: Map, se: ndarray) → Map

ranch.filtering.morphology.erosion(input: Profile, se: ndarray) → Profile

TODO

ranch.filtering.morphology.gradient(input: Cube, se: ndarray) → Cube

ranch.filtering.morphology.gradient(input: Map, se: ndarray) → Map

ranch.filtering.morphology.gradient(input: Profile, se: ndarray) → Profile

TODO

ranch.filtering.morphology.laplacian(input: Cube, se: ndarray) → Cube

ranch.filtering.morphology.laplacian(input: Map, se: ndarray) → Map

ranch.filtering.morphology.laplacian(input: Profile, se: ndarray) → Profile

TODO

ranch.filtering.morphology.opening(input: Cube, se: ndarray) → Cube

ranch.filtering.morphology.opening(input: Map, se: ndarray) → Map

ranch.filtering.morphology.opening(input: Profile, se: ndarray) → Profile

TODO

ranch.filtering.noise module

ranch.filtering.noise.noise_clipping(cube: Cube, percent: float, noise_map: Map | None = None, signal_channels: List[slice] | None = None, p_xy: int = 5, p_z: int = 3, type_xy: str = 'gaussian', type_z: str = 'gaussian', nans: bool = False, verbose: bool = False)

Module contents