-
Notifications
You must be signed in to change notification settings - Fork 0
Retrieval
Support: Email || Guides: Installation | Getting started || Reference: General | Retrieval | Upload | Utilities
The G-Node MATLAB toolbox provides various functions for retrieving data from a remote location. All examples on this page presuppose a valid session object session. Consider the following set-up:
import gnode.*;
set_up_classpath();
session = init('default');Retrieves a single or multiple G-Node data store objects from the remote container. If possible (i.e., for objects not recently modified), a cached representation is returned. For several objects, use cell arrays of IDs. Return order is not guaranteed.
remote_object = get(session, 'analogsignal_947')returns a structure corresponding to form and content of the indicated data object.
remote_objects = get(session, {'analogsignal_47', 'block_5'})returns an array of objects corresponding to form and content of the indicated data objects.
Retrieves an exhaustive list of all objects of specified object type that are available in the specified session. A limit may be specified.
list = get_list(session, 'analogsignal', 100)returns a list of all available signals limited to 100 entries.
Retrieves multiple G-Node data store objects of given type between two numerical markers.
objects = get_range(session, 'analogsignal', 100, 500)returns all available signals between IDs 'analogsignal_100' and 'analogsignal_500'.
Convenience function. Wraps get() and strip() in a combined call, returning remote G-Node data store objects sans transmission/ownership information. Documentation for both applies.
clean_objects = get_stripped(session, 'analogsignal_947', 'analog signal')returns 'analogsignal_947' without extraneous information.
Combination of get_range()/strip(). Identical syntax and semantics apply.
clean_objects = get_stripped_range(session, 'analogsignal', 100, 104)returns all objects between 'analogsignal_100' and 'analogsignal_104' without extraneous information.
Convenience function that returns raw signal data only. Works with analogsignal, irssanalogsignal, spiketrain. Final parameter, 'named', determines whether the data arrays are to be returned as either
- a structure with field names corresponding to object names, or
- a cell array containing the data.
raw = get_detached(session, 'analogsignal_947')returns only signal data associated with remote object without meta-information.
raw = get_detached(session, obj_names, true)returns a struct whose fields correspond to signal data of specified remote objects. Field names are equivalent to object names.
Retrieves a top-level G-Node data store object and all its nested dependencies. That is, for an arbitrary object block_25, all connected objects (e.g., segments, signals, and so on) are fetched as well and stored inside the returned structure. This function operates recursively.
NB, for large data sets, this function can consume substantial resources (esp. bandwidth, time). Selective retrieval may be preferrable.
big_object = get_cascade(session, 'block_25')returns a structure containing all sub-objects of block_25.
Adds a retrieval job to the task queue. By calling get_all(), all tasks are performed in one go.
add_get(session, 'analogsignal_947');
add_get(session, 'analogsignal_948');
obj = get_all(session)now returns all queued signals.
Retrieves all objects placed in the task queue via add_get(). Order is not guaranteed. Jobs are deleted after each operation; successful completion therefore clears the queue.
add_get(session, 'analogsignal_947');
add_get(session, 'analogsignal_948');
obj = get_all(session)now returns all queued signals.
Empties the job queue (download) for this session.
clear_get(session)releases all queued retrieval requests.
Creates and retrieves a G-Node data store object in one procedure call. This is a thin wrapper on top of create()/ get(), so the respective documentation applies. Object type is optional, but not guaranteed to be guessed correctly.
new_object = get_created(session, obj, 'analog signal')creates and returns signal 'obj' on remote.
Retrieves object after performing a remote update; documentation for wrapped get()/update() functions applies.
updated_object = get_updated(session, modified_object, 'analogsignal_947')pushes changes to remote server and returns the stored object including successfully applied changes.
Support: Email || Guides: Installation | Getting started || Reference: General | Retrieval | Upload | Utilities