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

File writing modes: proposed changes for R3-0. #73

Open
MarkRivers opened this issue Mar 5, 2015 · 1 comment
Open

File writing modes: proposed changes for R3-0. #73

MarkRivers opened this issue Mar 5, 2015 · 1 comment
Assignees
Milestone

Comments

@MarkRivers
Copy link
Member

MarkRivers commented Mar 5, 2015

Currently NDPluginFile has the following controls:

FileWriteMode: [Single, Stream, Capture]

Autosave: Automatically save each image in Single mode or the entire capture buffer in Capture mode.

Save: Saves the last array received in Single mode or saves the entire capture buffer in Capture mode

NumCapture: Number of frames to capture or stream

Capture: Start/stop saving files in Capture mode or start/stop streaming files to disk in Stream mode.

These controls are not intuitive, many users get confused. They also add a lot of complexity to the NDPluginFile base class. The Capture mode functionality (saving NDArrays in a memory buffer) is really no longer needed now that the QueueSize in plugins can now be changed dynamically at runtime. The NDCircularBuffer plugin can also be used in some applications where the Capture mode was previously used.

Proposed change:

Eliminate FileWriteMode

Eliminate Autosave

Retain Save, it will start/stop file saving

Rename NumCapture to NumSave. It defines the total number of NDArrays to save. If it is <=0 then file saving will continue until Save is set to 0.

Add NumArraysPerFile. It defines the number of NDArrays per file.

With these changes the number of arrays per file can be defined independently of the total number of arrays to save. This allows saving single arrays per file with HDF5 and netCDF, for example which is not currently possible.

This change will require changes to many clients so it will need to be a major release of ADCore.

@MarkRivers MarkRivers self-assigned this Mar 5, 2015
@MarkRivers
Copy link
Member Author

The proposed change will also eliminate the Capture record, Save replaces its functionality.

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

2 participants