MitoCriteria

class neuprint.queries.MitoCriteria(matchvar='m', *, rois=None, mitoType=None, size=0, primary_only=True, client=None)

Mitochondrion selection criteria.

Specifies which fields to filter by when searching for mitochondria. 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 MitoCriteria is used to construct cypher queries.

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

• mitoType – If provided, limit the results to mitochondria of the specified type. Either dark, medium, or light. (Neuroglancer users: Note that in the hemibrain mito segmentation, medium=3)

• size – Specifies a minimum size (in voxels) for mitochondria returned in the results.

• 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 mitochondrion should be associated with exactly one ROI in the query output, or with multiple ROIs (one for every non-primary ROI the mitochondrion intersects).

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

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