Object Graph Mapping

Neuroarch data models.

class neuroarch.models.Aggregator(**kwargs)

element_plural = 'Aggregators'

element_type = 'Aggregator'

registry_name = 'Aggregator'

registry_plural = 'Aggregators'

class neuroarch.models.AlphaSynapse(**kwargs)

element_plural = 'AlphaSynapses'

element_type = 'AlphaSynapse'

link_post = None

link_pre = 'spike_state'

registry_name = 'AlphaSynapse'

registry_plural = 'AlphaSynapses'

class neuroarch.models.ArborizationData(**kwargs)

axons = <pyorient.ogm.property.EmbeddedMap object>

dendrites = <pyorient.ogm.property.EmbeddedMap object>

element_plural = 'ArborizationDatas'

element_type = 'ArborizationData'

name = <pyorient.ogm.property.String object>

registry_name = 'ArborizationData'

registry_plural = 'ArborizationDatas'

synapses = <pyorient.ogm.property.EmbeddedMap object>

type = <pyorient.ogm.property.String object>

uname = <pyorient.ogm.property.String object>

class neuroarch.models.ArborizesIn(**kwargs)

N_axons = <pyorient.ogm.property.Integer object>

N_dendrites = <pyorient.ogm.property.Integer object>

kind = <pyorient.ogm.property.EmbeddedSet object>

label = 'ArborizesIn'

registry_name = 'ArborizesIn'

registry_plural = 'ArborizesIn'

class neuroarch.models.AxonHillockModel(**kwargs)

element_plural = 'AxonHillockModels'

element_type = 'AxonHillockModel'

registry_name = 'AxonHillockModel'

registry_plural = 'AxonHillockModels'

class neuroarch.models.BioNode(**kwargs)

element_plural = 'BioNodes'

element_type = 'BioNode'

registry_name = 'BioNode'

registry_plural = 'BioNodes'

class neuroarch.models.BioSensor(**kwargs)

element_plural = 'BioSensors'

element_type = 'BioSensor'

name = <pyorient.ogm.property.String object>

registry_name = 'BioSensor'

registry_plural = 'BioSensors'

class neuroarch.models.BufferPhoton(**kwargs)

element_plural = 'Bufferphotons'

element_type = 'BufferPhoton'

registry_name = 'BufferPhoton'

registry_plural = 'Bufferphotons'

class neuroarch.models.BufferVoltage(**kwargs)

element_plural = 'BufferVoltages'

element_type = 'BufferVoltage'

registry_name = 'BufferVoltage'

registry_plural = 'BufferVoltages'

class neuroarch.models.CRModel(**kwargs)

element_plural = 'CRModels'

element_type = 'CRModel'

registry_name = 'CRModel'

registry_plural = 'CRModels'

class neuroarch.models.Cartridge(**kwargs)

element_plural = 'Cartridges'

element_type = 'Cartridge'

name = <pyorient.ogm.property.String object>

registry_name = 'Cartridge'

registry_plural = 'Cartridges'

class neuroarch.models.CartridgeModel(**kwargs)

element_plural = 'CartridgeModels'

element_type = 'CartridgeModel'

registry_name = 'CartridgeModel'

registry_plural = 'CartridgeModels'

class neuroarch.models.Circuit(**kwargs)

element_plural = 'Circuits'

element_type = 'Circuit'

name = <pyorient.ogm.property.String object>

registry_name = 'Circuit'

registry_plural = 'Circuits'

class neuroarch.models.CircuitDiagram(**kwargs)

diagrams = <pyorient.ogm.property.EmbeddedMap object>

element_plural = 'CircuitDiagrams'

element_type = 'CircuitDiagram'

name = <pyorient.ogm.property.String object>

registry_name = 'CircuitDiagram'

registry_plural = 'CircuitDiagrams'

submodules = <pyorient.ogm.property.EmbeddedMap object>

version = <pyorient.ogm.property.String object>

class neuroarch.models.CircuitModel(**kwargs)

element_plural = 'CircuitModels'

element_type = 'CircuitModel'

name = <pyorient.ogm.property.String object>

registry_name = 'CircuitModel'

registry_plural = 'CircuitModels'

class neuroarch.models.Column(**kwargs)

element_plural = 'Columns'

element_type = 'Column'

name = <pyorient.ogm.property.String object>

registry_name = 'Column'

registry_plural = 'Columns'

class neuroarch.models.ColumnModel(**kwargs)

