NetworCh Documentation: Difference between revisions

From Micro and Nano Mechanics Group
Jump to navigation Jump to search
Line 110: Line 110:


== Functions for network analysis ==
== Functions for network analysis ==
{| class="wikitable" cellpadding="2"
|-
| adjacency.m
| Generate the adjacency matrix from the links/segments list
|-
| assortativity.m
| Calculate the Pearson correlation coefficient that measures the assortativity of the nodes of the network
|-
| average_degree.m
| Calculate the average nodes degree and the exponent of best fit power-law distribution
|-
| average_shortest_path.m
| Compute the average shortest path between all pairs of nodes of the network
|-
| clustering.m
| Calculate the clustering and transitivity coefficients of the network
|-
| construct_shortest_path.m
| Construct the shortest path (sequence of nodes) from a source to a target node
|-
| extract_component.m
| Extract a given component from the network
|-
| find_components.m
| Find unconnected components of the network
|-
| link_density.m
| Calculate the link density of the network
|-
| normalized_laplacian.m
| Compute the normalized graph Laplacian matrix of the network
|-
| random_network.m
| Generate a random network that follows a power-law degree distribution
|-
| shortest_path.m
| Compute shortest path from a source to all other vertices or to a given target
|}

Revision as of 22:05, 16 October 2016

NetworCh manuals: Getting started

Documentation

Common functions

all_segments_length.m Return the lengths of all segments by applying PBC
chop_structure.m Extract a slice of the network by chopping the structure in a selected direction
export_gexf.m Export the network in GEXF format
export_gml.m Export the network in GML format
extract_links.m Extract a sub-network that only contains given links from the original network
extract_nodes.m Extract a sub-network that only contains given nodes from the original network
facet_intersection.m Find which facet of the rectangular primary volume is intersected by a given segment
facet_intersection_position.m Determine the facet and the intersection point between the rectangular primary volume and a given segment
find_box_neighbors.m Find neighbors of a given node based on box partitioning
find_segment.m Find the position of a given segment within the links list
generate_connectivity.m Generate nodal connectivity table corresponding to the links list
outside_box.m Check if point(s) lie(s) outside of the primary volume
partition_box.m Sort nodes by partitioning the primary volume into boxes
pbc_fold.m Folds point(s) into the primary volume by applying PBC
pbc_position.m Returns the closest image of a point to another by applying PBC
plot_box.m Plot the box delimiting the primary volume
plot_nodes.m Plot a subset of nodes of the network
plot_segments.m Plot a subset of segments of the network
plot_structure.m Plot the full network structure
remove_double_links.m Remove double-links from the network
remove_link.m Remove a given link from the network
remove_nodes.m Remove given nodes from the network
remove_self_loops.m Remove self-loops from the network
replicate_volume.m Duplicate initial network by assembling 2 periodic replica in a given direction
replicate_volume_3.m Replicate initial network by assembling 3 periodic replica in a given direction
scale_structure.m Rescale a structure by a scaling factor
segment_length.m Compute length of a given segment by applying PBC
segment_plane_intersection.m Compute the intersection between a plane and a given segment
test_structure.m Generate test structures to test network functions


Functions for DD structures analysis

Functions for MD structures analysis

read_cgsd.m Read CGSD files (.cn and .bnd)
merge_cross_links.m Merge cross-linked nodes into single nodes and flag them


Functions for network analysis

adjacency.m Generate the adjacency matrix from the links/segments list
assortativity.m Calculate the Pearson correlation coefficient that measures the assortativity of the nodes of the network
average_degree.m Calculate the average nodes degree and the exponent of best fit power-law distribution
average_shortest_path.m Compute the average shortest path between all pairs of nodes of the network
clustering.m Calculate the clustering and transitivity coefficients of the network
construct_shortest_path.m Construct the shortest path (sequence of nodes) from a source to a target node
extract_component.m Extract a given component from the network
find_components.m Find unconnected components of the network
link_density.m Calculate the link density of the network
normalized_laplacian.m Compute the normalized graph Laplacian matrix of the network
random_network.m Generate a random network that follows a power-law degree distribution
shortest_path.m Compute shortest path from a source to all other vertices or to a given target