From b2cd47953177a701b4f531528ad09c9a3f2aee40 Mon Sep 17 00:00:00 2001 From: MilagrosMarin Date: Tue, 3 Dec 2024 18:04:28 +0000 Subject: [PATCH] docs(add new images): updates for the second round of review --- ...datajoint_overview_data_stream_diagram.svg | 601 ++++++++---------- aeon/dj_pipeline/docs/notebooks/diagram.ipynb | 21 +- 2 files changed, 280 insertions(+), 342 deletions(-) diff --git a/aeon/dj_pipeline/docs/datajoint_overview_data_stream_diagram.svg b/aeon/dj_pipeline/docs/datajoint_overview_data_stream_diagram.svg index df4eee45..c41f2603 100644 --- a/aeon/dj_pipeline/docs/datajoint_overview_data_stream_diagram.svg +++ b/aeon/dj_pipeline/docs/datajoint_overview_data_stream_diagram.svg @@ -1,476 +1,407 @@ - - - - + + + + -RfidReader.Attribute - - -RfidReader.Attribute +UndergroundFeederDepletionState + + +UndergroundFeederDepletionState - + -UndergroundFeederRetriedDelivery - - -UndergroundFeederRetriedDelivery +UndergroundFeederEncoder + + +UndergroundFeederEncoder - + -UndergroundFeeder.RemovalTime - - -UndergroundFeeder.RemovalTime +StreamType + + +StreamType - - -WeightScaleWeightFiltered - - -WeightScaleWeightFiltered + + +DeviceType.Stream + + +DeviceType.Stream - - -Device - - -Device - - + + +StreamType->DeviceType.Stream + - - -UndergroundFeeder - - -UndergroundFeeder + + +Experiment + + +Experiment - - -Device->UndergroundFeeder - - - - -SpinnakerVideoSource - - -SpinnakerVideoSource + + +Chunk + + +Chunk - + -Device->SpinnakerVideoSource - +Experiment->Chunk + - - -RfidReader - - -RfidReader + + +Epoch + + +Epoch - + -Device->RfidReader - +Experiment->Epoch + - + WeightScale - - -WeightScale + + +WeightScale - + -Device->WeightScale - +Experiment->WeightScale + - - -SpinnakerVideoSource.Attribute - - -SpinnakerVideoSource.Attribute + + +UndergroundFeeder + + +UndergroundFeeder - - -SpinnakerVideoSourceVideo - - -SpinnakerVideoSourceVideo - - + + +Experiment->UndergroundFeeder + - - -RfidReaderRfidEvents - - -RfidReaderRfidEvents + + +Experiment.Directory + + +Experiment.Directory - - -Experiment - - -Experiment - - + + +Experiment->Experiment.Directory + - - -Experiment->UndergroundFeeder - + + +RfidReader + + +RfidReader + - - -Experiment->SpinnakerVideoSource - Experiment->RfidReader - + - + + +SpinnakerVideoSource + + +SpinnakerVideoSource + + + + -Experiment->WeightScale - +Experiment->SpinnakerVideoSource + - - -Chunk - - -Chunk + + +WeightScaleWeightRaw + + +WeightScaleWeightRaw - - -Experiment->Chunk - - - - -UndergroundFeeder.Attribute - - -UndergroundFeeder.Attribute + + +UndergroundFeederBeamBreak + + +UndergroundFeederBeamBreak - - -WeightScale.Attribute - - -WeightScale.Attribute + + +UndergroundFeederRetriedDelivery + + +UndergroundFeederRetriedDelivery - + + +Chunk->UndergroundFeederDepletionState + + + -UndergroundFeeder->UndergroundFeederRetriedDelivery - +Chunk->UndergroundFeederEncoder + - + -UndergroundFeeder->UndergroundFeeder.RemovalTime - +Chunk->WeightScaleWeightRaw + - + -UndergroundFeeder->UndergroundFeeder.Attribute - - - - -UndergroundFeederManualDelivery - - -UndergroundFeederManualDelivery - - +Chunk->UndergroundFeederBeamBreak + - + -UndergroundFeeder->UndergroundFeederManualDelivery - +Chunk->UndergroundFeederRetriedDelivery + - - -UndergroundFeederMissedPellet - - -UndergroundFeederMissedPellet + + +RfidReaderRfidEvents + + +RfidReaderRfidEvents - + -UndergroundFeeder->UndergroundFeederMissedPellet - +Chunk->RfidReaderRfidEvents + - - -UndergroundFeederDeliverPellet - - -UndergroundFeederDeliverPellet + + +SpinnakerVideoSourceVideo + + +SpinnakerVideoSourceVideo - + -UndergroundFeeder->UndergroundFeederDeliverPellet - +Chunk->SpinnakerVideoSourceVideo + - - -UndergroundFeederBeamBreak - - -UndergroundFeederBeamBreak + + +WeightScaleWeightFiltered + + +WeightScaleWeightFiltered - + -UndergroundFeeder->UndergroundFeederBeamBreak - +Chunk->WeightScaleWeightFiltered + - - -UndergroundFeederDepletionState - - -UndergroundFeederDepletionState + + +UndergroundFeederMissedPellet + + +UndergroundFeederMissedPellet - + -UndergroundFeeder->UndergroundFeederDepletionState - +Chunk->UndergroundFeederMissedPellet + - - -UndergroundFeederEncoder - - -UndergroundFeederEncoder + + +UndergroundFeederManualDelivery + + +UndergroundFeederManualDelivery - + -UndergroundFeeder->UndergroundFeederEncoder - - - - -WeightScaleWeightRaw - - -WeightScaleWeightRaw - - - - - -StreamType - - -StreamType - - +Chunk->UndergroundFeederManualDelivery + - - -DeviceType.Stream - - -DeviceType.Stream + + +UndergroundFeederDeliverPellet + + +UndergroundFeederDeliverPellet - + -StreamType->DeviceType.Stream - +Chunk->UndergroundFeederDeliverPellet + - + -SpinnakerVideoSource->SpinnakerVideoSource.Attribute - +Epoch->Chunk + - + -SpinnakerVideoSource->SpinnakerVideoSourceVideo - - - - -SpinnakerVideoSource.RemovalTime - - -SpinnakerVideoSource.RemovalTime - - +WeightScale->WeightScaleWeightRaw + - + -SpinnakerVideoSource->SpinnakerVideoSource.RemovalTime - - - - -DeviceType - - -DeviceType - - +WeightScale->WeightScaleWeightFiltered + - + -DeviceType->Device - +UndergroundFeeder->UndergroundFeederDepletionState + - + -DeviceType->DeviceType.Stream - +UndergroundFeeder->UndergroundFeederEncoder + - + -RfidReader->RfidReader.Attribute - +UndergroundFeeder->UndergroundFeederBeamBreak + - + -RfidReader->RfidReaderRfidEvents - - - - -RfidReader.RemovalTime - - -RfidReader.RemovalTime - - +UndergroundFeeder->UndergroundFeederRetriedDelivery + - + -RfidReader->RfidReader.RemovalTime - +UndergroundFeeder->UndergroundFeederMissedPellet + - + -WeightScale->WeightScaleWeightFiltered - +UndergroundFeeder->UndergroundFeederManualDelivery + - + -WeightScale->WeightScale.Attribute - +UndergroundFeeder->UndergroundFeederDeliverPellet + - + -WeightScale->WeightScaleWeightRaw - - - - -WeightScale.RemovalTime - - -WeightScale.RemovalTime - +Experiment.Directory->Chunk + - - + -WeightScale->WeightScale.RemovalTime - +Experiment.Directory->Epoch + - + + +Device + + +Device + + + + -Chunk->UndergroundFeederRetriedDelivery - +Device->WeightScale + - + -Chunk->WeightScaleWeightFiltered - +Device->UndergroundFeeder + - + -Chunk->SpinnakerVideoSourceVideo - +Device->RfidReader + - + -Chunk->RfidReaderRfidEvents - +Device->SpinnakerVideoSource + - + + +DeviceType + + +DeviceType + + + + -Chunk->UndergroundFeederManualDelivery - +DeviceType->DeviceType.Stream + - + -Chunk->WeightScaleWeightRaw - +DeviceType->Device + - + -Chunk->UndergroundFeederMissedPellet - +RfidReader->RfidReaderRfidEvents + - + -Chunk->UndergroundFeederDeliverPellet - - - - -Chunk->UndergroundFeederBeamBreak - - - - -Chunk->UndergroundFeederDepletionState - - - - -Chunk->UndergroundFeederEncoder - +SpinnakerVideoSource->SpinnakerVideoSourceVideo + \ No newline at end of file diff --git a/aeon/dj_pipeline/docs/notebooks/diagram.ipynb b/aeon/dj_pipeline/docs/notebooks/diagram.ipynb index 5de05e3c..c16763fb 100644 --- a/aeon/dj_pipeline/docs/notebooks/diagram.ipynb +++ b/aeon/dj_pipeline/docs/notebooks/diagram.ipynb @@ -113,13 +113,20 @@ "outputs": [], "source": [ "# data streams\n", - "\n", - "data_stream_diagram = (\n", - " dj.Diagram(streams) + \n", - " acquisition.Experiment\n", - ")\n", - "\n", - "data_stream_diagram" + "data_stream_diagram =(\n", + " dj.Diagram(streams) \n", + " - streams.SpinnakerVideoSource.RemovalTime\n", + " - streams.SpinnakerVideoSource.Attribute\n", + " - streams.UndergroundFeeder.Attribute\n", + " - streams.UndergroundFeeder.RemovalTime\n", + " - streams.RfidReader.Attribute\n", + " - streams.RfidReader.RemovalTime\n", + " - streams.WeightScale.Attribute\n", + " - streams.WeightScale.RemovalTime\n", + " + acquisition.Experiment\n", + " + acquisition.Epoch\n", + " ) \n", + "data_stream_diagram " ] }, {