element_plural = 'ColumnModels'

element_type = 'ColumnModel'

registry_name = 'ColumnModel'

registry_plural = 'ColumnModels'

class neuroarch.models.DataSource(**kwargs)

description = <pyorient.ogm.property.String object>

element_plural = 'DataSources'

element_type = 'DataSource'

name = <pyorient.ogm.property.String object>

registry_name = 'DataSource'

registry_plural = 'DataSources'

url = <pyorient.ogm.property.String object>

version = <pyorient.ogm.property.String object>

class neuroarch.models.DendriteModel(**kwargs)

element_plural = 'DendriteModels'

element_type = 'DendriteModel'

name = <pyorient.ogm.property.String object>

params = <pyorient.ogm.property.EmbeddedMap object>

registry_name = 'DendriteModel'

registry_plural = 'DendriteModels'

states = <pyorient.ogm.property.EmbeddedMap object>

uname = <pyorient.ogm.property.String object>

class neuroarch.models.DesignNode(**kwargs)

element_plural = 'DesignNodes'

element_type = 'DesignNode'

registry_name = 'DesignNode'

registry_plural = 'DesignNodes'

class neuroarch.models.ExecutableCircuit(**kwargs)

element_plural = 'ExecutableCircuits'

element_type = 'ExecutableCircuit'

name = <pyorient.ogm.property.String object>

registry_name = 'ExecutableCircuit'

registry_plural = 'ExecutableCircuits'

version = <pyorient.ogm.property.String object>

class neuroarch.models.GapJunction(**kwargs)

element_plural = 'GapJunctions'

element_type = 'GapJunction'

name = <pyorient.ogm.property.String object>

registry_name = 'GapJunction'

registry_plural = 'GapJunctions'

class neuroarch.models.GeneticData(**kwargs)

element_plural = 'GeneticDatas'

element_type = 'GeneticData'

name = <pyorient.ogm.property.String object>

registry_name = 'GeneticData'

registry_plural = 'GeneticDatas'

class neuroarch.models.Glomerulus(**kwargs)

element_plural = 'Glomeruli'

element_type = 'Glomerulus'

name = <pyorient.ogm.property.String object>

registry_name = 'Glomerulus'

registry_plural = 'Glomeruli'

class neuroarch.models.HasData(**kwargs)

label = 'HasData'

registry_name = 'HasData'

registry_plural = 'HasData'

class neuroarch.models.HasQueryResults(**kwargs)

label = 'HasQueryResults'

registry_name = 'HasQueryResults'

registry_plural = 'HasQueryResults'

class neuroarch.models.HodgkinHuxley(**kwargs)

element_plural = 'HodgkinHuxleys'

element_type = 'HodgkinHuxley'

registry_name = 'HodgkinHuxley'

registry_plural = 'HodgkinHuxleys'

spiking = True

class neuroarch.models.HodgkinHuxleyFull(**kwargs)

element_plural = 'HodgkinHuxleyFulls'

element_type = 'HodgkinHuxleyFull'

registry_name = 'HodgkinHuxleyFull'

registry_plural = 'HodgkinHuxleyFulls'

spiking = True

class neuroarch.models.InferredSynapse(**kwargs)

N = <pyorient.ogm.property.Integer object>

element_plural = 'InferredSynapses'

element_type = 'InferredSynapse'

name = <pyorient.ogm.property.String object>

registry_name = 'InferredSynapse'

registry_plural = 'InferredSynapses'

uname = <pyorient.ogm.property.String object>

class neuroarch.models.Interface(**kwargs)

element_plural = 'Interfaces'

element_type = 'Interface'

name = <pyorient.ogm.property.String object>

registry_name = 'Interface'

registry_plural = 'Interfaces'

class neuroarch.models.LPU(**kwargs)

element_plural = 'LPUs'

element_type = 'LPU'

name = <pyorient.ogm.property.String object>

registry_name = 'LPU'

registry_plural = 'LPUs'

version = <pyorient.ogm.property.String object>

class neuroarch.models.LeakyIAF(**kwargs)

element_plural = 'LeakyIAFs'

element_type = 'LeakyIAF'

registry_name = 'LeakyIAF'

registry_plural = 'LeakyIAFs'

spiking = True

class neuroarch.models.LeakyIAFwithRefractoryPeriod(**kwargs)

element_plural = 'LeakyIAFwithRefractoryPeriods'

