Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider Item Property Names #113

Open
vijayiyer05 opened this issue Jun 2, 2021 · 4 comments
Open

Consider Item Property Names #113

vijayiyer05 opened this issue Jun 2, 2021 · 4 comments
Assignees

Comments

@vijayiyer05
Copy link
Collaborator

vijayiyer05 commented Jun 2, 2021

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

Some considerations:

  • Grouping by categories used in dataset documentation (behavior, physiology, metadata), with prefixes and/or display
  • Grouping related properties with prefixes, e.g. fluorescene traces
  • Using a more familiar camel-casing style for MATLAB users
@kzhou085
Copy link
Collaborator

kzhou085 commented Aug 2, 2021

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
Copy link
Collaborator

kzhou085 commented Aug 9, 2021

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

@kzhou085
Copy link
Collaborator

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

@ehennestad
Copy link
Collaborator

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants