neuralset.events.transforms.basic.QueryEvents¶

class neuralset.events.transforms.basic.QueryEvents(*, infra: Backend | None = None, query: Annotated[str, AfterValidator(func=validate_query)] | None = None)[source][source]¶

Filter events based on a pandas query, with auto-generated index columns.

See query_with_index() for details on index column resolution.

Example:

# Filter by subject name
QueryEvents(query='subject == "Subject1"')

# Keep only the first 2 subjects
QueryEvents(query="subject_index < 2")

# Keep only the first timeline per subject
QueryEvents(query="subject_timeline_index < 1")

Parameters:: query (Query | None) – A pandas query string (see base.Query) that may reference *_index columns. If None, returns events unchanged.