element_type = 'LeakyIAFwithRefractoryPeriod'

registry_name = 'LeakyIAFwithRefractoryPeriod'

registry_plural = 'LeakyIAFwithRefractoryPeriods'

spiking = True

class neuroarch.models.MembraneModel(**kwargs)

element_plural = 'MembraneModels'

element_type = 'MembraneModel'

registry_name = 'MembraneModel'

registry_plural = 'MembraneModels'

class neuroarch.models.MetaData(**kwargs)

created_by = <pyorient.ogm.property.EmbeddedMap object>

element_plural = 'MetaDatas'

element_type = 'MetaData'

maintainer = <pyorient.ogm.property.EmbeddedMap object>

registry_name = 'MetaData'

registry_plural = 'MetaDatas'

version = <pyorient.ogm.property.String object>

class neuroarch.models.Models(**kwargs)

label = 'Models'

registry_name = 'Models'

registry_plural = 'Models'

version = <pyorient.ogm.property.String object>

class neuroarch.models.MorphologyData(**kwargs)

confidence = <pyorient.ogm.property.EmbeddedList object>

element_plural = 'MorphologyDatas'

element_type = 'MorphologyData'

faces = <pyorient.ogm.property.EmbeddedList object>

identifier = <pyorient.ogm.property.EmbeddedList object>

morph_type = <pyorient.ogm.property.String object>

name = <pyorient.ogm.property.String object>

parent = <pyorient.ogm.property.EmbeddedList object>

r = <pyorient.ogm.property.EmbeddedList object>

registry_name = 'MorphologyData'

registry_plural = 'MorphologyDatas'

sample = <pyorient.ogm.property.EmbeddedList object>

uname = <pyorient.ogm.property.String object>

vertices = <pyorient.ogm.property.EmbeddedList object>

x = <pyorient.ogm.property.EmbeddedList object>

y = <pyorient.ogm.property.EmbeddedList object>

z = <pyorient.ogm.property.EmbeddedList object>

class neuroarch.models.MorrisLecar(**kwargs)

element_plural = 'MorrisLecars'

element_type = 'MorrisLecar'

registry_name = 'MorrisLecar'

registry_plural = 'MorrisLecars'

spiking = False

class neuroarch.models.NarxAdaptive(**kwargs)

element_plural = 'NarxAdaptives'

element_type = 'NarxAdaptive'

registry_name = 'NarxAdaptive'

registry_plural = 'NarxAdaptives'

class neuroarch.models.NeuroarchNodeMixin

get_props()

Retrieve record properties from database.

gremlin(script, args=None, namespace=None)

Return results of Gremlin query as mapped objects.

gremlin_raw(script, args=None, namespace=None)

Return results of Gremlin query as pyorient records.

owned_by(levels=1, **kwargs)

Retrieve nodes/edges that own this node at a specific level of the ownership hierarchy.

owns(levels=1, **kwargs)

Retrieve nodes/edges owned by this node at a specific level of the ownership hierarchy.

property props

Returns record properties that have been retrieved.

traverse_owned_by(**kwargs)

Traverse nodes/edges that own this node at a specific level of the ownership hierarchy.

traverse_owns(**kwargs)

Traverse nodes/edges owned by this node at a specific level of the ownership hierarchy.

update(**props)

Update record in database with specified properties.

class neuroarch.models.Neuron(**kwargs)

element_plural = 'Neurons'

element_type = 'Neuron'

info = <pyorient.ogm.property.EmbeddedMap object>

label = <pyorient.ogm.property.String object>

locality = <pyorient.ogm.property.Boolean object>

name = <pyorient.ogm.property.String object>

referenceId = <pyorient.ogm.property.String object>

registry_name = 'Neuron'

registry_plural = 'Neurons'

synonyms = <pyorient.ogm.property.EmbeddedList object>

uname = <pyorient.ogm.property.String object>

class neuroarch.models.NeuronAndFragment(**kwargs)

element_plural = 'NeuronAndFragments'

element_type = 'NeuronAndFragment'

registry_name = 'NeuronAndFragment'

registry_plural = 'NeuronAndFragments'

class neuroarch.models.NeuronFragment(**kwargs)

element_plural = 'NeuronFragments'

element_type = 'NeuronFragment'

info = <pyorient.ogm.property.EmbeddedMap object>

label = <pyorient.ogm.property.String object>

name = <pyorient.ogm.property.String object>

referenceId = <pyorient.ogm.property.String object>

