navis.read_parquet¶
- navis.read_parquet(f, read_meta=True, limit=None, subset=None, progress=True)[source]¶
Read parquet file into Neuron/List.
See here for format specifications.
- Parameters:
f (str) – File to be read.
read_meta (bool) – Whether to read neuron meta data stored in the parquet file (e.g. name or units). Defaults to True but can be switched off in case there are any issues.
limit (int, optional) – If reading from a file containing multiple neurons you can use this parameter to read only the first
limit
neurons. Useful if wanting to get a sample from a large library of neurons.subset (str | int | list thereof) – If the parquet file contains multiple neurons you can use this to select the IDs of the neurons to load. Only works if the parquet file actually contains multiple neurons.
- Returns:
navis.TreeNeuron/Dotprops – If parquet file contains a single neuron.
navis.NeuronList – If parquet file contains multiple neurons.
See also
navis.write_parquet()
Export neurons as parquet files.
navis.scan_parquet()
Scan parquet file for its contents.
Examples
See
navis.write_parquet()
for examples.