helios.layouts.forceatlas2gpu.ForceAtlas2ServerCalc

class helios.layouts.forceatlas2gpu.ForceAtlas2ServerCalc(edges_buffer_name, positions_buffer_name, info_buffer_name, weights_buffer_name=None, snapshots_buffer_name=None, num_snapshots=0, lin_log_mode=False, edge_weight_influence=1.0, jitter_tolerance=1.0, barnes_hut_optimize=True, barnes_hut_theta=1.0, scaling_ratio=2.0, strong_gravity_mode=False, gravity=1.0)[source]

Bases: helios.layouts.base.NetworkLayoutIPCServerCalc

This Obj. reads the network information stored in a shared memory resource and execute the ForceAtlas2 layout algorithm

Parameters
  • edges_buffer_name (str) – The name of the shared memory buffer where the edges are stored

  • positions_buffer_name (str) – The name of the shared memory buffer where the positions are stored.

  • info_buffer_name (str) –

  • weights_buffer_name (str, optional) –

  • snapshots_buffer_name (str, optional) –

  • num_snapshots (int, optional) –

  • lin_log_mode (bool, default False) –

  • edge_weight_influence (float, default 1.0) –

  • jitter_tolerance (float, default 1.0) –

  • barnes_hut_optimize (bool, default True) –

  • barnes_hut_theta (float, default 1.0) –

  • scaling_ratio (float, default 2.0) –

  • strong_gravity_mode (bool, default False) –

  • gravity (float, default 1.0) –

Methods

start

This method starts the network layout algorithm.

start(steps=100, iters_by_step=3)[source]

This method starts the network layout algorithm.

Parameters
  • steps (int) – number of iterations to perform

  • iters_by_step (int) – number of iterations to perform between each step