Ticket/PSB-130: #2689
Ticket/PSB-130: #2689
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
| """ | ||
| Get the image stimulus name by parsing the file path of the image set. | ||
|
|
||
| If no image set, check for gratings and return behavior is not found. |
| @@ -44,7 +50,8 @@ def __init__(self, | |||
| stimulus: str, | |||
| stimulus_distribution: StimulusDistribution, | |||
| task_type: TaskType, | |||
| n_stimulus_frames: int): | |||
| n_stimulus_frames: int, | |||
| stimulus_name: str = Optional[None]): | |||
There was a problem hiding this comment.
think you meant Optional[str] = None ??
| @@ -104,6 +113,14 @@ def task(self) -> TaskType: | |||
| def n_stimulus_frames(self) -> int: | |||
| return self._n_stimulus_frames | |||
|
|
|||
| @property | |||
| def stimulus_name(self) -> int: | |||
There was a problem hiding this comment.
you have the type as Optional[str] above ??
| return self._stimulus_name | ||
|
|
||
| @property | ||
| def image_set(self) -> int: |
| @@ -63,3 +64,35 @@ def calculate_monitor_delay(sync_file: SyncFile, | |||
| warnings.warn(warning_msg) | |||
|
|
|||
| return delay | |||
|
|
|||
|
|
|||
| def get_image_stimulus_name(stimulus_file: BehaviorStimulusFile) -> str: | |||
There was a problem hiding this comment.
please add this as a method on BehaviorStimulusFile as there similar methods there
| @@ -44,7 +50,8 @@ def __init__(self, | |||
| stimulus: str, | |||
| stimulus_distribution: StimulusDistribution, | |||
| task_type: TaskType, | |||
| n_stimulus_frames: int): | |||
| n_stimulus_frames: int, | |||
| stimulus_name: str = Optional[None]): | |||
There was a problem hiding this comment.
looks like this can never be null so why is it optional ?
There was a problem hiding this comment.
When loading from an already created NWB file, this value will not exist hence the default of None.
| @@ -167,7 +185,8 @@ def from_stimulus_file( | |||
| stimulus=stimulus, | |||
| stimulus_distribution=stimulus_distribution, | |||
| task_type=task, | |||
| n_stimulus_frames=n_stimulus_frames | |||
| n_stimulus_frames=n_stimulus_frames, | |||
| stimulus_name=stimulus_name, | |||
There was a problem hiding this comment.
get rid of trailing comma !!
There was a problem hiding this comment.
But I like it 😅 (it's removed)
| @@ -273,6 +273,10 @@ class BehaviorTaskParametersSchema(RaisingSchema): | |||
| doc='Total number of stimuli frames', | |||
| required=True, | |||
| ) | |||
| stimulus_name = fields.String( | |||
| doc="Name of the stimulus file set presented", | |||
| required=False, | |||
| @@ -203,6 +203,38 @@ def session_type(self) -> str: | |||
| """ | |||
| return self._retrieve_from_params("stage") | |||
|
|
|||
| @property | |||
| def image_stimulus_name(self) -> str: | |||
There was a problem hiding this comment.
@morriscb How is this different from https://github.com/AllenInstitute/AllenSDK/blob/rc/2.15.2/allensdk/brain_observatory/behavior/behavior_project_cache/tables/util/metadata_parsers.py#L35 ? It might lead to discrepancies if we're using multiple code paths to grab the same thing ?
There was a problem hiding this comment.
The returns are slightly different here. The code you link returns the specific image set shown (e.g. image_A). The image_stimulus_name return gives the full name of the image file (e.g. Natural_Images_Lum_Matched_set_ophys_6_2017) so they are slightly different in their returns.
morriscb
force-pushed
the
ticket/PSB-130/dev
branch
from
52a5acf
to
a8ab031
Compare
| @@ -203,6 +203,38 @@ def session_type(self) -> str: | |||
| """ | |||
| return self._retrieve_from_params("stage") | |||
|
|
|||
| @property | |||
| def image_stimulus_name(self) -> str: | |||
There was a problem hiding this comment.
this should be named just stimulus_name since it might be e.g. gratings
morriscb
force-pushed
the
ticket/PSB-130/dev
branch
from
b0567fe
to
bd76a4d
Compare
Add
stimulus_nameandimage_setto task_parameters output.Move code block to produce
stimulus_nameto utility function.Update custom NWB schema.