wkcuber._internal.utils

# &nbsp class WkwDatasetInfo(builtins.tuple):

WkwDatasetInfo(dataset_path, layer_name, mag, header)

# &nbsp WkwDatasetInfo(dataset_path, layer_name, mag, header)

Create new instance of WkwDatasetInfo(dataset_path, layer_name, mag, header)

# &nbsp dataset_path

Alias for field number 0

# &nbsp layer_name

Alias for field number 1

# &nbsp mag

Alias for field number 2

Inherited Members

builtins.tuple: index; count

# &nbsp class KnossosDatasetInfo(builtins.tuple):

KnossosDatasetInfo(dataset_path, dtype)

# &nbsp KnossosDatasetInfo(dataset_path, dtype)

Create new instance of KnossosDatasetInfo(dataset_path, dtype)

# &nbsp dataset_path

Alias for field number 0

# &nbsp dtype

Alias for field number 1

Inherited Members

builtins.tuple: index; count

# &nbsp class FallbackArgs(builtins.tuple):

FallbackArgs(distribution_strategy, jobs)

# &nbsp FallbackArgs(distribution_strategy, jobs)

Create new instance of FallbackArgs(distribution_strategy, jobs)

# &nbsp distribution_strategy

Alias for field number 0

# &nbsp jobs

Alias for field number 1

Inherited Members

builtins.tuple: index; count

# &nbsp def open_wkw(info: wkcuber._internal.utils.WkwDatasetInfo) -> wkw.wkw.Dataset:

# &nbsp def ensure_wkw(target_wkw_info: wkcuber._internal.utils.WkwDatasetInfo) -> None:

# &nbsp def parse_voxel_size(voxel_size: str) -> Tuple[float, ...]:

# &nbsp def parse_bounding_box(bbox_str: str) -> webknossos.geometry.bounding_box.BoundingBox:

# &nbsp def parse_padding(padding_str: str) -> Tuple[int, ...]:

# &nbsp class AsciiArgumentParser(argparse.ArgumentParser):

This class is a lightweight wrapper around ArgumentParser and checks that the shell command doesn't contain non-ascii characters since these can easily disturb the argument parsing.

If non-ascii characters are found, an error is raised. This behavior can be disabled by passing --allow-non-ascii on the command line.

# &nbsp IGNORE_FLAG = '--allow-non-ascii'

# &nbsp def parse_args( self, args: Union[Sequence[str], NoneType] = None, namespace: Union[argparse.Namespace, NoneType] = None ) -> Any:

Inherited Members

argparse.ArgumentParser: ArgumentParser; add_subparsers; parse_known_args; convert_arg_line_to_args; parse_intermixed_args; parse_known_intermixed_args; format_usage; format_help; print_usage; print_help; exit; error
argparse._ActionsContainer: register; set_defaults; get_default; add_argument; add_argument_group; add_mutually_exclusive_group

# &nbsp def open_knossos( info: wkcuber._internal.utils.KnossosDatasetInfo ) -> wkcuber._internal.knossos.KnossosDataset:

# &nbsp class DeprecatedSizeAction(argparse.Action):

Information about how to convert command line strings to Python objects.

Action objects are used by an ArgumentParser to represent the information needed to parse a single argument from one or more strings from the command line. The keyword arguments to the Action constructor are also all attributes of Action instances.

Keyword Arguments:

- option_strings -- A list of command-line option strings which
    should be associated with this action.

- dest -- The name of the attribute to hold the created object(s)

- nargs -- The number of command-line arguments that should be
    consumed. By default, one argument will be consumed and a single
    value will be produced.  Other values include:
        - N (an integer) consumes N arguments (and produces a list)
        - '?' consumes zero or one arguments
        - '*' consumes zero or more arguments (and produces a list)
        - '+' consumes one or more arguments (and produces a list)
    Note that the difference between the default and nargs=1 is that
    with the default, a single value will be produced, while with
    nargs=1, a list containing a single value will be produced.

- const -- The value to be produced if the option is specified and the
    option uses an action that takes no values.

- default -- The value to be produced if the option is not specified.

