SynapseCriteria

class neuprint.queries.SynapseCriteria(matchvar='s', *, rois=None, type=None, confidence=None, primary_only=True, client=None)

Synapse selection criteria.

Specifies which fields to filter by when searching for Synapses. This class does not send queries itself, but you use it to specify search criteria for various query functions.

Except for matchvar, all parameters must be passed as keyword arguments.

Parameters

• matchvar (str) – An arbitrary cypher variable name to use when this SynapseCriteria is used to construct cypher queries.

• rois (str or list) – Optional. If provided, limit the results to synapses that reside within the given roi(s).

• type – If provided, limit results to either ‘pre’ or ‘post’ synapses.

• confidence (float, 0.0-1.0) – Limit results to synapses of at least this confidence rating. By default, use the dataset’s default synapse confidence threshold, which will include the same synapses that were counted in each neuron-neuron weight (as opposed to weightHP or weightHR).

• primary_only (boolean) –

  If True, only include primary ROI names in the results. Disable this with caution.

  Note

  This parameter does NOT filter by ROI. (See the rois argument for that.) It merely determines whether or not each synapse should be associated with exactly one ROI in the query output, or with multiple ROIs (one for every non-primary ROI the synapse intersects).

  If you set primary_only=False, then the table will contain duplicate entries for each synapse – one per intersecting ROI.

• client – Used to validate ROI names. If not provided, the global default Client will be used.