make_volume_packaging - jaybgager/tracertools GitHub Wiki

This function creates a local file structure to hold a neuroglancer volume in the specified directory. Primarily a utility function used by other functions that create local volumes.

[!NOTE] This function doesn't work on Windows OS due to the volume format requiring colons : in several file names, which is prohibited on Windows. Currently there's no way around this limitation.

Arguments:

• output_path (string, mandatory)
  • the absolute path to the folder where you want to create the mesh, e.g. home/username/ng_meshes
• resolution (list of integers, optional, default=[1,1,1])
  • the voxel scale in nanometers of the datastack the mesh belongs to, e.g. [4,4,45] for brain_and_nerve_cord
  • this info can be obtained using get_config
• chunk_size (list of integers, optional, default=[512,512,16])
  • the size of the chunks in voxels for the datastack the mesh belongs to
• volume_size (list of integers, optional, default=[250000,250000,25000])
  • the size of the entire volume in voxels

Returns:

• creates volume packaging at specified location

Example

The code below creates an empty neuroglancer volume called image in the directory /home/user/volumes.

INPUT:

import tracertools as tt

tt.make_volume_packaging(
    output_path="/home/user/volumes",
)