Class SymmetryDisplay


  • public class SymmetryDisplay
    extends java.lang.Object
    Class that provides visualizations methods for symmetry alignments. Call the display() method for the default visualization of symmetry.
    Since:
    4.2.0
    Author:
    Aleix Lafita
    • Constructor Detail

      • SymmetryDisplay

        public SymmetryDisplay()
    • Method Detail

      • printSymmetryAxes

        public static java.lang.String printSymmetryAxes​(CeSymmResult symm)
                                                  throws StructureException
        Generates a String that displays the symmetry axes of a structure.
        Parameters:
        symm - CeSymmResult
        Returns:
        Throws:
        StructureException
      • printSymmetryAxes

        public static java.lang.String printSymmetryAxes​(CeSymmResult symm,
                                                         boolean allAxes)
                                                  throws StructureException
        Generates a String that displays the symmetry axes of a structure.
        Parameters:
        symm - CeSymmResult
        allAxes - Indicates whether all axes should be displayed or just the elemenatary ones
        Returns:
        Throws:
        StructureException
      • printSymmetryGroup

        public static java.lang.String printSymmetryGroup​(CeSymmResult symm)
                                                   throws StructureException
        Given a symmetry alignment, it draws the symmetry group axes and the polyhedron box around the structure. It uses the quaternary symmetry detection code, but tries to factor out the alignment and detection steps.
        Parameters:
        symm - CeSymmResult
        Returns:
        Throws:
        StructureException
      • getSymmTitle

        public static java.lang.String getSymmTitle​(CeSymmResult result)
        Create a symmetry title for a display frame (Jmol, alignment, etc). The title contains information about the algorithm, structure id and parameters used.
        Parameters:
        result -
        Returns:
        title String