Skip to content
  • Code Reference
  • careamics_napari
  • careamics_utils
  • algorithms

algorithms

Utilities for handling algorithms shorthand and friendly names.

UNSUPPORTED = 'I would prefer not to.' module-attribute #

Label for algorithm not currently supported in the napari plugin.

get_algorithm(friendly_name) #

Return the algorithm corresponding to the friendly name.

The string returned by this method can directly be used with CAREamics configuration.

Parameters:

Name Type Description Default
friendly_name str

Friendly name.

 required

Returns:

Type Description
str

Algorithm.
Source code in src/careamics_napari/careamics_utils/algorithms.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def get_algorithm(friendly_name: str) -> str:
    """Return the algorithm corresponding to the friendly name.

    The string returned by this method can directly be used with CAREamics
    configuration.

    Parameters
    ----------
    friendly_name : str
        Friendly name.

    Returns
    -------
    str
        Algorithm.
    """
    if friendly_name == "Noise2Void":
        return SupportedAlgorithm.N2V.value
    elif friendly_name == "CARE":
        return SupportedAlgorithm.CARE.value
    elif friendly_name == "Noise2Noise":
        return SupportedAlgorithm.N2N.value
    else:
        raise ValueError(f"Unsupported algorithm: {friendly_name}")

get_available_algorithms() #

Return the available algorithms friendly names.

Returns:

Type Description
list of str

A list of available algorithms.
Source code in src/careamics_napari/careamics_utils/algorithms.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
def get_available_algorithms() -> list[str]:
    """Return the available algorithms friendly names.

    Returns
    -------
    list of str
        A list of available algorithms.
    """
    return [
        get_friendly_name(algorithm)
        for algorithm in SupportedAlgorithm
        if get_friendly_name(algorithm) != UNSUPPORTED
    ]

get_friendly_name(algorithm) #

Return the friendly name of an algorithm.

Friendly names are spelling out the algorithm names in a human-readable way.

Parameters:

Name Type Description Default
algorithm SupportedAlgorithm

Algorithm.

 required

Returns:

Type Description
str

Friendly name.
Source code in src/careamics_napari/careamics_utils/algorithms.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def get_friendly_name(algorithm: SupportedAlgorithm) -> str:
    """Return the friendly name of an algorithm.

    Friendly names are spelling out the algorithm names in a human-readable way.

    Parameters
    ----------
    algorithm : SupportedAlgorithm
        Algorithm.

    Returns
    -------
    str
        Friendly name.
    """
    if algorithm == SupportedAlgorithm.N2V:
        return "Noise2Void"
    elif algorithm == SupportedAlgorithm.CARE:
        return "CARE"
    elif algorithm == SupportedAlgorithm.N2N:
        return "Noise2Noise"
    else:
        return UNSUPPORTED