orbithunter.EquilibriumOrbitKS.glue_dimensions

classmethod EquilibriumOrbitKS.glue_dimensions(dimension_tuples, glue_shape, include_zero_dimensions=True)

Strategy for combining tile dimensions in gluing; default is arithmetic averaging.

Parameters

dimension_tuplestuple of tuples

A tuple with a number of elements equal to the number of dimensions; each of these dimension-tuples contains a number of values equal to the number of orbits in the prospective gluing.

glue_shapetuple of ints

The shape of the gluing being performed i.e. for a 2x2 orbit grid glue_shape would equal (2,2).

include_zero_dimensionsbool

If True, then the calculation of average dimensions includes 0’s in the averages; else they are treated like they do not exist.

Returns

glued_parameterstuple

tuple of parameters same dimension and type as self.parameters

Notes

This returns an average of parameter tuples, used exclusively in the gluing method; wherein the new tile dimensions needs to be decided upon/inferred from the original tiles. As this average is only a very crude approximation, it can be worthwhile to also simply search the parameter space for a combination of dimensions which reduces the cost. The strategy produced by this method is simply a baseline; there may be way better ways but it is likely highly dependent on equation.