nplsizer.io_ops module#
- nplsizer.io_ops.read_image(fn: Path, {'enabled': True, 'visible': False}] = PosixPath('.'), write_dm3_metadata: Annotated[bool, {'enabled': True, 'visible': False, 'text': 'Write metadata for DM3 files'}] = False, fn_dm3_metadata: Path, {'enabled': True, 'visible': False}] = PosixPath('metadata.txt'), name: Annotated[str, {'enabled': True, 'visible': False}] = '') 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.io_ops.write_image(image: Image, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, fn: Path, {'enabled': True, 'visible': False}] = PosixPath('.'), jpeg_quality: Annotated[int, {'enabled': True, 'visible': False, 'min': 1, 'max': 100, 'step': 1, 'orientation': 'horizontal', 'readout': True}] = 75) None#
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.io_ops.calc_size(shapes: Shapes, {'enabled': True, 'visible': False, 'choices': <function get_layers at 0x12ab32610>}] = None, fn_out: Path, {'enabled': True, 'visible': False}] = None, clear_shapes: Annotated[bool, {'enabled': True, 'visible': False, 'text': 'clear shapes'}] = True) None#
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