Skip to content

webknossos.dataset

Attachments 

Attachments(layer: SegmentationLayer)

Bases: AbstractAttachments

agglomerates property 

agglomerates: tuple[AgglomerateAttachment, ...]

connectomes property 

connectomes: tuple[ConnectomeAttachment, ...]

cumsum property 

cumsum: CumsumAttachment | None

is_empty property 

is_empty: bool

meshes property 

meshes: tuple[MeshAttachment, ...]

segment_index property 

segment_index: SegmentIndexAttachment | None

add_agglomerate 

add_agglomerate(
    path: str | PathLike | UPath,
    *,
    name: str,
    data_format: AttachmentDataFormat
) -> AgglomerateAttachment

add_attachment_as_copy 

add_attachment_as_copy(
    attachment: Attachment,
) -> Attachment

add_attachment_as_ref 

add_attachment_as_ref(attachment: Attachment) -> Attachment

add_attachments 

add_attachments(*other: Attachment) -> list[Attachment]

add_connectome 

add_connectome(
    path: str | PathLike | UPath,
    *,
    name: str,
    data_format: AttachmentDataFormat
) -> ConnectomeAttachment

add_copy_attachments 

add_copy_attachments(
    *other: Attachment,
) -> list[Attachment]

add_mesh 

add_mesh(
    path: str | PathLike | UPath,
    *,
    name: str,
    data_format: AttachmentDataFormat
) -> MeshAttachment

add_symlink_attachments(
    *other: Attachment, make_relative: bool = False
) -> list[Attachment]

delete_attachment 

delete_attachment(attachment: Attachment) -> None

detect_legacy_attachments 

detect_legacy_attachments() -> None

Detects and adds legacy attachments. Legacy attachments are attachments that were stored in the folder hierarchy of the layer without explicit metadata.

set_cumsum 

set_cumsum(
    path: str | PathLike | UPath,
    *,
    name: str,
    data_format: AttachmentDataFormat
) -> CumsumAttachment

set_segment_index 

set_segment_index(
    path: str | PathLike | UPath,
    *,
    name: str,
    data_format: AttachmentDataFormat
) -> SegmentIndexAttachment

RemoteAttachments 

RemoteAttachments(layer: RemoteSegmentationLayer)

Bases: AbstractAttachments

agglomerates property 

agglomerates: tuple[AgglomerateAttachment, ...]

connectomes property 

connectomes: tuple[ConnectomeAttachment, ...]

cumsum property 

cumsum: CumsumAttachment | None

is_empty property 

is_empty: bool

meshes property 

meshes: tuple[MeshAttachment, ...]

segment_index property 

segment_index: SegmentIndexAttachment | None

add_attachment_as_copy 

add_attachment_as_copy(
    attachment: Attachment,
) -> Attachment

add_copy_attachments 

add_copy_attachments(
    *other: Attachment,
) -> list[Attachment]

upload_attachment 

upload_attachment(
    attachment: Attachment,
    transfer_mode: TransferMode = COPY,
    common_storage_prefix: str | None = None,
) -> Attachment