RingAtomsMixin

class sknano.core.atoms.mixins.RingAtomsMixin(*args, **kwargs)

Bases: object

Mixin Atoms class for ring statistics analysis.

Attributes

Rn_counter	Return rings per atom counter.
ring_stats	dict of ring statistics.
rings_per_atom	Rings per atom list.

Methods

add_ring(nodes)	Append ring atoms to rings.
analyze_network([cutoff, max_ring_size, ...])	Analyze the network connectivity.
reset_attrs([rings])	Reset the RingAtomsMixin class attributes, then call parent class reset_attrs method.
reset_ring_atoms_attrs()	Reset the RingAtomsMixin class attributes.
update_attrs([rings])	Update the RingAtomsMixin class attributes.
update_ring_stats([angle_reference, ...])

Attributes Summary

Rn_counter	Return rings per atom counter.
ring_stats	dict of ring statistics.
rings_per_atom	Rings per atom list.

Methods Summary

add_ring(nodes)	Append ring atoms to rings.
analyze_network([cutoff, max_ring_size, ...])	Analyze the network connectivity.
reset_attrs([rings])	Reset the RingAtomsMixin class attributes, then call parent class reset_attrs method.
reset_ring_atoms_attrs()	Reset the RingAtomsMixin class attributes.
update_attrs([rings])	Update the RingAtomsMixin class attributes.
update_ring_stats([angle_reference, ...])

Attributes Documentation

Rn_counter

Return rings per atom counter.

Returns: Return type:Counter

ring_stats

dict of ring statistics.

rings_per_atom

Rings per atom list.

Methods Documentation

add_ring(nodes)

Append ring atoms to rings.

analyze_network(cutoff=inf, max_ring_size=None, eps=0.0001, retcodes=None, pyversion=False)

Analyze the network connectivity.

Parameters:

• cutoff (float, optional) –
• max_ring_size (int, optional) –
• eps (float, optional) –
• retcodes (tuple, optional) –

reset_attrs(rings=False, **kwargs)

Reset the RingAtomsMixin class attributes, then call parent class reset_attrs method.

reset_ring_atoms_attrs()

Reset the RingAtomsMixin class attributes.

update_attrs(rings=False, **kwargs)

Update the RingAtomsMixin class attributes.

update_ring_stats(angle_reference=None, bond_reference=None, dihedral_reference=None, improper_reference=None)