Skip to content

Models

CLASS DESCRIPTION
SingleImage

SingleImageBase, with scalar attributes values (None excluded)

SingleImageBase

Base for SingleImage and SingleImageTaskOutput.

SingleImageTaskOutput

SingleImageBase, with scalar attributes values (None included).

Attributes

Classes

SingleImage pydantic-model

Bases: SingleImageBase

SingleImageBase, with scalar attributes values (None excluded)

Fields:

Source code in fractal_server/images/models.py
class SingleImage(SingleImageBase):
    """
    `SingleImageBase`, with scalar `attributes` values (`None` excluded)
    """

    attributes: ImageAttributes = Field(default_factory=dict)

SingleImageBase pydantic-model

Bases: BaseModel

Base for SingleImage and SingleImageTaskOutput.

ATTRIBUTE DESCRIPTION
zarr_url

TYPE: ZarrUrlStr

origin

TYPE: ZarrUrlStr | None

attributes

TYPE: DictStrAny

types

TYPE: ImageTypes

Fields:

Source code in fractal_server/images/models.py
class SingleImageBase(BaseModel):
    """
    Base for `SingleImage` and `SingleImageTaskOutput`.

    Attributes:
        zarr_url:
        origin:
        attributes:
        types:
    """

    zarr_url: ZarrUrlStr
    origin: ZarrUrlStr | None = None

    attributes: DictStrAny = Field(default_factory=dict)
    types: ImageTypes = Field(default_factory=dict)

SingleImageTaskOutput pydantic-model

Bases: SingleImageBase

SingleImageBase, with scalar attributes values (None included).

Fields:

Source code in fractal_server/images/models.py
class SingleImageTaskOutput(SingleImageBase):
    """
    `SingleImageBase`, with scalar `attributes` values (`None` included).
    """

    attributes: ImageAttributesWithNone = Field(default_factory=dict)