Skip to content

Deprecate ndi.app.oridirtuning in favor of ndi.calc.vis.oridir_tuning #1001

Description

@stevevanhooser

Summary

Deprecate ndi.app.oridirtuning (pre-calculator-framework app) and route new users to ndi.calc.vis.oridir_tuning (VH-Lab/NDIcalc-vis-matlab). The app exists mainly to service legacy datasets, which the V_eta migration handles independently. Team decision 2026-09-17. Follows #200 (2021), which established ndi.calc.vis.oridir_tuning as the calculator-framework replacement.

Scope

  • Not a removal, yet. Standard deprecation cycle: warning at construction, tutorials rewritten, class kept in place for one release.
  • Legacy datasets are covered. V_eta migration folds existing orientation_direction_tuning documents — whether written by this app or by the calculator — into the oridirtuning_calc leaf family. Migration path (P) in the DID-schema calculator-restructure discussion, 2026-09-17.

Tasks

  1. Add a deprecation warning to src/ndi/+ndi/+app/oridirtuning.m's constructor, pointing at ndi.calc.vis.oridir_tuning.
  2. Rewrite the tutorial to teach the calculator instead of the app:
    • src/ndi/+ndi/+example/+tutorial/tutorial_02_04.m:126 — oapp = ndi.app.oridirtuning(S); and downstream usage.
    • src/ndi/docs/NDI-matlab/tutorials/analyzing_first_physiology_experiment/4_analyzing_tuning_curves.md:142, :149 — same, in the user-facing tutorial.
  3. Class removal is a later cycle, tracked separately.

Evidence

Sweep on origin/main (2026-09-17), DENOMINATOR: whole repo tree.

  • Only non-calculator writer of orientation_direction_tuning docs. git grep "ndi.document('orientation_direction_tuning'" origin/main returns exactly one call site: src/ndi/+ndi/+app/oridirtuning.m:205. Every other producer is the calculator on NDIcalc-vis-matlab.
  • Live in-repo callers of the app class, both in tutorial code/documentation:
    • src/ndi/+ndi/+example/+tutorial/tutorial_02_04.m:126 — oapp = ndi.app.oridirtuning(S);
    • src/ndi/docs/NDI-matlab/tutorials/analyzing_first_physiology_experiment/4_analyzing_tuning_curves.md:142, :149
  • Calculator-framework successor is stable. +ndi/+calc/+vis/oridir_tuning.m on VH-Lab/NDIcalc-vis-matlab writes documents of class oridirtuning_calc (superclasses [calculator, orientation_direction_tuning]), used in three published papers per Lepsky et al. 2026 §3.3 (Reikersdorfer et al. 2021, Griswold & Gazelle 2025, Casanova et al. 2025).

Context

Surfaced during the V_eta calculator-motif restructure (DID-schema + NDIcalc-vis-matlab), which is aligning V_eta with Lepsky et al. 2026 (bioRxiv 2026.04.27.721136) §3.2 / Fig. 2F / Fig. 4. Related cleanup filed 2026-09-17: VH-Lab/NDIcalc-vis-matlab#107 (removal of dead stimloopsplitter_calc schema).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions