Documentation

collRC is divided into the following modules:

• calc module
  • locality submodule
    • neighbors()
    • quat_to_angle()
    • stretched_neighbors()
    • matrix_to_box()
    • box_to_matrix()
    • expand_around_pbc()
    • padded_neighbors()
    • local_vectors()
    • tangent_connection()
  • morphology submodule
    • central_eta()
    • gyration_radius()
    • gyration_tensor()
    • acylindricity()
    • asphericity()
    • shape_anisotropy()
    • circularity()
    • ellipticity()
  • orient_order submodule
    • global_patic()
    • local_patic()
  • bond_order submodule
    • flat_bond_order()
    • stretched_bond_order()
    • projected_bond_order()
    • steinhardt_bond_order()
    • crystal_connectivity()
    • weighted_chi_graph()
    • global_bond_order()
  • clusters submodule
    • c6_clusters()
    • cluster_averager()
    • cluster_com()
    • cluster_rg()
    • cluster_gyrate()
    • cluster_shape()
• visuals module
  • shapes submodule
    • SuperEllipse
    • flat_patches()
    • projected_patches()
    • plot_principal_axes()
  • fields submodule
    • Field
    • contour_PEL()
    • spectral_PEL()
    • PEL_arrows()
• coloring module
  • base submodule
    • mcolor()
    • color_gradient()
    • color_blender()
    • ColorBase
    • ColorBlender
  • morphcolor submodule
    • ColorEta0
    • ColorRg
    • ColorCirc
    • ColorEpsPhase
  • paticcolor submodule
    • ColorS2
    • ColorS2Phase
    • ColorS2G
    • ColorT4
    • ColorT4G
  • bondcolor submodule
    • ColorBondOrder
    • ColorPsiG
    • ColorPsiPhase
    • ColorQG
    • ColorConn
    • ColorConnG
  • defectcolor submodule
    • ColorS2Defects
    • ColorC6Defects
    • ColorC4Defects
• render module
  • render_npole()
  • render_3d()
  • render_sphere()
  • render_surf()
  • animate()