Krystals Schema - version 1.1 copyright James Ingram 2008 This Schema may be used free of charge by anyone, providing it is not changed in any way. Defines the following elements and subtypes: Elements: 1 krystal: The root element of a krystal (.krys) file. Contains heredity info, and strands. 2 expander: The root element of an expander (.kexp) file. Contains input and output gametes, or the name(s) of the expander(s) where the definition of each gamete can be found. 3 modulator: The root element of a modulator (.kmod) file. Contains a two dimensional array of unsigned integers. Complex Types: 1 strand: a krystal component has a level and a stringOfUnsignedInts 2 gamete: an expander component. Contains lists of pointGroups (fixed points and planets). Simple Types: 1. stringOfUnsignedInts: a component of strands and modulators Is a string of unsignedInts separated by whitespace 2. pointGroup: a gamete component Is a description of a group of points. File Name Types: 1. krystalName: A name meaning any type of krystal (.krys) 1.1 constantKrystalName: A name for a constant krystal (.c.krys) 1.2 lineKrystalName: A name for a line krystal (.l.krys) 1.3 expansionKrystalName: A name for a krystal which is the result of an expansion (.x.krys) 1.4 modulationKrystalName: A name for a krystal which is the result of a modulation (.m.krys) 2. expanderName: The name of an expander (.kexp) file 3. modulatorName: The name of a modulator (.kmod) file A constant krystal's strand has level=0, and contains its (one) value. A line krystal's strand has level=1, and contains its value (stringOfUnsignedInt). density: the name of a krystal file containing the density of each strand (each moment) in this krystal. (A constant density produces a level 1 krystal whose strand has the given constant number of values.) inputPoints: the name of a krystal file containing the name of the gamete input point for each strand in this krystal. For contoured expansions only, the following two input krystals define the contours. If one is present, then both must be present: axis: the name of a krystal file containing axis values in range 1..12 contour: the name of a krystal file containing contour number values in range 1..12 expander: the name of a .kexp file containing the expander (expansion field) for this krystal. x: The name of a krystal file containing the x-coordinate values for the modulator. y: The name of a krystal file containing the y-coordinate values for the modulator. modulator: The name of a modulator file. Strand(s) values are unsigned integers separated by white-space. For example: The level (l) attribute is 0 for constant krystals, but otherwise in the range 1..unlimited. A constant krystal has a single strand with level=0 containing a single unsigned integer. Otherwise, the first strand must have level 1. This is then the *only* level 1 strand in the krystal. The level values describe the krystal's tree structure. A strand is a krystal component consisting of a stringOfUnsignedInts with a level attribute. The level (l) attribute is 0 in constant krystals but otherwise in the range 1..unlimited. A constant krystal has a single strand with level=0 containing a single integer value. Otherwise, the first strand in a krystal must have level 1, and this is the *only* level 1 strand. The level values describe the krystal's tree structure. To save space (there may be very many strands), the krystal element defines strand names to be 's', so a strand looks something like: pointGroups are used by both fixedPoints and planet elements in gametes. In both fixed and planet circular pointGroups, the 'to' element is identical to the "from" element, and the points are distributed evenly around the circle starting at the "from" coordinate. Otherwise, all fixed (non-circular) pointGroups have points at both their 'from' and 'to' coordinates. However, planet pointGroups are contiguous. ONLY THE FINAL POINTGROUP of a planet has a point at its 'to' coordinate. The 'value' of a fixedPoints pointGroup contains as many unsigned integers as there are points, while planets have one value each. A planet's value is stored in each of its subpaths (pointGroups). For example: A modulatorArray is a modulator component consisting of a stringOfUnsignedInts with xdim and ydim attributes. A stringOfUnsignedInts contains a string of 1 or more unsignedInts and whitespace. The string may not be empty. In XML files, the string can be formatted with any kinds of whitespace. For example: All names defined in this file have a prefix, base name and extension. The base names may all contain utf8 alphanumeric, and the following characters: '(', ')', '.', ';', '-', '_' Current prefixes (defined below) are: ck0 a constant krystal lk1 a line krystal xk an expansion mk a modulation e an expander m a modulator The extension meaning "any type of krystal" (this definition) is '.krys'. Examples: xk1x(y)z.krys ck0xyz_12.x.krys, 1234.j.krys, abc-(12)d.m.krys etc." The characters used in the base of an expander name are the same as for all other file name types. The prefix for an expander is 'e' The numbers in brackets are the domains of the in- and output gametes followed by the expander ID. The extension is '.kexp'. Example: "e(7.7.1).kexp", "e(7.7.3).kexp" The characters used in the base of a modulator name are the same as for all other file name types. The prefix for a modulator is 'm' The extension is '.kmod'. Example: "m5x4(240)-1.kmod" The first number after the prefix is the size of the x-dimension of the array The number after the 'x' is the size of the y-dimension of the array The number in brackets is the largest number in the array The prefix for a constant krystal is 'ck0'. The extension is '.krys'. Example: "ck0(56).krys" The number in brackets is the value of the constant. The prefix for a line krystal is 'lk1'. The extension is '.krys'. Examples: "lk1(7)-1.krys", "lk1(7)-2.krys", "lk1(14)-1.krys" The number in brackets is the maximum value in the krystal The number after the '-' is an index which differentiates files which would otherwise have the same name. The prefix for an expansion krystal is 'xk'. The extension is '.krys'. Examples: "xk4(7.7.1)-1.krys", "xk3(7.12.3)-2.krys", "xk5(14.7.2)-1.krys" The number following the prefix is the level of this krystal. The brackets contain the expander identifier, consisting of: the number of points in (the domain of) the input gamete + ',' + the number of points in (the domain of) the output gamete + ',' + the expander ID - an index which differentiates between expanders which would otherwise have the same name The number after the '-' is an index which differentiates between krystals which would otherwise have the same name. The prefix for a modulation krystal is 'mk'. The extension is '.krys'. Examples: "mk4(7)-1.krys", "mk3(7)-2.krys", "mk5(14)-1.krys" The number following the prefix is the level of this krystal. The number in brackets is the maximum value in the krystal The number after the '-' is an index which differentiates files which would otherwise have the same name.