neuralib.facemap.core.KeyPointDataFrame

class neuralib.facemap.core.KeyPointDataFrame

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)

Parameters:

df (DataFrame)

Methods

__init__(df)
clear([n])	See polars.DataFrame.clear.
clone()	Clone the wrapper.
dataframe(-> ~polars.dataframe.frame.DataFrame)	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[, how, left_on, right_on, ...])	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[, descending, nulls_last, ...])	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)

Parameters:

df (DataFrame)

dataframe() → DataFrame

dataframe(dataframe: DataFrame, may_inplace: bool = True) → Self

Getter/setter for the internal Polars DataFrame.

Parameters:

• dataframe (DataFrame | None) – Optional new dataframe to set.

• may_inplace (bool) – If True, update current instance. Otherwise, return new instance.

Returns:

The current dataframe or a modified wrapper instance.

Return type:

DataFrame | Self

to_zscore()

xy to zscore

Returns:

Return type:

Self

with_outlier_filter(filter_window=15, baseline_window=50, max_spike=25, max_diff=25)

with outlier filter

Parameters:

• filter_window (int)

• baseline_window (int)

• max_spike (int)

• max_diff (int)

Returns:

Return type:

Self