types.core.VoltageClampSeries - MATLAB File Help
types.core.VoltageClampSeries
  VoltageClampSeries Current data from an intracellular voltage-clamp recording. A corresponding VoltageClampStimulusSeries (stored separately as a stimulus) is used to store the voltage injected.
Class Details
Superclasses types.core.PatchClampSeries, types.untyped.GroupClass
Sealed false
Construct on load false
Constructor Summary
VoltageClampSeries Constructor for VoltageClampSeries 
Property Summary
capacitance_fast Fast capacitance, in farads. 
capacitance_fast_unit Unit of measurement for capacitance_fast, which is fixed to 'farads'. 
capacitance_slow Slow capacitance, in farads. 
capacitance_slow_unit Unit of measurement for capacitance_fast, which is fixed to 'farads'. 
comments Human-readable comments about the TimeSeries. This second descriptive field can be used to store additional information, or descriptive information if the primary description field is populated with a computer-readable string. 
control Numerical labels that apply to each time point in data for the purpose of querying and slicing data by these values. If present, the length of this array should be the same size as the first dimension of data. 
control_description Description of each control value. Must be present if control is present. If present, control_description[0] should describe time points where control == 0. 
data Data values. Data can be in 1-D, 2-D, 3-D, or 4-D. The first dimension should always represent time. This can also be used to store binary data (e.g., image frames). This can also be a link to data stored in an external file. 
data_conversion Scalar to multiply each element in data to convert it to the specified 'unit'. If the data are stored in acquisition system units or other units that require a conversion to be interpretable, multiply the data by 'conversion' to convert the data to the specified 'unit'. e.g. if the data acquisition system stores values in this object as signed 16-bit integers (int16 range -32,768 to 32,767) that correspond to a 5V range (-2.5V to 2.5V), and the data acquisition system gain is 8000X, then the 'conversion' multiplier to get from raw data acquisition values to recorded volts is 2.5/32768/8000 = 9.5367e-9. 
data_resolution Smallest meaningful difference between values in data, stored in the specified by unit, e.g., the change in value of the least significant bit, or a larger number if signal noise is known to be present. If unknown, use -1.0. 
data_unit Base unit of measurement for working with the data. Actual stored values are not necessarily stored in these units. To access the data in these units, multiply 'data' by 'conversion'. 
description Description of the time series. 
electrode Link to IntracellularElectrode object that describes the electrode that was used to apply or record this data. 
gain Gain of the recording, in units Volt/Amp (v-clamp) or Volt/Volt (c-clamp). 
resistance_comp_bandwidth Resistance compensation bandwidth, in hertz. 
resistance_comp_bandwidth_unit Unit of measurement for resistance_comp_bandwidth, which is fixed to 'hertz'. 
resistance_comp_correction Resistance compensation correction, in percent. 
resistance_comp_correction_unit Unit of measurement for resistance_comp_correction, which is fixed to 'percent'. 
resistance_comp_prediction Resistance compensation prediction, in percent. 
resistance_comp_prediction_unit Unit of measurement for resistance_comp_prediction, which is fixed to 'percent'. 
starting_time Timestamp of the first sample in seconds. When timestamps are uniformly spaced, the timestamp of the first sample can be specified and all subsequent ones calculated from the sampling rate attribute. 
starting_time_rate Sampling rate, in Hz. 
starting_time_unit Unit of measurement for time, which is fixed to 'seconds'. 
stimulus_description Protocol/stimulus name for this patch-clamp dataset. 
sweep_number Sweep number, allows to group different PatchClampSeries together. 
timestamps Timestamps for samples stored in data, in seconds, relative to the common experiment master-clock stored in NWBFile.timestamps_reference_time. 
timestamps_interval Value is '1' 
timestamps_unit Unit of measurement for timestamps, which is fixed to 'seconds'. 
whole_cell_capacitance_comp Whole cell capacitance compensation, in farads. 
whole_cell_capacitance_comp_unit Unit of measurement for whole_cell_capacitance_comp, which is fixed to 'farads'. 
whole_cell_series_resistance_comp Whole cell series resistance compensation, in ohms. 
whole_cell_series_resistance_comp_unit Unit of measurement for whole_cell_series_resistance_comp, which is fixed to 'ohms'. 
Method Summary
  addlistener Add listener for event. 
  delete Delete a handle object. 
  eq == (EQ) Test handle equality. 
  export find reference properties 
  findobj Find objects matching specified conditions. 
  findprop Find property of MATLAB handle object. 
  ge >= (GE) Greater than or equal relation for handles. 
  gt > (GT) Greater than relation for handles. 
Sealed   isvalid Test handle validity. 
  le <= (LE) Less than or equal relation for handles. 
  listener Add listener for event without binding the listener to the source object. 
  loadAll  
  lt < (LT) Less than relation for handles. 
  ne ~= (NE) Not equal relation for handles. 
  notify Notify listeners of event. 
  validate_capacitance_fast  
  validate_capacitance_slow  
  validate_comments  
  validate_control  
  validate_control_description  
  validate_data  
  validate_data_conversion  
  validate_data_resolution  
  validate_data_unit  
  validate_description  
  validate_electrode  
  validate_gain  
  validate_resistance_comp_bandwidth  
  validate_resistance_comp_correction  
  validate_resistance_comp_prediction  
  validate_starting_time  
  validate_starting_time_rate  
  validate_stimulus_description  
  validate_sweep_number  
  validate_timestamps  
  validate_whole_cell_capacitance_comp  
  validate_whole_cell_series_resistance_comp  
Event Summary