Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
zarr-vectors
Logo
zarr-vectors

Getting Started

  • Installation
  • Quickstart
  • Core concepts
  • Frequently asked questions

Specification

  • Specification
    • Zarr v3 primer
    • Store types and the backend layer
    • Dimensionality
    • Codec pipeline
    • Directory structure
    • Root metadata
    • Level groups
    • Chunk arrays
    • Fragment-index arrays
    • Chunk shape
    • Bin shape
    • Chunk vs bin
    • Rechunking
    • Sharding
    • Multiscale metadata
    • Pyramid construction
    • Object sparsity
    • Geometry types
      • Point cloud (point_cloud)
      • Line (line)
      • Polyline (polyline)
      • Streamline (streamline)
      • Graph (graph)
      • Skeleton (skeleton)
      • Mesh (mesh)
    • Fragments
    • Object manifest
    • Links and cross-chunk links
    • Object attributes
    • Validation overview
    • ZVF and Neuroglancer precomputed
    • ZVF and TRX format
    • ZVF and OME-Zarr
    • Spec change process
    • Adding a new geometry type
    • Compliance testing

Tutorials

  • Point clouds
  • Polylines and streamlines
  • Graphs and skeletons
  • Meshes
  • Building multi-resolution pyramids
  • Lazy loading
  • Cloud stores
  • Validation and repair
  • Neuroglancer integration overview
  • Installing zv-ngtools
  • LocalNeuroglancer — Python API
  • Shell console (nglocal)
  • Layer management API

API Reference

  • API Reference
    • zarr_vectors
    • Geometry types
    • Lazy loading
    • Spatial utilities
    • Validation
    • Constants
    • Type aliases

How-To Guides

  • Choosing chunk shape and bin shape
  • Memory-efficient writes
  • HPC pipelines
  • How to cite

Benchmarks

  • Benchmarks
Back to top
View this page
Edit this page

API Reference¶

The API reference is auto-generated from docstrings using sphinx.ext.autodoc. All public functions, classes, and constants are documented here.

  • zarr_vectors
  • Geometry types
  • Lazy loading
  • Spatial utilities
  • Validation
  • Constants
  • Type aliases
Next
zarr_vectors
Previous
Layer management API
Copyright © 2024, BRIDGE Neuroscience. Aligned to the Zarr Vectors specification by Forest Collman, Allen Institute for Brain Sciences.
Made with Sphinx and @pradyunsg's Furo