Fix kernels and statistics (instantaneous_rate & mean_firing_rate) (N…

…euralEnsemble#313) * removed magic in boundary_enclosing_area_fraction * standardized quantities handling in kernels _evaluate() * fixed kernels.median_index() and statistics.instantaneous_rate() * CDF, ICDF, median index * center_kernel feature
INM-6 · May 11, 2020 · 12b1d93 · 12b1d93
1 parent 3445f56
commit 12b1d93
Show file tree

Hide file tree

Showing 17 changed files with 1,468 additions and 634 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -123,6 +123,9 @@
 # the autosummary fields of each module.
 autosummary_generate = True
 
+# don't overwrite our custom toctree/*.rst
+autosummary_generate_overwrite = False
+
 # -- Options for HTML output ---------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

diff --git a/doc/reference/toctree/kernels/elephant.kernels.AlphaKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.AlphaKernel.rst
@@ -4,4 +4,29 @@ elephant.kernels.AlphaKernel
 .. currentmodule:: elephant.kernels
 
 .. autoclass:: AlphaKernel
-    :members: __call__, is_symmetric, boundary_enclosing_area_fraction, min_cutoff
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~AlphaKernel.__call__
+      ~AlphaKernel.boundary_enclosing_area_fraction
+      ~AlphaKernel.cdf
+      ~AlphaKernel.icdf
+      ~AlphaKernel.is_symmetric
+      ~AlphaKernel.median_index
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~AlphaKernel.min_cutoff
+
+
diff --git a/doc/reference/toctree/kernels/elephant.kernels.EpanechnikovLikeKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.EpanechnikovLikeKernel.rst
@@ -4,4 +4,29 @@ elephant.kernels.EpanechnikovLikeKernel
 .. currentmodule:: elephant.kernels
 
 .. autoclass:: EpanechnikovLikeKernel
-    :members: __call__, is_symmetric, boundary_enclosing_area_fraction, min_cutoff
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~EpanechnikovLikeKernel.__call__
+      ~EpanechnikovLikeKernel.boundary_enclosing_area_fraction
+      ~EpanechnikovLikeKernel.cdf
+      ~EpanechnikovLikeKernel.icdf
+      ~EpanechnikovLikeKernel.is_symmetric
+      ~EpanechnikovLikeKernel.median_index
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~EpanechnikovLikeKernel.min_cutoff
+
+
diff --git a/doc/reference/toctree/kernels/elephant.kernels.ExponentialKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.ExponentialKernel.rst
@@ -4,4 +4,29 @@ elephant.kernels.ExponentialKernel
 .. currentmodule:: elephant.kernels
 
 .. autoclass:: ExponentialKernel
-    :members: __call__, is_symmetric, boundary_enclosing_area_fraction, min_cutoff
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~ExponentialKernel.__call__
+      ~ExponentialKernel.boundary_enclosing_area_fraction
+      ~ExponentialKernel.cdf
+      ~ExponentialKernel.icdf
+      ~ExponentialKernel.is_symmetric
+      ~ExponentialKernel.median_index
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ExponentialKernel.min_cutoff
+
+
diff --git a/doc/reference/toctree/kernels/elephant.kernels.GaussianKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.GaussianKernel.rst
@@ -4,5 +4,29 @@ elephant.kernels.GaussianKernel
 .. currentmodule:: elephant.kernels
 
 .. autoclass:: GaussianKernel
-    :members: __call__, is_symmetric, boundary_enclosing_area_fraction, min_cutoff
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~GaussianKernel.__call__
+      ~GaussianKernel.boundary_enclosing_area_fraction
+      ~GaussianKernel.cdf
+      ~GaussianKernel.icdf
+      ~GaussianKernel.is_symmetric
+      ~GaussianKernel.median_index
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~GaussianKernel.min_cutoff
+
 
diff --git a/doc/reference/toctree/kernels/elephant.kernels.Kernel.rst b/doc/reference/toctree/kernels/elephant.kernels.Kernel.rst
diff --git a/doc/reference/toctree/kernels/elephant.kernels.LaplacianKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.LaplacianKernel.rst
@@ -4,4 +4,29 @@ elephant.kernels.LaplacianKernel
 .. currentmodule:: elephant.kernels
 
 .. autoclass:: LaplacianKernel
-    :members: __call__, is_symmetric, boundary_enclosing_area_fraction, min_cutoff
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~LaplacianKernel.__call__
+      ~LaplacianKernel.boundary_enclosing_area_fraction
+      ~LaplacianKernel.cdf
+      ~LaplacianKernel.icdf
+      ~LaplacianKernel.is_symmetric
+      ~LaplacianKernel.median_index
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~LaplacianKernel.min_cutoff
+
+
diff --git a/doc/reference/toctree/kernels/elephant.kernels.RectangularKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.RectangularKernel.rst
@@ -4,5 +4,29 @@ elephant.kernels.RectangularKernel
 .. currentmodule:: elephant.kernels
 
 .. autoclass:: RectangularKernel
-    :members: __call__, is_symmetric, boundary_enclosing_area_fraction, min_cutoff
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~RectangularKernel.__call__
+      ~RectangularKernel.boundary_enclosing_area_fraction
+      ~RectangularKernel.cdf
+      ~RectangularKernel.icdf
+      ~RectangularKernel.is_symmetric
+      ~RectangularKernel.median_index
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~RectangularKernel.min_cutoff
+
 
diff --git a/doc/reference/toctree/kernels/elephant.kernels.SymmetricKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.SymmetricKernel.rst
diff --git a/doc/reference/toctree/kernels/elephant.kernels.TriangularKernel.rst b/doc/reference/toctree/kernels/elephant.kernels.TriangularKernel.rst
@@ -4,5 +4,29 @@ elephant.kernels.TriangularKernel
 .. currentmodule:: elephant.kernels
 
 .. autoclass:: TriangularKernel
-    :members: __call__, is_symmetric, boundary_enclosing_area_fraction, min_cutoff
+   :members:
+   :inherited-members:
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~TriangularKernel.__call__
+      ~TriangularKernel.boundary_enclosing_area_fraction
+      ~TriangularKernel.cdf
+      ~TriangularKernel.icdf
+      ~TriangularKernel.is_symmetric
+      ~TriangularKernel.median_index
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~TriangularKernel.min_cutoff
+