Skip to content

README.md

Latest commit

 

History

History
145 lines (117 loc) · 8.44 KB

README.md

File metadata and controls

145 lines (117 loc) · 8.44 KB
Raw

LabKit Apps

LabKit apps are independent MATLAB tools for complete laboratory workflows. Choose an app by the result you need, then use its app page for supported inputs, controls, interaction behavior, calculations, outputs, recovery, and programmatic APIs.

Start An App

Open labkit_launcher, select one app, and choose Open. The launcher's Documentation and History action opens the selected app page.

Source-checkout users can also call an app command after adding LabKit to the MATLAB path:

labkit_launcher
% Or, after repository path setup:
labkit_CIC_app

See Getting Started for installation, updating, version selection, and source-checkout setup. The LabKit Launcher manual documents its complete interactive and programmatic surface.

Choose An App

Task App Input Principal output
Discover, install, launch, diagnose, and package LabKit apps LabKit Launcher Installed or source LabKit tree Running app, maintenance report, or deployment ZIP
Register, crop, and mask image pairs for DIC DIC Preprocess Reference and moving images Aligned images, crops, mask
Render and summarize Ncorr strain results DIC Postprocess Ncorr MAT, reference image, mask Strain overlays and summary CSV
Overlay chrono voltage and current traces Chrono Overlay Chrono DTA Plot and CSV
Measure charge-injection capacity CIC Chrono DTA CIC result table and CSV
Compare cyclic and time-domain CSC CSC CV/CT DTA Per-cycle CSC and CV data
Inspect impedance curves EIS EIS DTA Nyquist/Bode plots and CSV
Estimate voltage-transient resistance VT Resistance Chrono DTA Resistance table and CSV
Convert tracked points into gait metrics Gait Analysis Current Video Marker project MAT Frame, step, coordinate, and summary tables
Crop image batches at repeatable geometry Batch Image Crop Image files Same-size crops and manifest
Measure curve radius, curvature, and length Curvature Measurement Image Overlay and measurement CSV
Decode and measure radiometric images FLIR Thermal FLIR radiometric image Temperature data, measurements, rendered image
Fuse focal planes Focus Stack Aligned image stack Fused image and focus map
Apply a repeatable enhancement pipeline Image Enhance Image files Enhanced images and manifest
Match appearance to a reference image Image Match Source and reference images Matched images and manifest
Annotate ordered landmarks across video Video Marker Video Project MAT and coordinate CSV
Restyle figures and export visible plot data Figure Studio FIG or popout axes Styled figure and plot data
Inspect RHS recordings and define channels RHS Preview RHS file or folder Preview, protocol JSON, filter record
Detect trains and measure neural responses Nerve Response Analysis Filter record and protocol JSON Analysis JSON and CAP metrics
Review aligned responses and statistics Response Review and Stats Analysis JSON or segment CSV Metrics CSV and summary
Compare multiple groups with the first using t-tests and one mean/SD plot T-Test Wizard CSV, TSV, workbook, or entered values Result family, CSVs, and comparison plot
Inspect ECG and measure segment SNR ECG Print MAT or delimited table ROI timetable, segment SNR CSV, and waveform image

Browse By Family

  • DIC - preparation and postprocessing around a DIC solver.
  • Electrochemistry - DTA-based chrono, CV/CT, impedance, charge, and resistance workflows.
  • Gait - pose-coordinate analysis and gait metrics.
  • Image Measurement - calibrated image, thermal, annotation, crop, fusion, and appearance workflows.
  • LabKit Core - the launcher and general MATLAB graphics tools.
  • Neurophysiology - RHS inspection, response analysis, and review.
  • Statistics - explicit first-versus-each t-tests and result-based group plotting.
  • Wearable - wearable biosignal workflows.

How To Read An App Page

Concrete app pages use a common MATLAB-style order:

  1. purpose, requirements, and launch command;
  2. supported inputs and the shortest successful workflow;
  3. controls and interaction behavior;
  4. calculation or algorithm semantics, units, and assumptions;
  5. outputs, project files, autosave, and recovery behavior;
  6. GUI-free MATLAB examples and public app-owned APIs;
  7. errors, limitations, troubleshooting, related topics, and history.

The app page documents stable user-visible behavior. Exact callable syntax and data shapes live on the linked API reference pages. Internal callbacks and private implementation helpers are intentionally omitted.

Shared framework contracts are documented once in the App Framework, not repeated in every App page. An App page mentions shared behavior only when that App changes it or when the behavior is necessary to complete the App's workflow.

Common App Behavior

The App Framework owns lifecycle, busy state, file selection, state snapshots, screenshot actions, plot tools, and managed interactions. Apps own scientific choices, workflow-specific defaults, result schemas, and exports. See the App Framework for behavior shared across apps.

Every App opens as a clean project. Use Tools > Diagnostics to inspect the current session history or export a diagnostic bundle after a problem. Manual TRACE capture is controlled inside the Session Log window. Apps with declared sample generation expose Tools > Developer Tools > Generate Synthetic Inputs...; generation writes anonymous inputs without loading them or changing the open project. The runtime guide defines these shared contracts.

Action and input-selection buttons provide concise hover help. The shared Tools menu contains plot, screenshot, and project-state actions when the corresponding capability is available.

Input data and exported results should remain outside the replaceable LabKit runtime folder. Apps do not overwrite source files unless an app page states an explicit in-place operation.

Programmatic Use

Important scientific and deterministic app operations can be called without opening the GUI. Each app page identifies its supported app-owned functions and links them to the generated API Reference. Reusable file parsers and generic processing functions live in the public labkit.* libraries.

MATLAB must be able to see both the repository root and the owning app root. The launcher prepares these paths automatically. In a source checkout, add them explicitly before calling an app package:

repoRoot = "/path/to/LabKit-MATLAB-Workbench";
addpath(repoRoot)
addpath(fullfile(repoRoot, "apps", "electrochem", "cic"))

help cic.analysisRun.computeCIC

For another app, replace the final app path with the directory that directly contains its +package folder. Do not add every repository subfolder with genpath; app roots are independent and may contain same-named private or development files that should not become global MATLAB commands.

Related Documentation