Validators

Validator utilities.

`check_axes_validity(axes)`

Sanity check on axes.

The constraints on the axes are the following: - must be a combination of 'STCZYX' - must not contain duplicates - must contain at least 2 contiguous axes: X and Y

Axes do not need to be in the order 'STCZYX', as this depends on the user data.

Parameters:

axes (str) –

Axes to validate.

`check_czi_axes_validity(axes)`

Check if the provided axes string is valid for CZI files.

CZI axes is always in the "SC(Z/T)YX" format, where Z or T are optional, and S and C can be singleton dimensions, but must be provided.

Parameters:

axes (str) –

The axes string to validate.

Returns:

bool –

True if the axes string is valid, False otherwise.

`model_matching_in_out_channels(model)`

Validate that the UNet model has the same number of channel inputs and outputs.

Parameters:

model (UNetConfig) –

Model to validate.

Returns:

UNetConfig –

Validated model.

Raises:

ValueError –

If the model has different number of input and output channels.

`model_no_c_ind_for_mismatching_channels(model)`

Validate that UNet models with mismatching input/output has dependent channels.

Parameters:

model (UNetModel) –

Model to validate.

Returns:

UNetModel –

Validated model.

Raises:

ValueError –

If the model has independent_channels set to True while the number of input and output channels do not match.

`model_without_final_activation(model)`

Validate that the UNet model does not have the final_activation.

Parameters:

model (UNetConfig) –

Model to validate.

Returns:

UNetConfig –

The validated model.

Raises:

ValueError –

If the model has the final_activation attribute set.

`model_without_n2v2(model)`

Validate that the Unet model does not have the n2v2 attribute.

Parameters:

model (UNetConfig) –

Model to validate.

Returns:

UNetConfig –

The validated model.

Raises:

ValueError –

If the model has the n2v2 attribute set to True.

`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:

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.