CLI Reference

CLI Reference#

boilercv-pipeline#

Pipeline.

sync-dvc#

Generate `dvc.yaml`.

Help

  • -h--help: Show this message and exit.

stage#

Stage.

skip-cloud#

The outs of this stage are too large and unwieldy to cache or push to cloud storage.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

convert#

Convert CINEs to NetCDF.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

binarize#

Binarize videos and export their ROIs.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

preview-gray#

Update previews for grayscale videos.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

preview-binarized#

Update previews for the binarization stage.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

find-contours#

Get bubble contours.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

fill#

Fill bubble contours.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

preview-filled#

Update previews for the filled contours stage.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)

Help

  • -h--help: Show this message and exit.

get-thermal-data#

Update thermal data for the experiment.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)
  • --sample (2024-07-18T17-44-35)
  • --only-sample (False)
  • --include-patterns (['^.*2024-07-18.*$'])
  • --fit (Fit(fit_method='trf', independent_params=['x'], free_params=['T_s', 'q_s', 'h_a'], fixed_params=['h_w', 'r', 'T_infa', 'T_infw', 'x_s', 'x_wa', 'k'], bounds={'T_s': (0.001, inf), 'q_s': (-inf, inf), 'h_w': (0.001, inf), 'h_a': (0.001, inf), 'r': (2.220446049250313e-16, inf), 'T_infa': (0.001, inf), 'T_infw': (0.001, inf), 'x_s': (-inf, inf), 'x_wa': (-inf, inf), 'k': (2.220446049250313e-16, inf)}, values={'T_s': 105.0, 'q_s': 200000.0, 'h_w': 1.0, 'h_a': 1.0, 'r': 0.0047625, 'T_infa': 25.0, 'T_infw': 100.0, 'x_s': 0.0, 'x_wa': 0.0381, 'k': 400.0})): Model fit.
  • --load-src-from-outs (False): Load source columns from outputs.

Help

  • -h--help: Show this message and exit.

find-objects#

Find objects.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)
  • --sample (2024-07-18T17-44-35)
  • --only-sample (False)
  • --include-patterns (['^.*2024-07-18.*$'])
  • --dfs ([])
  • --frame-count (0)
  • --frame-step (1)
  • --slicer-patterns ({})
  • --filled ([])
  • --filled-slicers ([])
  • --compare-with-trackpy (False): Whether to get objects using the Trackpy approach.
  • --guess-diameter (21): Guess diameter for the Trackpy approach. (px)
  • --contours ([]): Paths to contours.

Help

  • -h--help: Show this message and exit.

find-tracks#

Export all tracks for this experiment.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)
  • --sample (2024-07-18T17-44-35)
  • --only-sample (False)
  • --include-patterns (['^.*2024-07-18.*$'])
  • --dfs ([])
  • --frame-count (0)
  • --frame-step (1)
  • --slicer-patterns ({})
  • --filled ([])
  • --filled-slicers ([])
  • --objects ([]): Paths to objects.

Help

  • -h--help: Show this message and exit.

get-mae#

Export all tracks for this experiment.

Options

  • --format (context={'boilercv_pipeline': BoilercvPipelineCtx(roots=Roots(data=PosixPath('data'), docs=PosixPath('docs')), kinds={}, track_kinds=False, sync_dvc=False, stages=[], dvc=DvcYamlModel(vars=[], stages={}, plots=[], params=[], metrics=[], artifacts={}), dvc_params={})} scale=1.3 marker_scale=20.0 precision=3 display_rows=12)
  • --sample (2024-07-18T17-44-35)
  • --only-sample (False)
  • --include-patterns (['^.*2024-07-18.*$'])
  • --tracks ([]): Paths to tracks.
  • --dfs ([]): Paths to data frame stage outputs.

Help

  • -h--help: Show this message and exit.

Help

  • -h--help: Show this message and exit.

Help

  • -h--help: Show this message and exit.
  • --completion: Use `–completion generate` to print shell-specific completion source.
Contents