diff --git a/docs/doctrees/docs/blinks.doctree b/docs/doctrees/docs/blinks.doctree index 807487c..b8e315a 100644 Binary files a/docs/doctrees/docs/blinks.doctree and b/docs/doctrees/docs/blinks.doctree differ diff --git a/docs/doctrees/docs/pipes.doctree b/docs/doctrees/docs/pipes.doctree index 9e6d5b0..f1107f9 100644 Binary files a/docs/doctrees/docs/pipes.doctree and b/docs/doctrees/docs/pipes.doctree differ diff --git a/docs/doctrees/docs/plotting.doctree b/docs/doctrees/docs/plotting.doctree index e5d3b8d..48c7eed 100644 Binary files a/docs/doctrees/docs/plotting.doctree and b/docs/doctrees/docs/plotting.doctree differ diff --git a/docs/doctrees/docs/summary.doctree b/docs/doctrees/docs/summary.doctree index 22a18fa..92d16c9 100644 Binary files a/docs/doctrees/docs/summary.doctree and b/docs/doctrees/docs/summary.doctree differ diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle index b6397ae..b2a73b8 100644 Binary files a/docs/doctrees/environment.pickle and b/docs/doctrees/environment.pickle differ diff --git a/docs/doctrees/nbsphinx/docs/blinks.ipynb b/docs/doctrees/nbsphinx/docs/blinks.ipynb index 3f9c17a..a1f81b1 100644 --- a/docs/doctrees/nbsphinx/docs/blinks.ipynb +++ b/docs/doctrees/nbsphinx/docs/blinks.ipynb @@ -71,7 +71,7 @@ "- Second, blinks are defined as everything between two crossings of the velocity profile (from negative to positive).\n", "- Finally, detected blinks have to be at least `min_duration` duration (in customizable `units`).\n", "\n", - "As a consequence, there are several parameters that can be adjusted (see the [API-docs](/docs/api.rst) for details).\n", + "As a consequence, there are several parameters that can be adjusted (see the [API-docs](api.html) for details).\n", "The most important ones are the following:\n", "\n", "- `min_duration`: minimum duration for a sequence of missing numbers to be treated as blink\n", @@ -121,7 +121,7 @@ "source": [ "We see that a period of seemingly valid pupil-data (around times 4.05 and 4.15 min) was marked as blink because of a sudden downward change in the pupil signal which might resemble the onset of a blink (a likely source of these artifacts are sudden eye-movements but we would need eyetracking-data to corrobate this hypothesis). \n", "\n", - "his problem can be fixed by setting a stricter value for the velocity-profile based onset detection `vel_onset` or requiring a more prolonged onset-transient by increasing `min_onset_len`:" + "This problem can be fixed by setting a stricter value for the velocity-profile based onset detection `vel_onset` or requiring a more prolonged onset-transient by increasing `min_onset_len`:" ] }, { diff --git a/docs/doctrees/nbsphinx/docs/pipes.ipynb b/docs/doctrees/nbsphinx/docs/pipes.ipynb index 1aa7e3e..137901a 100644 --- a/docs/doctrees/nbsphinx/docs/pipes.ipynb +++ b/docs/doctrees/nbsphinx/docs/pipes.ipynb @@ -94,7 +94,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "We see that sampling rate, number o datapoints and more is automatically printed along with the history of all operations applied to the dataset. This information can also be retrieved separately and in a form useful for further processing the function `summary()` which returns the information in the form of a `dict`:" + "We see that sampling rate, number of datapoints and more is automatically printed along with the history of all operations applied to the dataset. This information can also be retrieved separately and in a form useful for further processing the function `summary()` which returns the information in the form of a `dict`:" ] }, { diff --git a/docs/doctrees/nbsphinx/docs/plotting.ipynb b/docs/doctrees/nbsphinx/docs/plotting.ipynb index 6a0e5a0..b99f8c8 100644 --- a/docs/doctrees/nbsphinx/docs/plotting.ipynb +++ b/docs/doctrees/nbsphinx/docs/plotting.ipynb @@ -6,7 +6,7 @@ "source": [ "# Plotting pupillometric data for exploration\n", "\n", - "It is crucial to validate preprocessing steps by visually inspecting the results using plots. Therefore, `pypillometry` implements several plotting facilities that encourage active exploration of the dataset. Some of the plotting functions require a Jupyter-notebook with enable widgets (see Installation instructions) so that the plots can be changed interactively, others are purely :mod:`matplotlib`-based." + "It is crucial to validate preprocessing steps by visually inspecting the results using plots. Therefore, `pypillometry` implements several plotting facilities that encourage active exploration of the dataset. Some of the plotting functions require a Jupyter-notebook with enable widgets (see Installation instructions) so that the plots can be changed interactively, others are purely `matplotlib`-based." ] }, { diff --git a/docs/doctrees/nbsphinx/docs/summary.ipynb b/docs/doctrees/nbsphinx/docs/summary.ipynb index 38dad2c..12fc08c 100644 --- a/docs/doctrees/nbsphinx/docs/summary.ipynb +++ b/docs/doctrees/nbsphinx/docs/summary.ipynb @@ -22,7 +22,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The `pypillometry` package provides several functions for summarizing datasets. Simply `print()`ing a :class:`PupilData` object gives a readable summary of the main properties of the dataset and also prints the complete history of operations applied to the dataset." + "The `pypillometry` package provides several functions for summarizing datasets. Simply `print()`ing a `PupilData` object gives a readable summary of the main properties of the dataset and also prints the complete history of operations applied to the dataset." ] }, { diff --git a/docs/html/_sources/docs/blinks.ipynb.txt b/docs/html/_sources/docs/blinks.ipynb.txt index 3f9c17a..a1f81b1 100644 --- a/docs/html/_sources/docs/blinks.ipynb.txt +++ b/docs/html/_sources/docs/blinks.ipynb.txt @@ -71,7 +71,7 @@ "- Second, blinks are defined as everything between two crossings of the velocity profile (from negative to positive).\n", "- Finally, detected blinks have to be at least `min_duration` duration (in customizable `units`).\n", "\n", - "As a consequence, there are several parameters that can be adjusted (see the [API-docs](/docs/api.rst) for details).\n", + "As a consequence, there are several parameters that can be adjusted (see the [API-docs](api.html) for details).\n", "The most important ones are the following:\n", "\n", "- `min_duration`: minimum duration for a sequence of missing numbers to be treated as blink\n", @@ -121,7 +121,7 @@ "source": [ "We see that a period of seemingly valid pupil-data (around times 4.05 and 4.15 min) was marked as blink because of a sudden downward change in the pupil signal which might resemble the onset of a blink (a likely source of these artifacts are sudden eye-movements but we would need eyetracking-data to corrobate this hypothesis). \n", "\n", - "his problem can be fixed by setting a stricter value for the velocity-profile based onset detection `vel_onset` or requiring a more prolonged onset-transient by increasing `min_onset_len`:" + "This problem can be fixed by setting a stricter value for the velocity-profile based onset detection `vel_onset` or requiring a more prolonged onset-transient by increasing `min_onset_len`:" ] }, { diff --git a/docs/html/_sources/docs/pipes.ipynb.txt b/docs/html/_sources/docs/pipes.ipynb.txt index 1aa7e3e..137901a 100644 --- a/docs/html/_sources/docs/pipes.ipynb.txt +++ b/docs/html/_sources/docs/pipes.ipynb.txt @@ -94,7 +94,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "We see that sampling rate, number o datapoints and more is automatically printed along with the history of all operations applied to the dataset. This information can also be retrieved separately and in a form useful for further processing the function `summary()` which returns the information in the form of a `dict`:" + "We see that sampling rate, number of datapoints and more is automatically printed along with the history of all operations applied to the dataset. This information can also be retrieved separately and in a form useful for further processing the function `summary()` which returns the information in the form of a `dict`:" ] }, { diff --git a/docs/html/_sources/docs/plotting.ipynb.txt b/docs/html/_sources/docs/plotting.ipynb.txt index 6a0e5a0..b99f8c8 100644 --- a/docs/html/_sources/docs/plotting.ipynb.txt +++ b/docs/html/_sources/docs/plotting.ipynb.txt @@ -6,7 +6,7 @@ "source": [ "# Plotting pupillometric data for exploration\n", "\n", - "It is crucial to validate preprocessing steps by visually inspecting the results using plots. Therefore, `pypillometry` implements several plotting facilities that encourage active exploration of the dataset. Some of the plotting functions require a Jupyter-notebook with enable widgets (see Installation instructions) so that the plots can be changed interactively, others are purely :mod:`matplotlib`-based." + "It is crucial to validate preprocessing steps by visually inspecting the results using plots. Therefore, `pypillometry` implements several plotting facilities that encourage active exploration of the dataset. Some of the plotting functions require a Jupyter-notebook with enable widgets (see Installation instructions) so that the plots can be changed interactively, others are purely `matplotlib`-based." ] }, { diff --git a/docs/html/_sources/docs/summary.ipynb.txt b/docs/html/_sources/docs/summary.ipynb.txt index 38dad2c..12fc08c 100644 --- a/docs/html/_sources/docs/summary.ipynb.txt +++ b/docs/html/_sources/docs/summary.ipynb.txt @@ -22,7 +22,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The `pypillometry` package provides several functions for summarizing datasets. Simply `print()`ing a :class:`PupilData` object gives a readable summary of the main properties of the dataset and also prints the complete history of operations applied to the dataset." + "The `pypillometry` package provides several functions for summarizing datasets. Simply `print()`ing a `PupilData` object gives a readable summary of the main properties of the dataset and also prints the complete history of operations applied to the dataset." ] }, { diff --git a/docs/html/docs/blinks.html b/docs/html/docs/blinks.html index 01b4553..1ffc5eb 100644 --- a/docs/html/docs/blinks.html +++ b/docs/html/docs/blinks.html @@ -328,7 +328,7 @@

Blink detectionmin_duration duration (in customizable units).

-

As a consequence, there are several parameters that can be adjusted (see the API-docs for details). The most important ones are the following:

+

As a consequence, there are several parameters that can be adjusted (see the API-docs for details). The most important ones are the following: