Skip to content
  • API documentation
  • careamics
  • cli
  • utils

utils

Utility functions for the CAREamics CLI.

handle_2D_3D_callback(value) #

Callback for options that require 2D or 3D inputs.

In the case of 2D, the 3rd element should be set to -1.

Parameters:

Name Type Description Default
value (int, int, int)

Tile size value.

 required

Returns:

Type Description
(int, int, int) | (int, int)

If the last element in value is -1 the tuple is reduced to the first two values.
Source code in src/careamics/cli/utils.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def handle_2D_3D_callback(
    value: tuple[int, int, int] | None,
) -> tuple[int, ...] | None:
    """
    Callback for options that require 2D or 3D inputs.

    In the case of 2D, the 3rd element should be set to -1.

    Parameters
    ----------
    value : (int, int, int)
        Tile size value.

    Returns
    -------
    (int, int, int) | (int, int)
        If the last element in `value` is -1 the tuple is reduced to the first two
        values.
    """
    if value is None:
        return value
    if value[2] == -1:
        return value[:2]
    return value