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

Export of NeXus Data visualization should contain all data #1619

Open
Blackclaws opened this issue Apr 19, 2024 · 5 comments
Open

Export of NeXus Data visualization should contain all data #1619

Blackclaws opened this issue Apr 19, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@Blackclaws
Copy link

Is your feature request related to a problem?

Right now when viewing an NXdata group that contains a line plot with auxiliary signals the export function only exports the main dataset which is usually not what you would want as you're interested in all the data.

Requested solution or feature

Customize the export to csv feature so that you can select which data should be included.

@Blackclaws Blackclaws added the enhancement New feature or request label Apr 19, 2024
@loichuder
Copy link
Member

Yea, I think it makes sense to export the auxiliary datasets as additional CSV columns.

We could provide two options:

  • Export only the signal (current status of the export)
  • Export all data (signal + aux. signals)

Would that work for you ?

@Blackclaws
Copy link
Author

That sounds good! I think we also need to include the X Axes in the export as the first column as that is usually also needed to plot the data in other programs meaningfully.

In general I would say if error datasets are also available those should get exported as well.

@loichuder
Copy link
Member

In general I would say if error datasets are also available those should get exported as well.

Yeah, good point 👍

@loichuder loichuder self-assigned this Apr 29, 2024
@axelboc
Copy link
Contributor

axelboc commented Apr 29, 2024

Merging the datasets into a single CSV is a very specific need, in my opinion. It doesn't work with some of the other export formats, with 2D visualizations, etc. It also opens the door to discussions about the order of the columns, whether the columns should be named or not, etc.

I do agree that the "Export" feature needs to be made available for NeXus visualizations, but perhaps the exact implementation can be left to the consumer app? That being said, we could provide a default ZIP export, at least with the h5grove provider, since this wouldn't require much change to the endpoint (it would just need to accept multiple dataset paths).

Maybe this issue is also a good opportunity to address the typing limitations of the current getExportURL API: #1063 (comment).

@Blackclaws
Copy link
Author

I do agree that the "Export" feature needs to be made available for NeXus visualizations, but perhaps the exact implementation can be left to the consumer app? That being said, we could provide a default ZIP export, at least with the h5grove provider, since this wouldn't require much change to the endpoint (it would just need to accept multiple dataset paths).

What would the consumer app be in the case of the VSCode extension? The VSCode host? In which case what would the export functionality look like there? I think a general feature where you could have a csv file that exports the signals in the same order as they appear within the signal / auxiliary signal field would be the most common as that is also an already established order, so:

XAxesValue, SignalValue, SignalError, Aux_1 Signal, Aux_1 Error, etc...

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

No branches or pull requests

3 participants