POAVAtomsMixin

class sknano.core.atoms.POAVAtomsMixin(*args, **kwargs)[source] [edit on github][source]

Bases: object

Mixin class for POAV analysis.

Attributes

POAV1 List of POAVAtom POAV1 POAV1 attribute.
POAV2 List of POAVAtom POAV2 POAV2 attribute.
POAVR List of POAVAtom POAVR POAVR attribute.

Methods

analyze_POAVs(**kwargs) Compute POAV1, POAV2, POAVR.
compute_POAVs(**kwargs) Alias for analyze_POAVs.
get_POAV_attr(POAV_class, attr) Return list of POAVAtom POAV1 POAV2 or POAVR attribute.
reset_attrs([poavs]) Reset the POAVAtomsMixin class attributes, then call parent class reset_attrs method.
reset_poav_atoms_attrs() Reset the POAVAtomsMixin class attributes.
update_attrs([poavs]) Update POAVAtomsMixin class attributes.

Attributes Summary

POAV1 List of POAVAtom POAV1 POAV1 attribute.
POAV2 List of POAVAtom POAV2 POAV2 attribute.
POAVR List of POAVAtom POAVR POAVR attribute.

Methods Summary

analyze_POAVs(**kwargs) Compute POAV1, POAV2, POAVR.
compute_POAVs(**kwargs) Alias for analyze_POAVs.
get_POAV_attr(POAV_class, attr) Return list of POAVAtom POAV1 POAV2 or POAVR attribute.
reset_attrs([poavs]) Reset the POAVAtomsMixin class attributes, then call parent class reset_attrs method.
reset_poav_atoms_attrs() Reset the POAVAtomsMixin class attributes.
update_attrs([poavs]) Update POAVAtomsMixin class attributes.

Attributes Documentation

POAV1

List of POAVAtom POAV1 POAV1 attribute.

POAV2

List of POAVAtom POAV2 POAV2 attribute.

POAVR

List of POAVAtom POAVR POAVR attribute.

Methods Documentation

analyze_POAVs(**kwargs)[source] [edit on github][source]

Compute POAV1, POAV2, POAVR.

compute_POAVs(**kwargs)[source] [edit on github][source]

Alias for analyze_POAVs.

get_POAV_attr(POAV_class, attr)[source] [edit on github][source]

Return list of POAVAtom POAV1 POAV2 or POAVR attribute.

Parameters:
  • POAV_class ({'POAV1', 'POAV2', 'POAVR'}) –
  • attr (str) –
Returns:
Return type:

tuple
reset_attrs(poavs=False, **kwargs)[source] [edit on github][source]

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

reset_poav_atoms_attrs()[source] [edit on github][source]

Reset the POAVAtomsMixin class attributes.

update_attrs(poavs=False, **kwargs)[source] [edit on github][source]

Update POAVAtomsMixin class attributes.