boilercv_pipeline.stages.find_objects

boilercv_pipeline.stages.find_objects#

Submodules#

Package Contents#

Classes#

Deps

Outs

DataStage

Dfs

Plots

Data

Cols

FindObjects

Find objects.

Data#

D

API#

class boilercv_pipeline.stages.find_objects.Deps(
/,
**data: context_models.types.Data,
)#

Bases: boilercv_pipeline.models.subcool.FilledDeps

stage: boilercv_pipeline.models.path.DirectoryPathSerPosix#

None

nb: boilercv_pipeline.models.path.DocsFile#

None

contours: boilercv_pipeline.models.path.DataDir#

None

class boilercv_pipeline.stages.find_objects.Outs(
/,
**data: context_models.types.Data,
)#

Bases: boilercv_pipeline.models.stage.DfsPlotsOuts

dfs: boilercv_pipeline.models.path.DataDir#

None

plots: boilercv_pipeline.models.path.DataDir#

None

class boilercv_pipeline.stages.find_objects.DataStage(
/,
**data: typing.Any,
)#

Bases: boilercv_pipeline.models.stage.DataStage

trackpy: str#

‘trackpy’

centroids: str#

‘centroids’

geo: str#

‘geo’

boilercv_pipeline.stages.find_objects.D#

‘DataStage(…)’

class boilercv_pipeline.stages.find_objects.Dfs(
/,
**data: typing.Any,
)#

Bases: boilercv_pipeline.models.data.Dfs

trackpy: pandas.DataFrame#

‘Field(…)’

centroids: pandas.DataFrame#

‘Field(…)’

geo: pandas.DataFrame#

‘Field(…)’

class boilercv_pipeline.stages.find_objects.Plots(
/,
**data: context_models.types.Data,
)#

Bases: boilercv_pipeline.models.data.Plots

composite: matplotlib.figure.Figure#

‘Field(…)’

class boilercv_pipeline.stages.find_objects.Data#

Bases: boilercv_pipeline.models.data.Data[boilercv_pipeline.stages.find_objects.Dfs, boilercv_pipeline.stages.find_objects.Plots]

dfs: boilercv_pipeline.stages.find_objects.Dfs#

‘Field(…)’

plots: boilercv_pipeline.stages.find_objects.Plots#

‘Field(…)’

class boilercv_pipeline.stages.find_objects.Cols(
/,
**data: typing.Any,
)#

Bases: boilercv_pipeline.models.columns.Cols

frame: Annotated[boilercv_pipeline.models.column.LinkedCol, boilercv_pipeline.models.column.Kind.idx, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D]#

‘LinkedCol(…)’

contour: Annotated[boilercv_pipeline.models.column.LinkedCol, boilercv_pipeline.models.column.Kind.idx, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D]#

‘LinkedCol(…)’

x: Annotated[boilercv_pipeline.models.column.LinkedCol, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D]#

‘LinkedCol(…)’

y: Annotated[boilercv_pipeline.models.column.LinkedCol, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D]#

‘LinkedCol(…)’

x_tp: boilercv_pipeline.models.column.LinkedCol#

‘LinkedCol(…)’

y_tp: boilercv_pipeline.models.column.LinkedCol#

‘LinkedCol(…)’

size: Annotated[boilercv_pipeline.models.column.LinkedCol, boilercv_pipeline.stages.find_objects.D]#

‘LinkedCol(…)’

centroid: Annotated[boilercv_pipeline.models.column.Col, boilercv_pipeline.stages.find_objects.D]#

‘Col(…)’

geometry: boilercv_pipeline.models.column.Col#

‘Col(…)’

area: Annotated[boilercv_pipeline.models.column.Col, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D]#

‘Col(…)’

diameter: Annotated[boilercv_pipeline.models.column.Col, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D]#

‘Col(…)’

radius_of_gyration: Annotated[boilercv_pipeline.models.column.Col, boilercv_pipeline.stages.find_objects.D, boilercv_pipeline.stages.find_objects.D]#

‘Col(…)’

approach_tp: boilercv_pipeline.models.column.ConstCol#

‘ConstCol(…)’

approach: boilercv_pipeline.models.column.ConstCol#

‘ConstCol(…)’

property trackpy: list[boilercv_pipeline.models.column.LinkedCol]#

All TrackPy columns.

property centroids: list[boilercv_pipeline.models.column.Col]#

All centroids columns.

property geo: list[boilercv_pipeline.models.column.Col]#

All geometry columns.

class boilercv_pipeline.stages.find_objects.FindObjects#

Bases: boilercv_pipeline.models.subcool.FilledParams[boilercv_pipeline.stages.find_objects.Deps, boilercv_pipeline.stages.find_objects.Outs, boilercv_pipeline.stages.find_objects.Data]

Find objects.

deps: Annotated[boilercv_pipeline.stages.find_objects.Deps, Arg(hidden=True)]#

‘Field(…)’

Stage dependencies.

outs: Annotated[boilercv_pipeline.stages.find_objects.Outs, Arg(hidden=True)]#

‘Field(…)’

Stage outputs.

data: Annotated[boilercv_pipeline.stages.find_objects.Data, Arg(hidden=True)]#

‘Field(…)’

Stage data.

cols: Annotated[boilercv_pipeline.stages.find_objects.Cols, Arg(hidden=True)]#

‘Field(…)’

Columns.

compare_with_trackpy: Annotated[bool, PairedArg('compare_with_trackpy')]#

False

Whether to get objects using the Trackpy approach.

guess_diameter: int#

21

Guess diameter for the Trackpy approach. (px)

contours: Annotated[list[pathlib.Path], Arg(hidden=True), AfterValidator(partial(validate_time_suffixed_paths, times_field='times', paths_field='deps', paths_subfield='contours', subfield_prefix=False))]#

‘Field(…)’

Paths to contours.

dfs: Annotated[list[pathlib.Path], Arg(hidden=True), AfterValidator(partial(validate_time_suffixed_paths, times_field='times', paths_field='outs', paths_subfield='dfs', prefix='objects'))]#

‘Field(…)’

Contents