Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

sdynpy.signal_processing.sdynpy_buffer.CircularBufferWithOverlap

Signature

class sdynpy.signal_processing.sdynpy_buffer.CircularBufferWithOverlap(buffer_size, block_size, overlap_size, dtype='float', data_shape=())

Methods

NameSummary
__init__Initialize the circular buffer.
read
report_buffer_state
writeWrite a block of data to the circular buffer.
write_get_dataWrites a block of data and then returns a block if available

__init__

def sdynpy.signal_processing.sdynpy_buffer.CircularBufferWithOverlap.__init__(self, buffer_size, block_size, overlap_size, dtype='float', data_shape=())

Initialize the circular buffer.

Parameters:

read

def sdynpy.signal_processing.sdynpy_buffer.CircularBufferWithOverlap.read(self, read_remaining=False)

report_buffer_state

def sdynpy.signal_processing.sdynpy_buffer.CircularBufferWithOverlap.report_buffer_state(self)

write

def sdynpy.signal_processing.sdynpy_buffer.CircularBufferWithOverlap.write(self, data)

Write a block of data to the circular buffer.

Parameters:

write_get_data

def sdynpy.signal_processing.sdynpy_buffer.CircularBufferWithOverlap.write_get_data(self, data, read_remaining=False)

Writes a block of data and then returns a block if available

Parameters: