neuralib.tracking.facemap.core.KeyPointDataFrame

class neuralib.tracking.facemap.core.KeyPointDataFrame[source]

Bases: DataFrameWrapper

Dataframe with x, y, likelihood and keypoint columns

┌────────────┬────────────┬────────────┬───────────┐
│ x          ┆ y          ┆ likelihood ┆ keypoint  │
│ ---        ┆ ---        ┆ ---        ┆ ---       │
│ f32        ┆ f32        ┆ f32        ┆ str       │
╞════════════╪════════════╪════════════╪═══════════╡
│ 374.102081 ┆ 199.159668 ┆ 0.777443   ┆ eye(back) │
│ 373.785919 ┆ 199.425873 ┆ 0.787424   ┆ eye(back) │
│ 374.075867 ┆ 199.507111 ┆ 0.779713   ┆ eye(back) │
│ 374.028473 ┆ 199.359955 ┆ 0.761724   ┆ eye(back) │
│ 374.222382 ┆ 199.777466 ┆ 0.770329   ┆ eye(back) │
│ …          ┆ …          ┆ …          ┆ …         │
│ 317.318756 ┆ 285.396912 ┆ 0.596486   ┆ mouth     │
│ 318.163696 ┆ 285.492676 ┆ 0.589684   ┆ mouth     │
│ 317.758606 ┆ 285.560425 ┆ 0.603126   ┆ mouth     │
│ 317.453491 ┆ 285.572235 ┆ 0.573179   ┆ mouth     │
│ 317.976196 ┆ 285.477051 ┆ 0.58359    ┆ mouth     │
└────────────┴────────────┴────────────┴───────────┘

__init__(df)[source]

Parameters:: df (DataFrame)

Methods

`__init__`(df)
`clear`([n])	See polars.DataFrame.clear.
`clone`()	Clone the wrapper.
`dataframe`([dataframe, may_inplace])	Getter/setter for the internal Polars DataFrame.
`drop`(*columns[, strict])	See polars.DataFrame.drop.
`drop_nulls`(subset)	See polars.DataFrame.drop_nulls.
`fill_nan`([value])	See polars.DataFrame.fill_nan.
`fill_null`([value, strategy, limit])	See polars.DataFrame.fill_null.
`filter`(predicates, *constraints)	See polars.DataFrame.filter.
`group_by`(*by[, maintain_order])	See polars.DataFrame.group_by.
`head`([n])	See polars.DataFrame.head.
`join`(other, on, args, *kwargs)	See polars.DataFrame.join.
`lazy`()	Wrap dataframe in a lazy wrapper.
`limit`([n])	See polars.DataFrame.limit.
`partition_by`(by, *more_by[, as_dict])	See polars.DataFrame.partition_by.
`pipe`(function, args, *kwargs)	See polars.DataFrame.pipe.
`rename`(mapping)	See polars.DataFrame.rename.
`select`(exprs, *named_exprs)	See polars.DataFrame.select.
`slice`(offset[, length])	See polars.DataFrame.slice.
`sort`(by, more_by, *kwargs)	See polars.DataFrame.sort.
`tail`([n])	See polars.DataFrame.tail.
`to_zscore`()	xy to zscore
`with_columns`(exprs, *named_exprs)	See polars.DataFrame.with_columns.
`with_outlier_filter`([filter_window, ...])	with outlier filter
`with_row_index`([name, offset])	See polars.DataFrame.with_row_index.

Attributes

`columns`	See polars.DataFrame.columns.
`schema`	See polars.DataFrame.schema.

__init__(df)[source]

Parameters:: df (DataFrame)

dataframe(dataframe=None, may_inplace=True)[source]

Getter/setter for the internal Polars DataFrame.

Parameters:

dataframe (DataFrame | None) – Optional new dataframe to set.
may_inplace – If True, update current instance. Otherwise, return new instance.

Returns:

