docs(update notebook): 📝 update diagram.ipynb after internal review

SainsburyWellcomeCentre · Dec 3, 2024 · 7761864 · 7761864
1 parent bd77e25
commit 7761864
Showing 1 changed file with 57 additions and 24 deletions.
diff --git a/aeon/dj_pipeline/docs/notebooks/diagram.ipynb b/aeon/dj_pipeline/docs/notebooks/diagram.ipynb
@@ -71,16 +71,26 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# `acquisition`-related tasks\n",
+    "# acquisition-related tasks\n",
     "acquisition_diagram = (\n",
-    "    dj.Diagram(acquisition.Experiment) +\n",
-    "    dj.Diagram(acquisition.ExperimentCamera) +\n",
-    "    dj.Diagram(acquisition.Epoch) +\n",
-    "    dj.Diagram(acquisition.Chunk) +\n",
-    "    dj.Diagram(acquisition.EventType) +\n",
-    "    dj.Diagram(acquisition.Environment) +\n",
-    "    dj.Diagram(block_analysis.BlockDetection)\n",
-    ") - 1\n",
+    "    dj.Diagram(lab.Location) +\n",
+    "    lab.Arena +\n",
+    "    acquisition.ExperimentType +\n",
+    "    subject.Subject +\n",
+    "    acquisition.Experiment.Subject +\n",
+    "    acquisition.Experiment +\n",
+    "    acquisition.Epoch +\n",
+    "    acquisition.EpochConfig +\n",
+    "    acquisition.Chunk +\n",
+    "    acquisition.Environment +\n",
+    "    acquisition.Environment.SubjectWeight +\n",
+    "    acquisition.Environment.EnvironmentState +\n",
+    "    acquisition.Environment.SubjectState +\n",
+    "    acquisition.Environment.MessageLog +\n",
+    "    acquisition.Environment.SubjectVisits +\n",
+    "    acquisition.Environment.BlockState +\n",
+    "    acquisition.Environment.LightEvents\n",
+    " ) - dj.Diagram(acquisition.Experiment)\n",
     "\n",
     "acquisition_diagram"
    ]
@@ -105,14 +115,9 @@
     "# data streams\n",
     "\n",
     "data_stream_diagram = (\n",
-    "    dj.Diagram(subject.SubjectDetail) + \n",
-    "    dj.Diagram(subject.PyratCommentWeightProcedure) + \n",
-    "    dj.Diagram(streams.WeightScaleWeightFiltered) + \n",
-    "    dj.Diagram(streams.Device) + \n",
-    "    dj.Diagram(streams.UndergroundFeeder) + \n",
-    "    dj.Diagram(qc.CameraQC) +\n",
-    "    dj.Diagram(tracking.SLEAPTracking)\n",
-    ") - 1\n",
+    "    dj.Diagram(streams) + \n",
+    "    acquisition.Experiment\n",
+    ")\n",
     "\n",
     "data_stream_diagram"
    ]
@@ -127,6 +132,33 @@
     "data_stream_diagram.save(\"aeon/dj_pipeline/docs/datajoint_overview_data_stream_diagram.svg\")"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8d3f7a66",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Pyrat-related tables\n",
+    "\n",
+    "pyrat_diagram = (\n",
+    "    dj.Diagram(subject.SubjectDetail) + \n",
+    "    subject.PyratCommentWeightProcedure\n",
+    ") - 1\n",
+    "\n",
+    "pyrat_diagram"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8ff44b6f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pyrat_diagram.save(\"aeon/dj_pipeline/docs/datajoint_overview_pyrat_related_diagram.svg\")"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "ff290db9",
@@ -145,13 +177,14 @@
     "# analysis tables\n",
     "analysis_diagram = (\n",
     "    dj.Diagram(analysis.Visit) +\n",
-    "    dj.Diagram(analysis.OverlapVisit.Visit) +\n",
-    "    dj.Diagram(block_analysis.Block) +\n",
-    "    dj.Diagram(block_analysis.BlockAnalysis) +\n",
-    "    dj.Diagram(block_analysis.BlockSubjectAnalysis.Preference) +\n",
-    "    dj.Diagram(block_analysis.BlockForaging) +\n",
-    "    dj.Diagram(block_analysis.BlockPatchPlots) +\n",
-    "    dj.Diagram(block_analysis.BlockSubjectPositionPlots) \n",
+    "    analysis.OverlapVisit.Visit +\n",
+    "    block_analysis.Block +\n",
+    "    block_analysis.BlockAnalysis +\n",
+    "    block_analysis.BlockSubjectAnalysis.Preference +\n",
+    "    block_analysis.BlockSubjectAnalysis.Patch +\n",
+    "    block_analysis.BlockForaging +\n",
+    "    block_analysis.BlockPatchPlots +\n",
+    "    block_analysis.BlockSubjectPositionPlots \n",
     ") - 1\n",
     "\n",
     "analysis_diagram"