OptogeneticStimulusSite

See also:: Format Specification or Source Specification for OptogeneticStimulusSite.

class types.core.OptogeneticStimulusSite(varargin)[source]

Bases: types.core.NWBContainer, types.untyped.GroupClass

OPTOGENETICSTIMULUSSITE - A site of optogenetic stimulation.

Required Properties*:: description, device, excitation_lambda, location

Constructor Summary

OptogeneticStimulusSite(varargin)

OPTOGENETICSTIMULUSSITE - Constructor for OptogeneticStimulusSite

Syntax:

optogeneticStimulusSite = types.core.OPTOGENETICSTIMULUSSITE() creates an OptogeneticStimulusSite object with unset property values.

optogeneticStimulusSite = types.core.OPTOGENETICSTIMULUSSITE(Name, Value) creates an OptogeneticStimulusSite object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

description (char) - Description of stimulation site.
device (Device) - Device that generated the stimulus.
excitation_lambda (single) - Excitation wavelength, in nm.
location (char) - Location of the stimulation site. Specify the area, layer, comments on estimation of area/layer, stereotaxic coordinates if in vivo, etc. Use standard atlas names for anatomical regions when possible.

Output Arguments:

optogeneticStimulusSite (types.core.OptogeneticStimulusSite) - An OptogeneticStimulusSite object

Property Summary

description: REQUIRED (char) Description of stimulation site.

device: REQUIRED (Device) Device that generated the stimulus.

excitation_lambda: REQUIRED (single) Excitation wavelength, in nm.

location: REQUIRED (char) Location of the stimulation site. Specify the area, layer, comments on estimation of area/layer, stereotaxic coordinates if in vivo, etc. Use standard atlas names for anatomical regions when possible.

Tip

* If a required property link is not functional, the property may be defined in a superclass. Please refer to the superclass documentation.