neuralib.deeplabcut.core.JointDataFrame

class neuralib.deeplabcut.core.JointDataFrame[source]

Bases: DataFrameWrapper

Dataframe from a specific joint

┌───────────┬────────────┬─────────────────┐
│ Nose_x    ┆ Nose_y     ┆ Nose_likelihood │
│ ---       ┆ ---        ┆ ---             │
│ f64       ┆ f64        ┆ f64             │
╞═══════════╪════════════╪═════════════════╡
│ 57.907318 ┆ 512.547424 ┆ 0.999679        │
│ 57.907318 ┆ 516.795288 ┆ 0.999688        │
│ 57.907318 ┆ 519.56311  ┆ 0.999449        │
│ 56.733799 ┆ 522.204224 ┆ 0.999161        │
│ 53.546089 ┆ 525.24939  ┆ 0.999518        │
│ …         ┆ …          ┆ …               │
│ 94.259621 ┆ 43.849434  ┆ 0.973851        │
│ 94.294357 ┆ 44.111595  ┆ 0.980125        │
│ 94.8013   ┆ 44.340511  ┆ 0.963981        │
│ 94.294357 ┆ 44.340511  ┆ 0.947905        │
│ 94.294357 ┆ 44.340511  ┆ 0.965436        │
└───────────┴────────────┴─────────────────┘

__init__(df)[source]

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.
`with_columns`(exprs, *named_exprs)	See polars.DataFrame.with_columns.
`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[source]

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