Skip to content

webknossos.dataset._array

#   class ArrayException(builtins.Exception):

Common base class for all non-exit exceptions.

Inherited Members
builtins.Exception
Exception
builtins.BaseException
with_traceback
args
#   class DataFormat(enum.Enum):

An enumeration.

#   WKW = <DataFormat.WKW: 'wkw'>
#   Zarr = <DataFormat.Zarr: 'zarr'>
Inherited Members
enum.Enum
name
value
#   class ArrayInfo:

ArrayInfo(data_format: webknossos.dataset._array.DataFormat, num_channels: int, voxel_type: numpy.dtype, chunk_shape: webknossos.geometry.vec3_int.Vec3Int, chunks_per_shard: webknossos.geometry.vec3_int.Vec3Int, compression_mode: bool = False)

#   ArrayInfo( data_format: webknossos.dataset._array.DataFormat, num_channels: int, voxel_type: numpy.dtype, chunk_shape: webknossos.geometry.vec3_int.Vec3Int, chunks_per_shard: webknossos.geometry.vec3_int.Vec3Int, compression_mode: bool = False )
#   compression_mode: bool = False
#   class BaseArray(abc.ABC):

Helper class that provides a standard way to create an ABC using inheritance.

#   data_format = <DataFormat.WKW: 'wkw'>
#  
@classmethod
@abstractmethod
def open(_cls, path: pathlib.Path) -> webknossos.dataset._array.BaseArray:
#  
@classmethod
@abstractmethod
def create( cls, path: pathlib.Path, array_info: webknossos.dataset._array.ArrayInfo ) -> webknossos.dataset._array.BaseArray:
#  
@abstractmethod
def read( self, offset: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], shape: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]] ) -> numpy.ndarray:
#  
@abstractmethod
def write( self, offset: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], data: numpy.ndarray ) -> None:
#  
@abstractmethod
def ensure_size( self, new_shape: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], align_with_shards: bool = True, warn: bool = False ) -> None:
#  
@abstractmethod
def list_bounding_boxes(self) -> Iterator[webknossos.geometry.bounding_box.BoundingBox]:

The bounding boxes are measured in voxels of the current mag.

#  
@abstractmethod
def close(self) -> None:
#  
@staticmethod
def get_class( data_format: webknossos.dataset._array.DataFormat ) -> type[webknossos.dataset._array.BaseArray]:
#   class WKWArray(BaseArray):

Helper class that provides a standard way to create an ABC using inheritance.

#   WKWArray(path: pathlib.Path)
#   data_format = <DataFormat.WKW: 'wkw'>
#  
@classmethod
def open(cls, path: pathlib.Path) -> webknossos.dataset._array.WKWArray:
#  
@classmethod
def create( cls, path: pathlib.Path, array_info: webknossos.dataset._array.ArrayInfo ) -> webknossos.dataset._array.WKWArray:
#   def read( self, offset: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], shape: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]] ) -> numpy.ndarray:
#   def write( self, offset: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], data: numpy.ndarray ) -> None:
#   def ensure_size( self, new_shape: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], align_with_shards: bool = True, warn: bool = False ) -> None:
#   def list_bounding_boxes(self) -> Iterator[webknossos.geometry.bounding_box.BoundingBox]:

The bounding boxes are measured in voxels of the current mag.

#   def close(self) -> None:
Inherited Members
#   class ZarrArray(BaseArray):

Helper class that provides a standard way to create an ABC using inheritance.

#   ZarrArray(path: pathlib.Path)
#   data_format = <DataFormat.Zarr: 'zarr'>
#  
@classmethod
def open(cls, path: pathlib.Path) -> webknossos.dataset._array.ZarrArray:
#  
@classmethod
def create( cls, path: pathlib.Path, array_info: webknossos.dataset._array.ArrayInfo ) -> webknossos.dataset._array.ZarrArray:
#   def read( self, offset: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], shape: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]] ) -> numpy.ndarray:
#   def ensure_size( self, new_shape: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], align_with_shards: bool = True, warn: bool = False ) -> None:
#   def write( self, offset: Union[webknossos.geometry.vec3_int.Vec3Int, Tuple[int, int, int], numpy.ndarray, Iterable[int]], data: numpy.ndarray ) -> None:
#   def list_bounding_boxes(self) -> Iterator[webknossos.geometry.bounding_box.BoundingBox]:

The bounding boxes are measured in voxels of the current mag.

#   def close(self) -> None:
Inherited Members
Back to top