nplsizer.filters module#
- nplsizer.filters.filter_mean(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, kernel_width: Annotated[int, {'enabled': True, 'visible': False, 'min': 0, 'max': 999, 'step': 1}] = 5, kernel_height: Annotated[int, {'enabled': True, 'visible': False, 'min': 0, 'max': 999, 'step': 1}] = 0, name: Annotated[str, {'enabled': True, 'visible': False}] = 'FilteredMean') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.filter_median(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, ksize: Annotated[int, {'enabled': True, 'visible': False, 'min': 3, 'max': 999, 'step': 2}] = 5, name: Annotated[str, {'enabled': True, 'visible': False}] = 'FilteredMedian') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.filter_gaussian(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, kernel_width: Annotated[int, {'enabled': True, 'visible': False, 'min': 3, 'max': 999, 'step': 2}] = 5, kernel_height: Annotated[int, {'enabled': True, 'visible': False, 'min': 0, 'max': 999, 'step': None}] = 0, sigma_x: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': None}] = 0.0, sigma_y: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': None}] = 0.0, name: Annotated[str, {'enabled': True, 'visible': False}] = 'FilteredGaussian') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.filter_unsharp_mask(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, radius: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': None}] = 1.0, amount: Annotated[float, {'enabled': True, 'visible': False, 'min': -100.0, 'max': 999.0, 'step': None}] = 1.0, name: Annotated[str, {'enabled': True, 'visible': False}] = 'FilteredUnsharp') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.denoise_tv_bregman(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, weight: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': 0.001}] = 0.5, max_num_iter: Annotated[int, {'enabled': True, 'visible': False, 'min': 0, 'max': 999, 'step': None}] = 100, eps: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': 1e-05}] = 0.001, name: Annotated[str, {'enabled': True, 'visible': False}] = 'DenoisedBregman') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.denoise_tvl1(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, lamda: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': None}] = 0.5, niters: Annotated[int, {'enabled': True, 'visible': False, 'min': 0, 'max': 999, 'step': None}] = 30, name: Annotated[str, {'enabled': True, 'visible': False}] = 'DenoisedTVL1') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.denoise_nl_means(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, h: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': None}] = 3.0, template_window_size: Annotated[int, {'enabled': True, 'visible': False, 'min': 3, 'max': 999, 'step': 2}] = 7, search_window_size: Annotated[int, {'enabled': True, 'visible': False, 'min': 5, 'max': 999, 'step': 2}] = 21, name: Annotated[str, {'enabled': True, 'visible': False}] = 'DenoisedNlMeans') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.denoise_bilateral(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, d: Annotated[int, {'enabled': True, 'visible': False, 'min': 0, 'max': 100, 'step': 1, 'orientation': 'horizontal', 'readout': True}] = 5, sigma_color: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 200.0, 'step': 1.0, 'orientation': 'horizontal', 'readout': True}] = 25.0, sigma_space: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 200.0, 'step': 1.0, 'orientation': 'horizontal', 'readout': True}] = 25.0, name: Annotated[str, {'enabled': True, 'visible': False}] = 'DenoisedBilateral') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided
- nplsizer.filters.denoise_kuwahara(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, method: Annotated[str, {'enabled': True, 'visible': False, 'choices': ('mean', 'gaussian')}]='mean', radius: Annotated[int, {'enabled': True, 'visible': False, 'min': 0, 'max': 999, 'step': None}] = 3, sigma: Annotated[float, {'enabled': True, 'visible': False, 'min': 0.0, 'max': 999.0, 'step': None}] = 0.0, name: Annotated[str, {'enabled': True, 'visible': False}] = 'DenoisedKuwahara') LayerDataTuple#
Wrapper for a container of widgets representing a callable object.
- Parameters:
- functionCallable
A callable to turn into a GUI
- call_buttonbool | str | None, optional
If True, create an additional button that calls the original function when clicked. If a str, set the button text. by default False when auto_call is True, and True otherwise. The button can be accessed from the .call_button property.
- layoutstr, optional
The type of layout to use. Must be horizontal or vertical by default “horizontal”.
- scrollablebool, optional
Whether to enable scroll bars or not. If enabled, scroll bars will only appear along the layout direction, not in both directions.
- labelsbool, optional
Whether labels are shown in the widget. by default True
- tooltipsbool, optional
Whether tooltips are shown when hovering over widgets. by default True
- appApplication | str | None, optional
A backend to use, by default None (use the default backend.)
- visiblebool, optional
Whether to immediately show the widget. If False, widget is explicitly hidden. If None, widget is not shown, but will be shown if a parent container is shown, by default None.
- auto_callbool, optional
If True, changing any parameter in either the GUI or the widget attributes will call the original function with the current settings. by default False
- result_widgetbool, optional
Whether to display a LineEdit widget the output of the function when called, by default False
- param_optionsdict, optional
A dict of name: widget_options dict for each parameter in the function. Will be passed to magic_signature by default None
- namestr, optional
A name to assign to the Container widget, by default function.__name__
- persistbool, optional
If True, when parameter values change in the widget, they will be stored to disk (in ~/.config/magicgui/cache) and restored when the widget is loaded again with persist = True. By default, False.
- raise_on_unknownbool
If True, raise an error if a parameter annotation is not recognized.
- Raises:
- TypeError
If unexpected keyword arguments are provided