phys2bids.physio_obj.BlueprintOutput

class phys2bids.physio_obj.BlueprintOutput(timeseries, freq, ch_name, units, start_time, filename='')

Main output object for phys2bids.

Contains the blueprint to be exported.

timeseries

Numpy 2d array of timeseries Contains all the timeseries recorded. Impose same frequency!

Type:

(ch x tps) numpy.ndarray

freq

Shared frequency of the object.

Properties

Type:

float

ch_name

List of names of the channels - can be the header of the columns in the output files.

Type:

(ch) list of strings

units

List of the units of the channels.

Type:

(ch) list of strings

start_time

Starting time of acquisition (equivalent to first TR, or to the opposite sign of the time offset).

Type:

float

filename

Filename the object will be saved with. Init as empty string

Type:

string

ch_amount:

Property. Returns number of channels (ch).

return_index:

Returns the proper list entry of all the properties of the object, given an index.

delete_at_index:

Returns all the proper list entry of the properties of the object, given an index.

init_from_blueprint:

method to populate from input blueprint instead of init