Skip to content

Commit

Permalink
Add dynamic filter class documentation (#456)
Browse files Browse the repository at this point in the history 
* remove auto-generated documentation

* Update documentation

Add dynamic filter properties and shuffle file.

Co-authored-by: Lawrence Niu <[email protected]>
  • Loading branch information
@lawrence-mbf
lawrence-mbf and lawrence-mbf authored Aug 16, 2022
1 parent 2e17d54 commit 3b26777
Show file tree
Hide file tree
Showing 86 changed files with 1,525 additions and 1,908 deletions.
2 changes: 0 additions & 2 deletions +types/+untyped/+datapipe/+properties/DynamicFilter.m
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
classdef DynamicFilter < types.untyped.datapipe.Property
%DYNAMIC Summary of this class goes here
% Detailed explanation goes here

properties (SetAccess = private)
dynamicFilter;
Expand Down
90 changes: 47 additions & 43 deletions doc/+types/+core/AbstractFeatureSeries.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

<link rel="stylesheet" href="../../helpwin.css">
<title>types.core.AbstractFeatureSeries - MATLAB File Help</title>
<title>MATLAB File Help: types.core.AbstractFeatureSeries</title>
</head>
<body>
<!--Single-page help-->
<table border="0" cellspacing="0" width="100%">
<tr class="subheader">
<td class="headertitle">types.core.AbstractFeatureSeries - MATLAB File Help</td>
<td class="headertitle">MATLAB File Help: types.core.AbstractFeatureSeries</td>



Expand Down Expand Up @@ -48,75 +48,81 @@
<table class="summary-list">
<tr class="summary-item">
<td class="name">comments</td>
<td class="m-help">OPTIONAL (char) 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.&nbsp;
<td class="m-help">(char) 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.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">control</td>
<td class="m-help">OPTIONAL ((uint8) ) 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.&nbsp;
<td class="m-help">(uint8) 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.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">control_description</td>
<td class="m-help">OPTIONAL ((char) ) Description of each control value. Must be present if control is present. If present, control_description[0]
should describe time points where control == 0.&nbsp;
<td class="m-help">(char) Description of each control value. Must be present if control is present. If present, control_description[0] should
describe time points where control == 0.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">data</td>
<td class="m-help">REQUIRED ((any) ) 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.&nbsp;
<td class="m-help">REQUIRED (any) 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.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">data_continuity</td>
<td class="m-help">OPTIONAL (char) Optionally describe the continuity of the data. Can be "continuous", "instantaneous", or "step". For example,
a voltage trace would be "continuous", because samples are recorded from a continuous process. An array of lick times would
be "instantaneous", because the data represents distinct moments in time. Times of image presentations would be "step" because
the picture remains the same until the next timepoint. This field is optional, but is useful in providing information about
the underlying data. It may inform the way this data is interpreted, the way it is visualized, and what analysis methods are
applicable.&nbsp;
<td class="m-help">(char) Optionally describe the continuity of the data. Can be "continuous", "instantaneous", or "step". For example, a voltage
trace would be "continuous", because samples are recorded from a continuous process. An array of lick times would be "instantaneous",
because the data represents distinct moments in time. Times of image presentations would be "step" because the picture remains
the same until the next timepoint. This field is optional, but is useful in providing information about the underlying data.
It may inform the way this data is interpreted, the way it is visualized, and what analysis methods are applicable.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">data_conversion</td>
<td class="m-help">OPTIONAL (float32) 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.&nbsp;
<td class="m-help">(float32) 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.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">data_offset</td>
<td class="m-help">(float32) Scalar to add to the data after scaling by 'conversion' to finalize its coercion to the specified 'unit'. Two common
examples of this include (a) data stored in an unsigned type that requires a shift after scaling to re-center the data, and
(b) specialized recording devices that naturally cause a scalar offset with respect to the true units.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">data_resolution</td>
<td class="m-help">OPTIONAL (float32) 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.&nbsp;
<td class="m-help">(float32) 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.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">data_unit</td>
<td class="m-help">REQUIRED (char) 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'.&nbsp;
units. To access the data in these units, multiply 'data' by 'conversion' and add 'offset'.&nbsp;
</td>
</tr>
<tr class="summary-item">
<td class="name">description</td>
<td class="m-help">OPTIONAL (char) Description of the time series.&nbsp;</td>
<td class="m-help">(char) Description of the time series.&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="name">feature_units</td>
<td class="m-help">OPTIONAL ((char) ) Units of each feature.&nbsp;</td>
<td class="m-help">(char) Units of each feature.&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="name">features</td>
<td class="m-help">REQUIRED ((char) ) Description of the features represented in TimeSeries::data.&nbsp;</td>
<td class="m-help">REQUIRED (char) Description of the features represented in TimeSeries::data.&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="name">starting_time</td>
<td class="m-help">OPTIONAL ((float64) ) 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.&nbsp;
<td class="m-help">(float64) 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.&nbsp;
</td>
</tr>
<tr class="summary-item">
Expand All @@ -125,21 +131,19 @@
</tr>
<tr class="summary-item">
<td class="name">starting_time_unit</td>
<td class="m-help">OPTIONAL (char) Unit of measurement for time, which is fixed to 'seconds'.&nbsp;</td>
<td class="m-help">(char) Unit of measurement for time, which is fixed to 'seconds'.&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="name">timestamps</td>
<td class="m-help">OPTIONAL ((float64) ) Timestamps for samples stored in data, in seconds, relative to the common experiment master-clock stored
in NWBFile.timestamps_reference_time.&nbsp;
</td>
<td class="m-help">(float64) Timestamps for samples stored in data, in seconds, relative to the common experiment master-clock stored in NWBFile.timestamps_reference_time.&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="name">timestamps_interval</td>
<td class="m-help">OPTIONAL (int32) Value is '1'&nbsp;</td>
<td class="m-help">(int32) Value is '1'&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="name">timestamps_unit</td>
<td class="m-help">OPTIONAL (char) Unit of measurement for timestamps, which is fixed to 'seconds'.&nbsp;</td>
<td class="m-help">(char) Unit of measurement for timestamps, which is fixed to 'seconds'.&nbsp;</td>
</tr>
</table>
<!--Methods-->
Expand Down Expand Up @@ -226,14 +230,6 @@
<td class="name">le</td>
<td class="m-help"><= (LE) Less than or equal relation for handles.&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="attributes">
&nbsp;

</td>
<td class="name">listener</td>
<td class="m-help">Add listener for event without binding the listener to the source object.&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="attributes">
&nbsp;
Expand Down Expand Up @@ -314,6 +310,14 @@
<td class="name">validate_data_conversion</td>
<td class="m-help">&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="attributes">
&nbsp;

</td>
<td class="name">validate_data_offset</td>
<td class="m-help">&nbsp;</td>
</tr>
<tr class="summary-item">
<td class="attributes">
&nbsp;
Expand Down
Loading

0 comments on commit 3b26777

Please sign in to comment.