Skip to content
  • API documentation
  • careamics_napari
  • widgets
  • n2n_config_window

n2n_config_window

N2NConfigurationWindow #

Bases: AdvancedConfigurationWindow

A dialog widget for modifying N2N advanced settings.

Source code in src/careamics_napari/widgets/n2n_config_window.py 
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
class N2NConfigurationWindow(AdvancedConfigurationWindow):
    """A dialog widget for modifying N2N advanced settings."""

    def __init__(
        self,
        parent: QWidget | None,
        careamics_config: BaseConfig,
        algorithm_config: N2NAdvancedConfig,
    ) -> None:
        """Initialize the window.

        Parameters
        ----------
        parent : QWidget | None
            Parent widget.
        careamics_config : BaseConfig
            Careamics configuration object.
        algorithm_config : N2NAdvancedConfig
            N2N advanced configuration object.
        """
        super().__init__(parent, careamics_config, algorithm_config)

        self.advanced_configuration = algorithm_config

        self.add_algorithm_specific_tab()

        self.bind_properties()

    def add_algorithm_specific_tab(self) -> None:
        """Add algorithm specific advanced settings tab."""
        # tab widget
        tab_widget = QWidget()

        # number of input channels
        _n_channels = self.advanced_configuration.n_channels_in or 1
        self.num_channels_in_spin = create_int_spinbox(1, 10, _n_channels, 1)
        self.num_channels_in_spin.setEnabled(
            "C" in self.configuration.data_config.axes  # type: ignore
        )
        self.num_channels_in_spin.setToolTip(
            "Number of input channels of the input image (C must be in axes)."
        )

        # number of output channels
        _n_channels = self.advanced_configuration.n_channels_out or 1
        self.num_channels_out_spin = create_int_spinbox(1, 10, _n_channels, 1)
        # self.num_channels_out_spin.setEnabled(
        #     "C" in self.configuration.data_config.axes  # type: ignore
        # )
        self.num_channels_out_spin.setToolTip("Number of output channels.")

        # layout
        layout = QVBoxLayout()
        form = QFormLayout()
        form.setFormAlignment(Qt.AlignLeft | Qt.AlignTop)  # type: ignore
        form.setFieldGrowthPolicy(
            QFormLayout.AllNonFixedFieldsGrow  # type: ignore
        )
        form.addRow("Number of Input Channels:", self.num_channels_in_spin)
        form.addRow("Number of Output Channels:", self.num_channels_out_spin)
        layout.addLayout(form)

        tab_widget.setLayout(layout)
        self.tabs.addTab(tab_widget, "N2N")

    def save(self) -> None:
        """Save the current state of the UI into configurations."""
        super().update_config()
        self.update_config()
        self.close()

    def bind_properties(self) -> None:
        """Create and bind the properties to the UI elements."""
        # bind the properties from the base class first
        super().bind_properties()
        # type(self) returns the class of the instance, so we are adding
        # properties to the class itself, not the instance.
        type(self).in_channels = bind(self.num_channels_in_spin, "value")
        type(self).out_channels = bind(self.num_channels_out_spin, "value")

    def update_config(self) -> None:
        """Update the configuration object from UI elements."""
        self.advanced_configuration.n_channels_in = self.in_channels
        self.advanced_configuration.n_channels_out = self.out_channels

        if isinstance(self.configuration.algorithm_config, CAREAlgorithm):
            self.configuration.algorithm_config.model.in_channels = self.in_channels
            self.configuration.algorithm_config.model.num_classes = self.out_channels

__init__(parent, careamics_config, algorithm_config) #

Initialize the window.

Parameters:

Name Type Description Default
parent QWidget | None

Parent widget.

 required
careamics_config BaseConfig

Careamics configuration object.

 required
algorithm_config N2NAdvancedConfig

N2N advanced configuration object.

 required
Source code in src/careamics_napari/widgets/n2n_config_window.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
def __init__(
    self,
    parent: QWidget | None,
    careamics_config: BaseConfig,
    algorithm_config: N2NAdvancedConfig,
) -> None:
    """Initialize the window.

    Parameters
    ----------
    parent : QWidget | None
        Parent widget.
    careamics_config : BaseConfig
        Careamics configuration object.
    algorithm_config : N2NAdvancedConfig
        N2N advanced configuration object.
    """
    super().__init__(parent, careamics_config, algorithm_config)

    self.advanced_configuration = algorithm_config

    self.add_algorithm_specific_tab()

    self.bind_properties()

add_algorithm_specific_tab() #

Add algorithm specific advanced settings tab.

Source code in src/careamics_napari/widgets/n2n_config_window.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def add_algorithm_specific_tab(self) -> None:
    """Add algorithm specific advanced settings tab."""
    # tab widget
    tab_widget = QWidget()

    # number of input channels
    _n_channels = self.advanced_configuration.n_channels_in or 1
    self.num_channels_in_spin = create_int_spinbox(1, 10, _n_channels, 1)
    self.num_channels_in_spin.setEnabled(
        "C" in self.configuration.data_config.axes  # type: ignore
    )
    self.num_channels_in_spin.setToolTip(
        "Number of input channels of the input image (C must be in axes)."
    )

    # number of output channels
    _n_channels = self.advanced_configuration.n_channels_out or 1
    self.num_channels_out_spin = create_int_spinbox(1, 10, _n_channels, 1)
    # self.num_channels_out_spin.setEnabled(
    #     "C" in self.configuration.data_config.axes  # type: ignore
    # )
    self.num_channels_out_spin.setToolTip("Number of output channels.")

    # layout
    layout = QVBoxLayout()
    form = QFormLayout()
    form.setFormAlignment(Qt.AlignLeft | Qt.AlignTop)  # type: ignore
    form.setFieldGrowthPolicy(
        QFormLayout.AllNonFixedFieldsGrow  # type: ignore
    )
    form.addRow("Number of Input Channels:", self.num_channels_in_spin)
    form.addRow("Number of Output Channels:", self.num_channels_out_spin)
    layout.addLayout(form)

    tab_widget.setLayout(layout)
    self.tabs.addTab(tab_widget, "N2N")

bind_properties() #

Create and bind the properties to the UI elements.

Source code in src/careamics_napari/widgets/n2n_config_window.py 
90
91
92
93
94
95
96
97
def bind_properties(self) -> None:
    """Create and bind the properties to the UI elements."""
    # bind the properties from the base class first
    super().bind_properties()
    # type(self) returns the class of the instance, so we are adding
    # properties to the class itself, not the instance.
    type(self).in_channels = bind(self.num_channels_in_spin, "value")
    type(self).out_channels = bind(self.num_channels_out_spin, "value")

save() #

Save the current state of the UI into configurations.

Source code in src/careamics_napari/widgets/n2n_config_window.py 
84
85
86
87
88
def save(self) -> None:
    """Save the current state of the UI into configurations."""
    super().update_config()
    self.update_config()
    self.close()

update_config() #

Update the configuration object from UI elements.

Source code in src/careamics_napari/widgets/n2n_config_window.py 
 99
100
101
102
103
104
105
106
def update_config(self) -> None:
    """Update the configuration object from UI elements."""
    self.advanced_configuration.n_channels_in = self.in_channels
    self.advanced_configuration.n_channels_out = self.out_channels

    if isinstance(self.configuration.algorithm_config, CAREAlgorithm):
        self.configuration.algorithm_config.model.in_channels = self.in_channels
        self.configuration.algorithm_config.model.num_classes = self.out_channels