Skip to content
  • API documentation
  • careamics
  • transforms
  • struct_mask_parameters

struct_mask_parameters

Class representing the parameters of structN2V masks.

StructMaskParameters dataclass #

Parameters of structN2V masks.

Attributes:

Name Type Description
axis Literal[0, 1]

Axis along which to apply the mask, horizontal (0) or vertical (1).
span int

Span of the mask.
Source code in src/careamics/transforms/struct_mask_parameters.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
@dataclass
class StructMaskParameters:
    """Parameters of structN2V masks.

    Attributes
    ----------
    axis : Literal[0, 1]
        Axis along which to apply the mask, horizontal (0) or vertical (1).
    span : int
        Span of the mask.
    """

    axis: Literal[0, 1]
    span: int