worms.criteria package

Submodules

worms.criteria.base module

TODO: Summary

worms.criteria.base.Ux

TYPE – Description

worms.criteria.base.Uy

TYPE – Description

worms.criteria.base.Uz

TYPE – Description

class worms.criteria.base.CriteriaList(children)

Bases: worms.criteria.base.WormCriteria

TODO: Summary

children

TYPE – Description

score(**kw)

TODO: Summary

Parameters:kw – passthru args Returns:Description Return type:TYPE

class worms.criteria.base.NullCriteria(from_seg=0, to_seg=-1, origin_seg=None)

Bases: worms.criteria.base.WormCriteria

TODO: Summary

from_seg

TYPE – Description

to_seg

TYPE – Description

alignment(segpos, **kw)

TODO: Summary

Parameters:

• segpos (TYPE) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

jit_lossfunc()

score(segpos, **kw)

TODO: Summary

Parameters:

• segpos (TYPE) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

class worms.criteria.base.WormCriteria

Bases: abc.ABC

TODO: Summary

allowed_attributes

TYPE – Description

allowed_attributes = ('last_body_same_as', 'symname', 'is_cyclic', 'alignment', 'from_seg', 'to_seg', 'origin_seg', 'symfile_modifiers', 'crystinfo')

score(**kw)

TODO: Summary

Parameters:kw – passthru args

worms.criteria.bounded module

class worms.criteria.bounded.AxesIntersect(symname, tgtaxis1, tgtaxis2, from_seg, *, tol=1.0, lever=50, to_seg=-1, distinct_axes=False)

Bases: worms.criteria.base.WormCriteria

TODO: Summary

angle

TYPE – Description

distinct_axes

TYPE – Description

from_seg

TYPE – Description

lever

TYPE – Description

rot_tol

TYPE – Description

sym_axes

TYPE – Description

symname

TYPE – Description

tgtaxis1

TYPE – Description

tgtaxis2

TYPE – Description

to_seg

TYPE – Description

tol

TYPE – Description

alignment(segpos, debug=0, **kw)

TODO: Summary

Parameters:

• segpos (TYPE) – Description
• debug (int, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

Raises:

AssertionError – Description

score(segpos, verbosity=False, **kw)

TODO: Summary

Parameters:

• segpos (TYPE) – Description
• verbosity (bool, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

worms.criteria.bounded.D2(c2=0, c2b=-1, **kw)

TODO: Summary

Parameters:

• c2 (int, optional) – Description
• c2b (TYPE, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

worms.criteria.bounded.D3(c3=0, c2=-1, **kw)

TODO: Summary

Parameters:

• c3 (int, optional) – Description
• c2 (TYPE, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

worms.criteria.bounded.D4(c4=0, c2=-1, **kw)

TODO: Summary

Parameters:

• c4 (int, optional) – Description
• c2 (TYPE, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

worms.criteria.bounded.D5(c5=0, c2=-1, **kw)

TODO: Summary

Parameters:

• c5 (int, optional) – Description
• c2 (TYPE, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

worms.criteria.bounded.D6(c6=0, c2=-1, **kw)

TODO: Summary

Parameters:

• c6 (int, optional) – Description
• c2 (TYPE, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

worms.criteria.bounded.Icosahedral(c5=None, c3=None, c2=None, **kw)

TODO: Summary

Parameters:

• c5 (None, optional) – Description
• c3 (None, optional) – Description
• c2 (None, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

Raises:

ValueError – Description

worms.criteria.bounded.Octahedral(c4=None, c3=None, c2=None, **kw)

TODO: Summary

Parameters:

• c4 (None, optional) – Description
• c3 (None, optional) – Description
• c2 (None, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

Raises:

ValueError – Description

worms.criteria.bounded.Tetrahedral(c3=None, c2=None, c3b=None, **kw)

TODO: Summary

Parameters:

• c3 (None, optional) – Description
• c2 (None, optional) – Description
• c3b (None, optional) – Description
• kw – passthru args

Returns:

Description

Return type:

TYPE

Raises:

ValueError – Description

worms.criteria.cyclic module

class worms.criteria.cyclic.Cyclic(symmetry=1, from_seg=0, *, tol=1.0, origin_seg=None, lever=50.0, to_seg=-1, min_radius=0)

Bases: worms.criteria.base.WormCriteria

alignment(segpos, **kw)

jit_lossfunc()

score(segpos, *, verbosity=False, **kw)

TODO: Summary

Parameters:kw – passthru args

worms.criteria.unbounded module

class worms.criteria.unbounded.AxesAngle(symname, tgtaxis1, tgtaxis2, from_seg, *, tol=1.0, lever=50, to_seg=-1, space_group_str=None)

Bases: worms.criteria.base.WormCriteria

alignment(segpos, out_cell_spacing=False, **kw)

Alignment to move stuff to be in line with symdef file

Parameters:

• segpos (lst) – List of segment positions / coordinates.
• I'll accept any "non-positional" argument as name = value, and store in a dictionary (**kw) –

crystinfo(segpos)

score(segpos, **kw)

Score

Parameters:

• segpos (lst) – List of segment positions / coordinates.
• I'll accept any "non-positional" argument as name = value, and store in a dictionary (**kw) –

symfile_modifiers(segpos)

worms.criteria.unbounded.Crystal_F432_C3_C4(c3a=None, c4b=None, **kw)

worms.criteria.unbounded.Crystal_I213_C2_C3(c2a=None, c3b=None, **kw)

worms.criteria.unbounded.Crystal_I432_C2_C4(c2a=None, c4b=None, **kw)

worms.criteria.unbounded.Crystal_P213_C3_C3(c3a=None, c3b=None, **kw)

worms.criteria.unbounded.Crystal_P4132_C2_C3(c2a=None, c3b=None, **kw)

worms.criteria.unbounded.Crystal_P432_C4_C4(c4a=None, c4b=None, **kw)

worms.criteria.unbounded.Sheet_P321(c3=None, c2=None, **kw)

worms.criteria.unbounded.Sheet_P4212(c4=None, c2=None, **kw)

worms.criteria.unbounded.Sheet_P6(c6=None, c2=None, **kw)

Module contents