pynbody.filt.Filter

class pynbody.filt.Filter

Bases: object

Base class for all filters. Filters are callables that take simulations as input and return a boolean mask

Methods

__call__(sim)	Return a boolean mask indicating which particles are in the filter.
cubic_cell_intersection(centroids)	Compute the intersection with cubic cells with the specified centroids.
where(sim)	Return the indices of particles that are in the filter.

__init__(*args, **kwargs)

cubic_cell_intersection(centroids)

Compute the intersection with cubic cells with the specified centroids.

This is currently used by the swift loader to figure out which cells to load

where(sim: snapshot.SimSnap)

Return the indices of particles that are in the filter.

This is a convenience method that is equivalent to np.where(f(sim)) but may be more efficient for some filters.