SweepTable

See also:

Format Specification or Source Specification for SweepTable.

class types.core.SweepTable(varargin)[source]

Bases: types.hdmf_common.DynamicTable, types.untyped.GroupClass

SWEEPTABLE - [DEPRECATED] Table used to group different PatchClampSeries. SweepTable is being replaced by IntracellularRecordingsTable and SimultaneousRecordingsTable tables. Additional SequentialRecordingsTable, RepetitionsTable, and ExperimentalConditions tables provide enhanced support for experiment metadata.

Required Properties*:

colnames, description, id, series, series_index, sweep_number

Constructor Summary
SweepTable(varargin)

SWEEPTABLE - Constructor for SweepTable

Syntax:

sweepTable = types.core.SWEEPTABLE() creates a SweepTable object with unset property values.

sweepTable = types.core.SWEEPTABLE(Name, Value) creates a SweepTable object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • colnames (char) - The names of the columns in this table. This should be used to specify an order to the columns.

  • description (char) - Description of what is in this dynamic table.

  • id (ElementIdentifiers) - Array of unique identifiers for the rows of this dynamic table.

  • meanings_tables (MeaningsTable) - MeaningsTable objects that provide meanings for values in VectorData columns within this DynamicTable. Tables should be named according to the column they provide meanings for with a “_meanings” suffix. e.g., if a VectorData column is named “stimulus_type”, the corresponding MeaningsTable should be named “stimulus_type_meanings”.

  • series (VectorData) - The PatchClampSeries with the sweep number in that row.

  • series_index (VectorIndex) - Index for series.

  • sweep_number (VectorData) - Sweep number of the PatchClampSeries in that row.

  • vectordata (VectorData) - Vector columns, including index columns, of this dynamic table.

Output Arguments:
Property Summary
series

REQUIRED (VectorData) The PatchClampSeries with the sweep number in that row.

series_index

REQUIRED (VectorIndex) Index for series.

sweep_number

REQUIRED (VectorData) Sweep number of the PatchClampSeries in that row.

Tip

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