Public API

View Module Index

sire.stream.get_data_header(data)

Return the header data from the sire streamed data. If ‘data’ is a string then this is loaded from the appropriate file. Otherwise it will assume data is a binary array and will load directly from that.

sire.stream.get_header_property(key)

Return the global header value for the key ‘key’. Returns None if no value is set.

sire.stream.load(data)

Load the passed data from the sire streamed data format. If ‘data’ is a string, then this will load the appropriate file. Otherwise, it will assume data is a binary array, so will load the data directly from that.

sire.stream.save(obj, filename=None)

Save the passed object to the sire streamed data format. If ‘filename’ is passed then the data is written to this file. Otherwise the data is returned as a binary array.

sire.stream.set_header_property(key, value)

Set the global header value for key ‘key’ to the passed ‘value’. This will write this data into all sire streamed data files that are written from now on.