AQNWB Namespace Reference

The main namespace for AqNWB. More...

Namespaces
namespace	HDF5
	Namespace for all components of the HDF5 I/O backend.
namespace	NWB
	Namespace for all classes related to the NWB data standard.
namespace	SPEC

Classes
class	BaseDataType
	Represents a base data type. More...
class	BaseIO
	The BaseIO class is an abstract base class that defines the interface for input/output (IO) operations on a file. More...
class	BaseRecordingData
	The base class to represent recording data that can be extended. More...
class	Channel
	Class for storing acquisition system channel information. More...
class	Types
	Provides definitions for various types used in the project. More...

Functions
std::string	generateUuid ()
	Generates a UUID (Universally Unique Identifier) as a string.
std::string	getCurrentTime ()
	Get the current time in ISO 8601 format with the UTC offset.
std::shared_ptr< BaseIO >	createIO (const std::string &type, const std::string &filename)
	Factory method to create an IO object.
void	convertFloatToInt16LE (const float *source, void *dest, int numSamples)
	Method to convert float values to uint16 values. This method was adapted from JUCE AudioDataConverters using a default value of destBytesPerSample = 2.
std::unique_ptr< int16_t[]>	transformToInt16 (SizeType numSamples, float conversion_factor, const float *data)
	Method to scale float values and convert to int16 values.

Detailed Description

The main namespace for AqNWB.

Function Documentation

convertFloatToInt16LE()

void AQNWB::convertFloatToInt16LE ( const float * source, void * dest, int numSamples )

inline

Method to convert float values to uint16 values. This method was adapted from JUCE AudioDataConverters using a default value of destBytesPerSample = 2.

Parameters

source	The source float data to convert
dest	The destination for the converted uint16 data
numSamples	The number of samples to convert

Here is the caller graph for this function:

createIO()

std::shared_ptr< BaseIO > AQNWB::createIO ( const std::string & type, const std::string & filename )

inline

Factory method to create an IO object.

Returns

A pointer to a BaseIO object

generateUuid()

std::string AQNWB::generateUuid ( )

inline

Generates a UUID (Universally Unique Identifier) as a string.

Returns

The generated UUID as a string.

Here is the caller graph for this function:

getCurrentTime()

std::string AQNWB::getCurrentTime ( )

inline

Get the current time in ISO 8601 format with the UTC offset.

Returns

The current time as a string in ISO 8601 format.

Here is the caller graph for this function:

transformToInt16()

std::unique_ptr< int16_t[]> AQNWB::transformToInt16 ( SizeType numSamples, float conversion_factor, const float * data )

inline

Method to scale float values and convert to int16 values.

Parameters

numSamples	The number of samples to convert
conversion_factor	The conversion factor to scale the data
data	The data to convert

Here is the call graph for this function: