Skip to content

doc: add docstrings with units #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.

Sign up for GitHub

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

Open
antoniaelsen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: add docstrings with units #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions include/science/libndtp/types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,16 @@ struct ElectricalBroadbandData {
std::vector<uint64_t> channel_data;
};

// data signedness
bool is_signed;

// bit width
uint32_t bit_width;

// sample rate in Hz
uint32_t sample_rate;

// first timestamp in microseconds
uint64_t t0;
std::vector<ChannelData> channels;

Expand All @@ -40,8 +47,13 @@ struct ElectricalBroadbandData {
* BinnedSpiketrainData represents spike count data.
*/
struct BinnedSpiketrainData {
// first timestamp in microseconds
uint64_t t0;

// bin size in milliseconds
uint8_t bin_size_ms;

// spike counts for a single bin for each channel
std::vector<uint8_t> spike_counts;

// Packs the data into a list of NDTP messages.
Expand Down