-
Notifications
You must be signed in to change notification settings - Fork 3
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
Change class name UclaMiniscopeV4CameraFrame
-> UclaMiniscopeV4CameraDataFrame
#379
Comments
There apparently was a discussion about why this particular operator had a different name. |
The rational, maybe flawed, was that it is common for people to talk about "Camera Frames" when they are they are thinking about some matrix of values that forms a picture. Camera Data Frames sounds clunky in comparison. In other cases, there is no common phrase -- e.g. people don't have a preconceived idea about what a Neuropixels Frame is. |
@jonnew @cjsha the only counter argument I can see is that a "camera frame" is usually understood as something which is itself an image (i.e. which can be plotted directly), whereas in this case, this object is not by itself an image, but instead contains an "Image" field (among other metadata) which is what is used for saving and visualisation. The above rationale is also why in other Bonsai camera packages we use the suffix "DataFrame" rather than "Frame", so this change could also be potentially more recognisable by the community (although this of course is definitely more of a subjective assessment). |
@glopesdev that's true. I'm ambivalent here. @cjsha if you feel its clearer go ahead and change but make sure you do the back compatibility work in #380 discussion. |
I think after working on the docs, I have an expectation about how things are named. If something catches me by surprise, I figure it's worth mentioning, but not necessarily worth changing. My expectation might not match the user's expectation. The way to be consistent with how Bonsai does things and the nomenclature pattern then would be to change the name of operator from Then again, it seems practical that all data i/o operators appear when searching the word "Data"?
|
This was a big reason of why we chose to adopt the common suffix
It seems like As for This concept of matching a device to a single data stream is embedded in the ONI standard itself where each device can have at most a single stream for reading frames from device to host, and at most a single stream to write frames from host to device: I guess we could have used This points to an idea for a compromise convention which is simultaneously more informative and backwards-compatible:
Using this convention you could leave most devices as they are and rename the following operators:
The convention is informative since when you see a node called simply |
This name change suggestion is to adhere to our naming convention. The operator is
UclaMiniscopeV4CameraData
so its corresponding frame should be appended by "Frame":UclaMiniscopeV4CameraDataFrame
.The text was updated successfully, but these errors were encountered: