Skip to content

axis ¤

Classes:

Name Description
Axis
AxisDescrLike
AxisInfo
AxisSize

Attributes:

Name Type Description
AxisId TypeAlias

An axis identifier, e.g. 'batch', 'channel', 'z', 'y', 'x'
AxisLetter
AxisLike
BatchSize
PerAxis
S

AxisId module-attribute ¤

AxisId: TypeAlias = v0_5.AxisId

An axis identifier, e.g. 'batch', 'channel', 'z', 'y', 'x'

Used by:

AxisLetter module-attribute ¤

AxisLetter = Literal['b', 'i', 't', 'c', 'z', 'y', 'x']

AxisLike module-attribute ¤

AxisLike = Union[_AxisLikePlain, AxisDescrLike, v0_5.AnyAxis, 'Axis', 'AxisInfo']
Used by:

BatchSize module-attribute ¤

BatchSize = int

PerAxis module-attribute ¤

PerAxis = Mapping[AxisId, _T]
Returned by: Used by:

S module-attribute ¤

S = TypeVar('S', bound=str)

Axis dataclass ¤

Axis(id: AxisId, type: Literal['batch', 'channel', 'index', 'space', 'time'])
Subclassed by:

Methods:

Name Description
__post_init__
create

Attributes:

Name Type Description
id AxisId
type Literal['batch', 'channel', 'index', 'space', 'time']

id instance-attribute ¤

id: AxisId

type instance-attribute ¤

type: Literal['batch', 'channel', 'index', 'space', 'time']

__post_init__ ¤

__post_init__()
Source code in src/bioimageio/core/axis.py 
69
70
71
72
73
def __post_init__(self):
    if self.type == "batch":
        self.id = AxisId("batch")
    elif self.type == "channel":
        self.id = AxisId("channel")

create classmethod ¤

create(axis: AxisLike) -> Axis
Source code in src/bioimageio/core/axis.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@classmethod
def create(cls, axis: AxisLike) -> Axis:
    if isinstance(axis, cls):
        return axis

    if isinstance(axis, (AxisId, str)):
        axis_id = axis
        axis_type = _guess_axis_type(str(axis))
    else:
        if hasattr(axis, "type"):
            axis_type = axis.type
        else:
            axis_type = _guess_axis_type(str(axis))

        if hasattr(axis, "id"):
            axis_id = axis.id
        else:
            axis_id = axis

    return Axis(id=AxisId(axis_id), type=axis_type)

AxisDescrLike ¤

Bases: Protocol


              flowchart TD
              bioimageio.core.axis.AxisDescrLike[AxisDescrLike]

              

              click bioimageio.core.axis.AxisDescrLike href "" "bioimageio.core.axis.AxisDescrLike"
Used by:

Attributes:

Name Type Description
id _AxisLikePlain
type Literal['batch', 'channel', 'index', 'space', 'time']

id instance-attribute ¤

id: _AxisLikePlain

type instance-attribute ¤

type: Literal['batch', 'channel', 'index', 'space', 'time']

AxisInfo dataclass ¤

AxisInfo(id: AxisId, type: Literal['batch', 'channel', 'index', 'space', 'time'], size: AxisSize)

Bases: Axis


              flowchart TD
              bioimageio.core.axis.AxisInfo[AxisInfo]
              bioimageio.core.axis.Axis[Axis]

                              bioimageio.core.axis.Axis --> bioimageio.core.axis.AxisInfo
                


              click bioimageio.core.axis.AxisInfo href "" "bioimageio.core.axis.AxisInfo"
              click bioimageio.core.axis.Axis href "" "bioimageio.core.axis.Axis"
Returned by: Used by:

Methods:

Name Description
__post_init__
create

Attributes:

Name Type Description
id AxisId
size AxisSize
type Literal['batch', 'channel', 'index', 'space', 'time']

id instance-attribute ¤

id: AxisId

size instance-attribute ¤

size: AxisSize

type instance-attribute ¤

type: Literal['batch', 'channel', 'index', 'space', 'time']

__post_init__ ¤

__post_init__()
Source code in src/bioimageio/core/axis.py 
69
70
71
72
73
def __post_init__(self):
    if self.type == "batch":
        self.id = AxisId("batch")
    elif self.type == "channel":
        self.id = AxisId("channel")

create classmethod ¤

create(axis: AxisLike, size: Optional[Union[int, AxisSize]] = None) -> AxisInfo
Source code in src/bioimageio/core/axis.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
@classmethod
def create(
    cls, axis: AxisLike, size: Optional[Union[int, AxisSize]] = None
) -> AxisInfo:
    if isinstance(axis, AxisInfo):
        return axis

    axis_base = super().create(axis)
    if size is None:
        if not isinstance(axis, v0_5.AxisBase):
            size = AxisSize(min=1)
        else:
            if axis.size is None:
                size = AxisSize(min=1)
            elif isinstance(axis.size, int):
                size = AxisSize(
                    min=axis.size,
                    max=None
                    if isinstance(axis, (v0_5.TimeAxisBase, v0_5.SpaceAxisBase))
                    or (
                        not isinstance(axis, v0_5.IndexOutputAxis)
                        and axis.concatenable
                    )
                    else axis.size,
                )
            elif isinstance(axis.size, v0_5.SizeReference):
                size = AxisSize(min=axis.size.offset + 1)
            elif isinstance(axis.size, v0_5.ParameterizedSize):
                size = AxisSize(min=axis.size.min, step=axis.size.step)
            elif isinstance(axis.size, v0_5.DataDependentSize):
                size = AxisSize(min=axis.size.min, max=axis.size.max)
            else:
                assert_never(axis.size)
    elif isinstance(size, int):
        size = AxisSize(min=size, max=size)

    return AxisInfo(id=axis_base.id, type=axis_base.type, size=size)

AxisSize dataclass ¤

AxisSize(min: int, max: Optional[int] = None, step: Optional[int] = None)
Used by:

Attributes:

Name Type Description
max Optional[int]
min int
step Optional[int]

max class-attribute instance-attribute ¤

max: Optional[int] = None

min instance-attribute ¤

min: int

step class-attribute instance-attribute ¤

step: Optional[int] = None