copick convert picks2plane

utils

Convert picks to plane meshes.

Plugin command — copick-utils

This command is provided by the copick-utils plugin, not copick core. Install it to make this command available:

pip install copick-utils

See the plugin system guide for details.

copick convert picks2plane input — Input

copick convert picks2plane output — Output

Convert picks to plane meshes.

Usage

copick convert picks2plane [OPTIONS]

Description

Fits a best-fit plane through each set of picks and emits it as a rectangular planar mesh sized to cover the points. The --padding factor scales the plane beyond the exact point extent (1.0 = exact fit, >1.0 = larger plane).

Picks can be clustered first (DBSCAN or k-means) so that distinct groups of points each get their own plane; combined with --individual-meshes this writes one mesh per cluster using the {instance_id} placeholder in the output URI.

URI Format

Picks: object_name:user_id/session_id
Meshes: object_name:user_id/session_id

Options

Option	Type	Default	Description
`-c, --config`	path	—	Path to the configuration file.
`--debug / --no-debug`	boolean flag	`False`	Enable debug logging.

Input Options

Option	Type	Default	Description
`--run-names, -r`	text · multiple	—	Specific run names to process (default: all runs).
`--input, -i`	COPICK_URI	required	Input picks URI (format: object_name:user_id/session_id). Supports glob patterns.

Tool Options

Option	Type	Default	Description
`--padding`	float	`1.2`	Padding factor for plane size (1.0=exact fit, >1.0=larger plane).
`--use-clustering, -cl / --no-use-clustering`	boolean flag	`False`	Cluster points before mesh creation.
`--clustering-method`	choice (dbscan \| kmeans)	`dbscan`	Clustering method.
`--clustering-eps`	float	`1.0`	DBSCAN eps parameter - maximum distance between points in a cluster (in angstroms).
`--clustering-min-samples`	integer	`3`	DBSCAN min_samples parameter.
`--clustering-n-clusters`	integer	`1`	K-means n_clusters parameter.
`--all-clusters, -mm / --largest-cluster-only`	boolean flag	`True`	Use all clusters (True) or only the largest cluster (False).
`--workers, -w`	integer	`8`	Number of worker processes.

Output Options

Option	Type	Default	Description
`--output, -o`	COPICK_URI	required	Output mesh URI. Supports smart defaults (e.g., "membrane", "membrane/my-session", or "/my-session"). Full format: object_name:user_id/session_id.
`--individual-meshes, -im / --no-individual-meshes`	boolean flag	`False`	Create individual meshes for each instance (enables {instance_id} placeholder).

Examples

# Convert single pick set to single plane mesh
copick convert picks2plane -i "membrane:user1/manual-001" -o "membrane:picks2plane/plane-001"

# Create individual plane meshes from clusters
copick convert picks2plane -i "membrane:user1/manual-001" \
    -o "membrane:picks2plane/plane-{instance_id}" --individual-meshes

# Convert all manual picks using pattern matching
copick convert picks2plane -i "membrane:user1/manual-.*" -o "membrane:picks2plane/plane-{input_session_id}"