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

Change class name UclaMiniscopeV4CameraFrame -> UclaMiniscopeV4CameraDataFrame #379

Open
cjsha opened this issue Dec 6, 2024 · 3 comments · May be fixed by #380
Open

Change class name UclaMiniscopeV4CameraFrame -> UclaMiniscopeV4CameraDataFrame #379

cjsha opened this issue Dec 6, 2024 · 3 comments · May be fixed by #380
Assignees
Labels
proposal Request for a new feature

Comments

@cjsha
Copy link
Member

cjsha commented Dec 6, 2024

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.

@cjsha cjsha self-assigned this Dec 6, 2024
@cjsha cjsha linked a pull request Dec 6, 2024 that will close this issue
@aacuevas aacuevas added the proposal Request for a new feature label Dec 9, 2024
@aacuevas
Copy link
Collaborator

aacuevas commented Dec 9, 2024

There apparently was a discussion about why this particular operator had a different name.
If this is the case, we should at least document in the code the rationale for not adhering to the convention.

@jonnew
Copy link
Member

jonnew commented Jan 3, 2025

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.

@glopesdev
Copy link
Collaborator

glopesdev commented Jan 3, 2025

@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).

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

Successfully merging a pull request may close this issue.

4 participants