Skip to content
  • API documentation
  • careamics
  • config
  • validators
  • patch_validators

patch_validators

Validator functions.

These functions are used to validate dimensions and axes of inputs.

patch_size_ge_than_8_power_of_2(patch_list) #

Validate that each entry is greater or equal than 8 and a power of 2.

Parameters:

Name Type Description Default
patch_list Sequence of int, or None

Patch size.

 required

Raises:

Type Description
ValueError

If the patch size if smaller than 8.
ValueError

If the patch size is not a power of 2.
Source code in src/careamics/config/validators/patch_validators.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def patch_size_ge_than_8_power_of_2(
    patch_list: Sequence[int] | None,
) -> None:
    """
    Validate that each entry is greater or equal than 8 and a power of 2.

    Parameters
    ----------
    patch_list : Sequence of int, or None
        Patch size.

    Raises
    ------
    ValueError
        If the patch size if smaller than 8.
    ValueError
        If the patch size is not a power of 2.
    """
    if patch_list is not None:
        for dim in patch_list:
            _value_ge_than_8_power_of_2(dim)