- type -- A callable that accepts a single string argument, and
    returns the converted value.  The standard Python types str, int,
    float, and complex are useful examples of such callables.  If None,
    str is used.

- choices -- A container of values that should be allowed. If not None,
    after a command-line argument has been converted to the appropriate
    type, an exception will be raised if it is not a member of this
    collection.

- required -- True if the action must always be specified at the
    command line. This is only meaningful for optional command-line
    arguments.

- help -- The help string describing the argument.

- metavar -- The name to be used for the option's argument with the
    help string. If None, the 'dest' value will be used as the name.

Inherited Members

argparse.Action: Action

# &nbsp class DeprecatedChunkSizeAction(argparse.Action):

Information about how to convert command line strings to Python objects.

Action objects are used by an ArgumentParser to represent the information needed to parse a single argument from one or more strings from the command line. The keyword arguments to the Action constructor are also all attributes of Action instances.

Keyword Arguments:

- option_strings -- A list of command-line option strings which
    should be associated with this action.

- dest -- The name of the attribute to hold the created object(s)

- nargs -- The number of command-line arguments that should be
    consumed. By default, one argument will be consumed and a single
    value will be produced.  Other values include:
        - N (an integer) consumes N arguments (and produces a list)
        - '?' consumes zero or one arguments
        - '*' consumes zero or more arguments (and produces a list)
        - '+' consumes one or more arguments (and produces a list)
    Note that the difference between the default and nargs=1 is that
    with the default, a single value will be produced, while with
    nargs=1, a list containing a single value will be produced.

- const -- The value to be produced if the option is specified and the
    option uses an action that takes no values.

- default -- The value to be produced if the option is not specified.

- type -- A callable that accepts a single string argument, and
    returns the converted value.  The standard Python types str, int,
    float, and complex are useful examples of such callables.  If None,
    str is used.

- choices -- A container of values that should be allowed. If not None,
    after a command-line argument has been converted to the appropriate
    type, an exception will be raised if it is not a member of this
    collection.

- required -- True if the action must always be specified at the
    command line. This is only meaningful for optional command-line
    arguments.

- help -- The help string describing the argument.

- metavar -- The name to be used for the option's argument with the
    help string. If None, the 'dest' value will be used as the name.

Inherited Members

argparse.Action: Action

# &nbsp def add_voxel_size_flag(parser: argparse.ArgumentParser, required: bool = True) -> None:

# &nbsp def add_isotropic_flag(parser: argparse.ArgumentParser) -> None:

# &nbsp def add_interpolation_flag(parser: argparse.ArgumentParser) -> None:

# &nbsp def add_sampling_mode_flag(parser: argparse.ArgumentParser) -> None:

# &nbsp def is_wk_compatible_layer_format(channel_count: int, dtype: str) -> bool:

# &nbsp def get_channel_and_sample_iters_for_wk_compatibility( channel_count: int, sample_count: int, dtype: str ) -> Tuple[Sequence, Sequence]:

# &nbsp def find_files( source_path: str, extensions: Iterable[str] ) -> Generator[pathlib.Path, Any, NoneType]:

# &nbsp def get_regular_chunks(min_z: int, max_z: int, chunk_size: int) -> Iterable[Iterable[int]]:

# &nbsp def add_distribution_flags(parser: argparse.ArgumentParser) -> None:

# &nbsp def add_batch_size_flag(parser: argparse.ArgumentParser) -> None:

# &nbsp def add_data_format_flags(parser: argparse.ArgumentParser) -> None:

# &nbsp def parse_path(value: str) -> pathlib.Path:

# &nbsp def pad_or_crop_to_size_and_topleft( cube_data: numpy.ndarray, target_size: numpy.ndarray, target_topleft: numpy.ndarray ) -> numpy.ndarray:

Given an numpy array and a target_size/target_topleft, the array will be padded so that it is within the bounding box descriped by topleft and size. If the input data is too large, the data will be cropped (evenly from opposite sides with the assumption that the most important data is in the center).

# &nbsp def convert_mag1_offset( mag1_offset: Union[List, numpy.ndarray], target_mag: webknossos.geometry.mag.Mag ) -> numpy.ndarray: