NeuroMorphoQuery

class braincell.io.NeuroMorphoQuery(species=None, brain_region=None, cell_type=None, archive=None, original_format=None, stain=None, age_classification=None, gender=None, raw_q=<factory>, raw_fq=<factory>)

Typed builder for NeuroMorpho.Org search queries.

Each non-raw field becomes a Solr clause that is ANDed together. Multi-value fields produce (field:a OR field:b) clauses. Use raw_q and raw_fq to append filter strings verbatim

when you need a Solr feature this builder doesn’t expose.

Parameters:

• species (str | tuple[str, ...] | None) – Filter on the species field.

• brain_region (str | tuple[str, ...] | None) – Filter on the brain_region field.

• cell_type (str | tuple[str, ...] | None) – Filter on the cell_type field.

• archive (str | tuple[str, ...] | None) – Filter on the archive field.

• original_format (str | tuple[str, ...] | None) – Filter on the original_format field.

• stain (str | tuple[str, ...] | None) – Filter on the stain field.

• age_classification (str | tuple[str, ...] | None) – Filter on the age_classification field.

• gender (str | tuple[str, ...] | None) – Filter on the gender field.

• raw_q (tuple[str, ...]) – Extra clauses appended verbatim to the q parameter.

• raw_fq (tuple[str, ...]) – Extra filter strings appended verbatim to fq.

Examples

>>> q = NeuroMorphoQuery(species="mouse", brain_region="cerebellum")
>>> q.to_q()
'species:mouse AND brain_region:cerebellum'
>>> q.to_fq()
[]

>>> multi = NeuroMorphoQuery(species=("mouse", "rat"))
>>> multi.to_q()
'(species:mouse OR species:rat)'

to_fq()

Return the fq filter list for /api/neuron/select.

Currently only raw_fq populates this list; the typed fields all flow through q. The method exists so callers and the CLI can pass through fq strings without special-casing.

Return type:

list[str]

to_params()

Return q/fq packaged as a kwargs dict.

Returns:

{"q": ..., "fq": [...]} ready to be unpacked into NeuroMorphoClient.search().

Return type:

dict[str, object]

to_q()

Return the assembled q parameter for /api/neuron/select.

Returns:

"*:*" when no filters were specified, otherwise an AND-joined string of clauses.

Return type:

str