allensdk.api.queries.glif_api module

class allensdk.api.queries.glif_api.GlifApi(base_uri=None)

Bases: allensdk.api.queries.rma_template.RmaTemplate

GLIF_TYPES = [395310498, 395310469, 395310475, 395310479, 471355161]

NWB_FILE_TYPE = None

cache_stimulus_file(**kwargs)

DEPRECATED Download the NWB file for the current neuronal model and save it to a file.

Parameters:

output_file_name: string

File name to store the NWB file.

get_ephys_sweeps(**kwargs)

DEPRECATED Retrieve ephys sweep information out of downloaded metadata for a neuronal model

Returns:

list

A list of sweeps metadata dictionaries

get_neuron_config(**kwargs)

DEPRECATED Retrieve a model configuration file from the API, optionally save it to disk, and return the contents of that file as a dictionary.

Parameters:

output_file_name: string

File name to store the neuron configuration (optional).

get_neuron_configs(neuronal_model_ids=None)

get_neuronal_model(**kwargs)

DEPRECATED Query the current RMA endpoint with a neuronal_model id to get the corresponding well known files and meta data.

Returns:

dict

A dictionary containing

get_neuronal_model_templates()

get_neuronal_models(ephys_experiment_ids=None)

get_neuronal_models_by_id(neuronal_model_ids=None)

list_neuronal_models(**kwargs)

DEPRECATED Query the API for a list of all GLIF neuronal models.

Returns:

list

Meta data for all GLIF neuronal models.

rma_templates = {'glif_queries': [{'num_rows': 'all', 'count': False, 'model': 'NeuronalModelTemplate', 'name': 'neuronal_model_templates', 'description': 'see name'}, {'count': False, 'criteria_params': ['ephys_experiment_ids'], 'name': 'neuronal_models', 'criteria': '{% if ephys_experiment_ids is defined %}[id$in{{ ephys_experiment_ids }}]{%endif%}', 'num_rows': 'all', 'model': 'Specimen', 'include': 'neuronal_models(well_known_files,neuronal_model_template[id$in395310498,395310469,395310475,395310479,471355161],neuronal_model_runs(well_known_files))', 'description': 'see name'}, {'count': False, 'criteria_params': ['neuronal_model_ids'], 'name': 'neuron_config', 'criteria': '[id$in{{ neuronal_model_ids }}]', 'num_rows': 'all', 'model': 'NeuronalModel', 'include': 'well_known_files(well_known_file_type)', 'description': 'see name'}]}