Skip to content

webknossos.annotation.volume_layer

SegmentInformation

anchor_position instance-attribute 

anchor_position: Vec3Int | None

color instance-attribute 

color: Vector4 | None

metadata instance-attribute 

metadata: dict[str, str | int | float | Sequence[str]]

name instance-attribute 

name: str | None

VolumeLayer

data_format instance-attribute 

data_format: DataFormat

dtype class-attribute instance-attribute 

dtype: DTypeLike | None = None

fallback_layer_name instance-attribute 

fallback_layer_name: str | None

id instance-attribute 

id: int

largest_segment_id instance-attribute 

largest_segment_id: int | None

layer_name class-attribute instance-attribute 

layer_name: str = 'volumeAnnotationData'

name instance-attribute 

name: str

segments instance-attribute 

segments: dict[int, SegmentInformation]

voxel_size instance-attribute 

voxel_size: Vector3 | None

zip instance-attribute 

zip: Path | None

edit 

edit(
    *,
    edit_mode: VolumeLayerEditMode = TEMPORARY_DIRECTORY,
    executor: Executor | None = None
) -> Generator[Layer | Any, None, None]

Context manager to edit the volume layer.

Parameters:

  • edit_mode (VolumeLayerEditMode, default: TEMPORARY_DIRECTORY ) –

    Specifies the edit mode for the volume layer.

  • executor (Executor | None, default: None ) –

    Optional executor for parallel rechunking.

export_to_dataset 

export_to_dataset(
    dataset: Dataset, layer_name: str = "volume_layer"
) -> SegmentationLayer

Exports the volume layer to a dataset as a SegmentationLayer.

Parameters:

  • dataset (Dataset) –

    The target dataset to export to.

  • layer_name (str, default: 'volume_layer' ) –

    Name of the layer in the dataset.

Returns:

Raises:

  • AssertionError –

    If the volume layer is not set up correctly.

Examples:

# Export volume layer to dataset
exported_layer = volume_layer.export_to_dataset(my_dataset, "my_volume_layer")

VolumeLayerEditMode

Bases: Enum

Defines the edit mode for volume layers.

MEMORY class-attribute instance-attribute 

MEMORY = 'memory'

TEMPORARY_DIRECTORY class-attribute instance-attribute 

TEMPORARY_DIRECTORY = 'temporary_directory'