..
    SPDX-FileCopyrightText: 2015-2023 Tanguy Fardet
    SPDX-License-Identifier: CC-BY-SA-4.0
    doc/modules/analysis.rst.in

===============
Analysis module
===============

Tools to analyze neuronal networks, using either their topological properties,
their activity, or more importantly, taking both into account.
See also :ref:`graph-analysis` for more details on consistent analysis across
graph libraries.

Content
=======

.. autosummary::

    nngt.analysis.adjacency_matrix
    nngt.analysis.all_shortest_paths
    nngt.analysis.assortativity
    nngt.analysis.average_path_length
    nngt.analysis.bayesian_blocks
    nngt.analysis.betweenness
    nngt.analysis.betweenness_distrib
    nngt.analysis.binning
    nngt.analysis.closeness
    nngt.analysis.connected_components
    nngt.analysis.degree_distrib
    nngt.analysis.diameter
    nngt.analysis.get_b2
    nngt.analysis.get_firing_rate
    nngt.analysis.get_spikes
    nngt.analysis.global_clustering
    nngt.analysis.global_clustering_binary_undirected
    nngt.analysis.local_closure
    nngt.analysis.local_clustering
    nngt.analysis.local_clustering_binary_undirected
    nngt.analysis.node_attributes
    nngt.analysis.num_iedges
    nngt.analysis.reciprocity
    nngt.analysis.shortest_distance
    nngt.analysis.shortest_path
    nngt.analysis.small_world_propensity
    nngt.analysis.spectral_radius
    nngt.analysis.subgraph_centrality
    nngt.analysis.total_firing_rate
    nngt.analysis.transitivity
    nngt.analysis.triangle_count
    nngt.analysis.triplet_count


Details
=======

.. module:: nngt.analysis


.. autofunction:: adjacency_matrix

.. autofunction:: all_shortest_paths

.. autofunction:: assortativity

.. autofunction:: average_path_length

.. autofunction:: bayesian_blocks

.. autofunction:: betweenness

.. autofunction:: betweenness_distrib

.. autofunction:: binning

.. autofunction:: closeness

.. autofunction:: connected_components

.. autofunction:: degree_distrib

.. autofunction:: diameter

.. autofunction:: get_b2

.. autofunction:: get_firing_rate

.. autofunction:: get_spikes

.. autofunction:: global_clustering

.. autofunction:: global_clustering_binary_undirected

.. autofunction:: local_closure

.. autofunction:: local_clustering

.. autofunction:: local_clustering_binary_undirected

.. autofunction:: node_attributes

.. autofunction:: num_iedges

.. autofunction:: reciprocity

.. autofunction:: shortest_distance

.. autofunction:: shortest_path

.. autofunction:: small_world_propensity

.. autofunction:: spectral_radius

.. autofunction:: subgraph_centrality

.. autofunction:: total_firing_rate

.. autofunction:: transitivity

.. autofunction:: triangle_count

.. autofunction:: triplet_count