MATLAB-Community-Toolboxes-at-INCF / Brain-Observatory-Toolbox

A MATLAB toolbox for interacting with the Allen Brain Observatory
BSD 2-Clause "Simplified" License
20 stars 2 forks source link

Consider Item Property Names #113

Open vijayiyer05 opened 3 years ago

vijayiyer05 commented 3 years ago

Working collaboratively between backend and frontend teams, seek to converge on and implement the best Item property names.

Some considerations:

kzhou085 commented 3 years ago

The property listing the types of stimuli present in a session are different across the ephys and ophys sessions (stimulus_name vs stimulus_list), and the return values are also in different formats.

kzhou085 commented 3 years ago

The stimulus properties .stimulus_block_id and .stimulus_block_condition_id could be made more informative by changing "block" to "epoch."

kzhou085 commented 3 years ago

The stimulus epoch property differs in name across the ephys and ophys sessions (stimulus_epochs vs stimulus_epoch_table).

ehennestad commented 8 months ago

Example incorporating the ideas of the first post of this issue:


 Experiment (VisualBehavior) with properties:

                             id: 951980471
                           info: [1×1 struct]
                    SessionType: OPHYS_1_images_A
                LinkedFilesInfo: dictionary (string ⟼ string) with 1 entry

   Linked Items
                      Container: [6×32 table]
                        Session: [1×1 bot.behavior.item.OphysSession]
                          Cells: [12×4 table]

   Linked NWB Data (NWB Metadata)
                       Metadata: [1x1 struct]              (on-demand)
                 SubjectDetails: [1x1 struct]              (on-demand)
                 TaskParameters: [1x1 struct]              (on-demand)
         EyeTrackingRigGeometry: [1x1 struct]              (on-demand)
            TwoPhotonParameters: [1x1 struct]              (on-demand)

   Linked NWB Data (Behavior)
                          Licks: [3178x1 timetable]        (on-demand)
                        Rewards: [71x2 timetable]          (on-demand)
                    EyeTracking: [135805x15 timetable]     (on-demand)
                   RunningSpeed: [270053x1 timetable]      (on-demand)

   Linked NWB Data (Intervals)
                  StimulusTimes: [270053x1 duration]       (on-demand)
           StimulusPresentation: [4633x1 timetable]        (on-demand)
                         Trials: [759x22 table]            (on-demand)

   Linked NWB Data (Stimulus)
              StimulusTemplates: [8x2 table]               (on-demand)

   Linked NWB Data (Physiology)
              CellSpecimenTable: [12x13 table]             (on-demand)
           FovAverageProjection: [512x512 uint8]           (on-demand)
           FovMaximumProjection: [512x512 uint8]           (on-demand)
          SegmentationMaskImage: [512x512 int64]           (on-demand)
     FluorescenceTracesNeuropil: [48316x1 timetable]       (on-demand)
    FluorescenceTracesCorrected: [48316x1 timetable]       (on-demand)
      FluorescenceTracesDemixed: [48316x1 timetable]       (on-demand)
          FluorescenceTracesDFF: [48316x1 timetable]       (on-demand)
             FluorescenceEvents: [48316x1 timetable]       (on-demand)
               MotionCorrection: [48316x2 timetable]       (on-demand)