registry_name = 'NeuronFragment'

registry_plural = 'NeuronFragments'

uname = <pyorient.ogm.property.String object>

class neuroarch.models.NeuronModel(**kwargs)

element_plural = 'NeuronModels'

element_type = 'NeuronModel'

name = <pyorient.ogm.property.String object>

params = <pyorient.ogm.property.EmbeddedMap object>

registry_name = 'NeuronModel'

registry_plural = 'NeuronModels'

states = <pyorient.ogm.property.EmbeddedMap object>

uname = <pyorient.ogm.property.String object>

class neuroarch.models.NeuronTerminal(**kwargs)

element_plural = 'NeuronTerminals'

element_type = 'NeuronTerminal'

name = <pyorient.ogm.property.String object>

registry_name = 'NeuronTerminal'

registry_plural = 'NeuronTerminals'

synonyms = <pyorient.ogm.property.EmbeddedList object>

class neuroarch.models.Neuropil(**kwargs)

element_plural = 'Neuropils'

element_type = 'Neuropil'

name = <pyorient.ogm.property.String object>

registry_name = 'Neuropil'

registry_plural = 'Neuropils'

synonyms = <pyorient.ogm.property.EmbeddedList object>

version = <pyorient.ogm.property.String object>

class neuroarch.models.NeurotransmitterData(**kwargs)

Transmitters = <pyorient.ogm.property.EmbeddedList object>

element_plural = 'NeurotransmitterDatas'

element_type = 'NeurotransmitterData'

name = <pyorient.ogm.property.String object>

registry_name = 'NeurotransmitterData'

registry_plural = 'NeurotransmitterDatas'

class neuroarch.models.Node(**kwargs)

element_plural = 'Nodes'

element_type = 'Node'

registry_name = 'Node'

registry_plural = 'Nodes'

class neuroarch.models.Ommatidium(**kwargs)

element_plural = 'Ommatidia'

element_type = 'Ommatidium'

name = <pyorient.ogm.property.String object>

registry_name = 'Ommatidium'

registry_plural = 'Ommatidia'

class neuroarch.models.OmmatidiumModel(**kwargs)

element_plural = 'OmmatidiumModels'

element_type = 'OmmatidiumModel'

registry_name = 'OmmatidiumModel'

registry_plural = 'OmmatidiumModels'

class neuroarch.models.Owns(**kwargs)

label = 'Owns'

registry_name = 'Owns'

registry_plural = 'Owns'

class neuroarch.models.Pattern(**kwargs)

element_plural = 'Patterns'

element_type = 'Pattern'

name = <pyorient.ogm.property.String object>

registry_name = 'Pattern'

registry_plural = 'Patterns'

version = <pyorient.ogm.property.String object>

class neuroarch.models.PhotoreceptorCell(**kwargs)

element_plural = 'PhotoreceptorCells'

element_type = 'PhotoreceptorCell'

registry_name = 'PhotoreceptorCell'

registry_plural = 'PhotoreceptorCells'

class neuroarch.models.PhotoreceptorModel(**kwargs)

element_plural = 'PhotoreceptorModels'

element_type = 'PhotoreceptorModel'

registry_name = 'PhotoreceptorModel'

registry_plural = 'PhotoreceptorModels'

spiking = False

class neuroarch.models.Port(**kwargs)

element_plural = 'Ports'

element_type = 'Port'

port_io = <pyorient.ogm.property.String object>

port_type = <pyorient.ogm.property.String object>

registry_name = 'Port'

registry_plural = 'Ports'

selector = <pyorient.ogm.property.String object>

class neuroarch.models.PowerGPotGPot(**kwargs)

element_plural = 'PowerGPotGPots'

element_type = 'PowerGPotGPot'

link_post = None

link_pre = 'gpot'

registry_name = 'PowerGPotGPot'

registry_plural = 'PowerGPotGPots'

class neuroarch.models.QueryOwns(**kwargs)

label = 'QueryOwns'

registry_name = 'QueryOwns'

registry_plural = 'QueryOwns'

class neuroarch.models.QueryResult(**kwargs)

FFBOdata = <pyorient.ogm.property.EmbeddedMap object>

element_plural = 'QueryResults'

element_type = 'QueryResult'

keywords = <pyorient.ogm.property.EmbeddedList object>

registry_name = 'QueryResult'

registry_plural = 'QueryResults'

tag = <pyorient.ogm.property.String object>

