Skip to content

copick add object-volume

core

Add volume data to an existing pickable object.

Usage

copick add object-volume [OPTIONS]

Description

Loads a density map from disk and attaches it to an object that already exists in the project configuration. The volume format is inferred from the file extension unless --volume-format is given, and --voxel-size records the voxel size of the map in Angstrom.

Options

Option Type Default Description
-c, --config path Path to the configuration file.
--object-name text required Name of the existing object.
--volume-path text required Path to the volume file.
--volume-format choice (mrc | zarr) Format of the volume file ('mrc' or 'zarr'). Will guess from extension if not provided.
--voxel-size float Voxel size of the volume data in Angstrom.
--debug / --no-debug boolean flag False Enable debug logging.

Examples

# Attach an MRC density map to an existing object
copick add object-volume -c config.json --object-name ribosome \
    --volume-path data/ribosome_volume.mrc

# Attach a Zarr volume with an explicit voxel size
copick add object-volume -c config.json --object-name proteasome \
    --volume-path data/proteasome.zarr --voxel-size 8.0

See also