sarkit.cphd.Reader.read_signal

Reader.read_signal(channel_identifier, *, start_vector=None, stop_vector=None, out=None)

Read signal data from a CPHD file

Parameters:

channel_identifierstr

Channel unique identifier

start_vectorint or None, optional

Lowest vector index to retrieve (inclusive). If None, defaults to first vector.

stop_vectorint or None, optional

Highest vector index to retrieve (exclusive). If None, defaults to one after last vector.

outndarray or None, optional

Array to store signal data. If None, a new array will be created.

Returns:

ndarray

Signal array identified by channel_identifier

When standard, shape=(stop_vector - start_vector, NumSamples), dtype determined by SignalArrayFormat.

When compressed, shape=(CompressedSignalSize,), dtype= numpy.uint8

Notes

start_vector and stop_vector are not supported when signal data is compressed