The current dataframe or a modified wrapper instance.

to_zscore()[source]

xy to zscore

Returns:
Return type:: Self

with_outlier_filter(filter_window=15, baseline_window=50, max_spike=25, max_diff=25)[source]

with outlier filter

Parameters:

filter_window (int)
baseline_window (int)
max_spike (int)
max_diff (int)

Returns:

Return type:

Self

clear(n=5)

See polars.DataFrame.clear.

Parameters:: n (int)
Return type:: Self

clone()

Clone the wrapper.

Return type:: Self

property columns: list[str]: See polars.DataFrame.columns.

drop(*columns, strict=True)

See polars.DataFrame.drop.

Parameters:

columns (pty.ColumnNameOrSelector | Iterable[pty.ColumnNameOrSelector])
strict (bool)

Return type:

Self

drop_nulls(subset)

See polars.DataFrame.drop_nulls.

Parameters:: subset (pty.ColumnNameOrSelector | Collection[pty.ColumnNameOrSelector])
Return type:: Self

fill_nan(value=None)

See polars.DataFrame.fill_nan.

Parameters:: value (pl.Expr | int | float | None)
Return type:: Self

fill_null(value=None, strategy=None, limit=None, **kwargs)

See polars.DataFrame.fill_null.

Parameters:

value (Any | pl.Expr | None)
strategy (pty.FillNullStrategy | None)
limit (int | None)

Return type:

Self

filter(*predicates, **constraints)

See polars.DataFrame.filter.

Parameters:

predicates (pty.IntoExprColumn | Iterable[pty.IntoExprColumn] | bool | list[bool] | np.ndarray)
constraints (Any)

Return type:

Self

group_by(*by, maintain_order=False, **named_by)

See polars.DataFrame.group_by.

Parameters:

by (pty.IntoExpr | Iterable[pty.IntoExpr])
maintain_order (bool)
named_by (pty.IntoExpr)

Return type:

GroupBy

head(n=5)

See polars.DataFrame.head.

Parameters:: n (int)
Return type:: Self

join(other, on, *args, **kwargs)

See polars.DataFrame.join.

Parameters:: other (pl.DataFrame | DataFrameWrapper)
Return type:: Self

lazy()

Wrap dataframe in a lazy wrapper.

Return type:: LazyDataFrameWrapper[Self]

limit(n=5)

See polars.DataFrame.limit.

Parameters:: n (int)
Return type:: Self

partition_by(by, *more_by, as_dict=False, **kwargs): See polars.DataFrame.partition_by.

pipe(function, *args, **kwargs)

See polars.DataFrame.pipe.

Parameters:

function (Callable[Concatenate[pl.DataFrame, P], pl.DataFrame])
args (P.args)
kwargs (P.kwargs)

Return type:

Self

rename(mapping)

See polars.DataFrame.rename.

Parameters:: mapping (dict[str, str] | Callable[[str], str])
Return type:: Self

property schema: Schema: See polars.DataFrame.schema.

select(*exprs, **named_exprs)

See polars.DataFrame.select.

Parameters:

exprs (pty.IntoExpr | Iterable[pty.IntoExpr])
named_exprs (pty.IntoExpr)

Return type:

Self

slice(offset, length=None)

See polars.DataFrame.slice.

Parameters:

offset (int)
length (int | None)

Return type:

Self

sort(by, *more_by, **kwargs)

See polars.DataFrame.sort.

Return type:: Self

tail(n=5)

See polars.DataFrame.tail.

Parameters:: n (int)
Return type:: Self

with_columns(*exprs, **named_exprs)

See polars.DataFrame.with_columns.

Parameters:

exprs (pty.IntoExpr | Iterable[pty.IntoExpr])
named_exprs (pty.IntoExpr)

Return type:

Self

with_row_index(name='index', offset=0)

See polars.DataFrame.with_row_index.

Parameters:

name (str)
offset (int)

Return type:

Self