Skip to content

N2V Manipulate Config

Source

Pydantic model for the N2VManipulate transform.

N2VManipulateConfig

Bases: TransformConfig

Pydantic model used to represent N2V manipulation.

Attributes:

Name Type Description
name Literal['N2VManipulate']

Name of the transformation.

roi_size int

Size of the masking region, by default 11.

masked_pixel_percentage float

Percentage of masked pixels, by default 0.2.

strategy Literal['uniform', 'median']

Strategy pixel value replacement, by default "uniform".

struct_mask_axis Literal['horizontal', 'vertical', 'none']

Axis of the structN2V mask, by default "none".

struct_mask_span int

Span of the structN2V mask, by default 5.

seed int

Random seed for reproducibility.

masked_pixel_percentage = Field(default=0.2, ge=0.05, le=10.0) class-attribute instance-attribute

Percentage of masked pixels per image.

roi_size = Field(default=11, ge=3, le=21) class-attribute instance-attribute

Size of the region where the pixel manipulation is applied.

seed = Field(default_factory=generate_random_seed, gt=0) class-attribute instance-attribute

Random seed for reproducibility. If not specified, a random seed is generated.

strategy = Field(default='uniform') class-attribute instance-attribute

Strategy for pixel value replacement.

struct_mask_axis = Field(default='none') class-attribute instance-attribute

Orientation of the structN2V mask. Set to "non" to not apply StructN2V.

struct_mask_span = Field(default=5, ge=3, le=15) class-attribute instance-attribute

Size of the structN2V mask.

model_dump(**kwargs)

Return the model as a dictionary.

Parameters:

Name Type Description Default
**kwargs

Pydantic BaseMode model_dump method keyword arguments.

{}

Returns:

Type Description
{str: Any}

Dictionary representation of the model.

odd_value(v) classmethod

Validate that the value is odd.

Parameters:

Name Type Description Default
v int

Value to validate.

required

Returns:

Type Description
int

The validated value.

Raises:

Type Description
ValueError

If the value is even.