← Back to API reference

neuralset.events.transforms.basic.QueryEvents

pydantic model neuralset.events.transforms.basic.QueryEvents

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.

Fields:

• query (Annotated[str, pydantic.functional_validators.AfterValidator(func=neuralset.base.validate_query)] | None)

field query: Annotated[str, AfterValidator(func=validate_query)] | None = None

requirements: tp.ClassVar[tuple[str, ...]] = ()

← Back to API reference