class neuroarch.models.Relationship(**kwargs)

label = 'Relationship'

registry_name = 'Relationship'

registry_plural = 'Relationship'

class neuroarch.models.Requires(**kwargs)

label = 'Requires'

registry_name = 'Requires'

registry_plural = 'Requires'

class neuroarch.models.SendsTo(**kwargs)

label = 'SendsTo'

registry_name = 'SendsTo'

registry_plural = 'SendsTo'

variable = <pyorient.ogm.property.String object>

class neuroarch.models.SigmoidSynapse(**kwargs)

element_plural = 'SigmoidSynapses'

element_type = 'SigmoidSynapse'

link_post = None

link_pre = 'V'

registry_name = 'SigmoidSynapse'

registry_plural = 'SigmoidSynapses'

class neuroarch.models.Species(**kwargs)

element_plural = 'Species'

element_type = 'Species'

name = <pyorient.ogm.property.String object>

registry_name = 'Species'

registry_plural = 'Species'

sex = <pyorient.ogm.property.String object>

stage = <pyorient.ogm.property.String object>

synonyms = <pyorient.ogm.property.EmbeddedList object>

class neuroarch.models.Subregion(**kwargs)

element_plural = 'Subregions'

element_type = 'Subregion'

name = <pyorient.ogm.property.String object>

registry_name = 'Subregion'

registry_plural = 'Subregions'

synonyms = <pyorient.ogm.property.EmbeddedList object>

class neuroarch.models.Subsystem(**kwargs)

element_plural = 'Subsystems'

element_type = 'Subsystem'

name = <pyorient.ogm.property.String object>

registry_name = 'Subsystem'

registry_plural = 'Subsystems'

synonyms = <pyorient.ogm.property.EmbeddedList object>

version = <pyorient.ogm.property.String object>

class neuroarch.models.Synapse(**kwargs)

N = <pyorient.ogm.property.Integer object>

NHP = <pyorient.ogm.property.Integer object>

element_plural = 'Synapses'

element_type = 'Synapse'

name = <pyorient.ogm.property.String object>

registry_name = 'Synapse'

registry_plural = 'Synapses'

uname = <pyorient.ogm.property.String object>

class neuroarch.models.SynapseAMPA(**kwargs)

element_plural = 'SynapseAMPAs'

element_type = 'SynapseAMPA'

link_post = None

link_pre = 'spike_state'

registry_name = 'SynapseAMPA'

registry_plural = 'SynapseAMPAs'

class neuroarch.models.SynapseGABA(**kwargs)

element_plural = 'SynapseGABAs'

element_type = 'SynapseGABA'

link_post = None

link_pre = 'spike_state'

registry_name = 'SynapseGABA'

registry_plural = 'SynapseGABAs'

class neuroarch.models.SynapseModel(**kwargs)

element_plural = 'SynapseModels'

element_type = 'SynapseModel'

name = <pyorient.ogm.property.String object>

params = <pyorient.ogm.property.EmbeddedMap object>

registry_name = 'SynapseModel'

registry_plural = 'SynapseModels'

states = <pyorient.ogm.property.EmbeddedMap object>

uname = <pyorient.ogm.property.String object>

class neuroarch.models.SynapseNMDA(**kwargs)

element_plural = 'SynapseNMDAs'

element_type = 'SynapseNMDA'

link_post = 'V'

link_pre = 'spike_state'

registry_name = 'SynapseNMDA'

registry_plural = 'SynapseNMDAs'

class neuroarch.models.Tract(**kwargs)

element_plural = 'Tracts'

element_type = 'Tract'

name = <pyorient.ogm.property.String object>

neuropils = <pyorient.ogm.property.EmbeddedSet object>

registry_name = 'Tract'

registry_plural = 'Tracts'

version = <pyorient.ogm.property.String object>

class neuroarch.models.Version(**kwargs)

element_plural = 'Versions'

element_type = 'Version'

registry_name = 'Version'

registry_plural = 'Versions'

version = <pyorient.ogm.property.String object>

neuroarch.models.create_efficiently(graph, registry)

Efficiently create classes in OrientDB database.

Runs graph.create_all(registry) if any of the classes in the registry are absent; otherwise, runs the faster method graph.include(registry).

Parameters:

• graph (pyorient.ogm.graph.Graph) – OrientDB graph.

• registry (collections.OrderedDict) – Registry of pyorient OGM classes for which to create OrientDB classes.