org.jmol.symmetry

Class Symmetry

java.lang.Object

org.jmol.symmetry.Symmetry

All Implemented Interfaces:

SymmetryInterface

public class Symmetry
extends java.lang.Object
implements SymmetryInterface

Field Summary

Fields

Modifier and Type	Field and Description
private PointGroup	pointGroup
private SpaceGroup	spaceGroup
private SymmetryInfo	symmetryInfo
private UnitCell	unitCell

Constructor Summary

Constructors

Constructor and Description
Symmetry()

Method Summary

Methods

Modifier and Type	Method and Description
int	addSpaceGroupOperation(java.lang.String xyz, int opId)
void	addSpaceGroupOperationM(Matrix4f mat)
boolean	checkDistance(P3 f1, P3 f2, float distance, float dx, int iRange, int jRange, int kRange, P3 ptOffset)
boolean	checkUnitCell(SymmetryInterface uc, P3 cell, P3 ptTemp, boolean isAbsolute)
boolean	createSpaceGroup(int desiredSpaceGroupIndex, java.lang.String name, float[] notionalUnitCell)
java.lang.String	fcoord(Tuple3f p)
P3[]	getCanonicalCopy(float scale)
P3	getCartesianOffset()
int[]	getCellRange()
boolean	getCoordinatesAreFractional()
P3	getFractionalOffset()
java.lang.Object	getLatticeDesignation()
java.lang.String	getMatrixFromString(java.lang.String xyz, float[] rotTransMatrix, boolean allowScaling)
float[]	getNotionalUnitCell()
java.lang.Object	getPointGroupInfo(int modelIndex, boolean asDraw, boolean asInfo, java.lang.String type, int index, float scale)
java.lang.String	getPointGroupName()
java.lang.Object	getSpaceGroup()
java.util.Map<java.lang.String,java.lang.Object>	getSpaceGroupInfo(ModelSet modelSet, int modelIndex, java.lang.String spaceGroup, int symOp, P3 pt1, P3 pt2, java.lang.String drawID)
java.lang.String	getSpaceGroupInfo(java.lang.String name, SymmetryInterface cellInfo)
java.lang.String	getSpaceGroupName()
Matrix4f	getSpaceGroupOperation(int i)
int	getSpaceGroupOperationCount()
java.lang.String	getSpaceGroupXyz(int i, boolean doNormalize)
java.lang.Object	getSymmetryInfo(ModelSet modelSet, int iModel, int iAtom, SymmetryInterface uc, java.lang.String xyz, int op, P3 pt, P3 pt2, java.lang.String id, int type)
java.lang.String	getSymmetryInfoString()
java.lang.Object[]	getSymmetryOperationDescription(int isym, SymmetryInterface cellInfo, P3 pt1, P3 pt2, java.lang.String id)
java.lang.String	getSymmetryOperationInfo(java.util.Map<java.lang.String,java.lang.Object> sginfo, int symOp, java.lang.String drawID, boolean labelOnly)
java.lang.String[]	getSymmetryOperations()
Tensor	getTensor(float[] parBorU)
SymmetryInterface	getUnitCell(Tuple3f[] points)
float[]	getUnitCellAsArray(boolean vectorsOnly)
java.lang.String	getUnitCellInfo()
float	getUnitCellInfoType(int infoType)
P3	getUnitCellMultiplier()
P3[]	getUnitCellVectors()
P3[]	getUnitCellVertices()
java.lang.String	getUnitsymmetryInfo()
boolean	haveSpaceGroup()
boolean	haveUnitCell()
P3	ijkToPoint3f(int nnn)
private boolean	isNotCentroid(P3 center, int n, int[] minmax, boolean centroidPacked)
boolean	isPeriodic()
boolean	isPolymer()
boolean	isSlab()
boolean	isSupercell()
void	newSpaceGroupPoint(int i, P3 atom1, P3 atom2, int transX, int transY, int transZ)
BS	notInCentroid(ModelSet modelSet, BS bsAtoms, int[] minmax)
V3[]	rotateEllipsoid(int i, P3 ptTemp, V3[] axes, P3 ptTemp1, P3 ptTemp2)
void	setCartesianOffset(Tuple3f origin)
void	setFinalOperations(P3[] atoms, int iAtomFirst, int noSymmetryCount, boolean doNormalize)
void	setLattice(int latt) set symmetry lattice type using Hall rotations
void	setMinMaxLatticeParameters(P3i minXYZ, P3i maxXYZ)
void	setOffset(int nnn)
void	setOffsetPt(P3 pt)
SymmetryInterface	setPointGroup(SymmetryInterface siLast, Atom[] atomset, BS bsAtoms, boolean haveVibration, float distanceTolerance, float linearTolerance)
void	setSpaceGroup(boolean doNormalize)
void	setSpaceGroupS(SymmetryInterface symmetry)
void	setSymmetryInfo(int modelIndex, java.util.Map<java.lang.String,java.lang.Object> modelAuxiliaryInfo)
void	setUnitCell(float[] notionalUnitCell)
void	setUnitCellAllFractionalRelative(boolean TF)
void	setUnitCellOrientation(Matrix3f matUnitCellOrientation)
void	toCartesian(P3 fpt, boolean isAbsolute)
void	toFractional(P3 pt, boolean isAbsolute)
P3	toSupercell(P3 fpt)
void	toUnitCell(P3 pt, P3 offset)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pointGroup

private PointGroup pointGroup

spaceGroup

private SpaceGroup spaceGroup

symmetryInfo

private SymmetryInfo symmetryInfo

unitCell

private UnitCell unitCell

Constructor Detail

Symmetry

public Symmetry()

Method Detail

setPointGroup

public SymmetryInterface setPointGroup(SymmetryInterface siLast,
                              Atom[] atomset,
                              BS bsAtoms,
                              boolean haveVibration,
                              float distanceTolerance,
                              float linearTolerance)

Specified by:

setPointGroup in interface SymmetryInterface

getPointGroupName

public java.lang.String getPointGroupName()

Specified by:

getPointGroupName in interface SymmetryInterface

getPointGroupInfo

public java.lang.Object getPointGroupInfo(int modelIndex,
                                 boolean asDraw,
                                 boolean asInfo,
                                 java.lang.String type,
                                 int index,
                                 float scale)

Specified by:

getPointGroupInfo in interface SymmetryInterface

setSpaceGroup

public void setSpaceGroup(boolean doNormalize)

Specified by:

setSpaceGroup in interface SymmetryInterface

addSpaceGroupOperation

public int addSpaceGroupOperation(java.lang.String xyz,
                         int opId)

Specified by:

addSpaceGroupOperation in interface SymmetryInterface

addSpaceGroupOperationM

public void addSpaceGroupOperationM(Matrix4f mat)

Specified by:

addSpaceGroupOperationM in interface SymmetryInterface

setLattice

public void setLattice(int latt)

Description copied from interface: SymmetryInterface

set symmetry lattice type using Hall rotations

Specified by:

setLattice in interface SymmetryInterface

Parameters:

latt - SHELX index or character lattice character P I R F A B C S T or \0

getSpaceGroupName

public java.lang.String getSpaceGroupName()

Specified by:

getSpaceGroupName in interface SymmetryInterface

getSpaceGroup

public java.lang.Object getSpaceGroup()

Specified by:

getSpaceGroup in interface SymmetryInterface

setSpaceGroupS

public void setSpaceGroupS(SymmetryInterface symmetry)

Specified by:

setSpaceGroupS in interface SymmetryInterface

createSpaceGroup

public boolean createSpaceGroup(int desiredSpaceGroupIndex,
                       java.lang.String name,
                       float[] notionalUnitCell)

Specified by:

createSpaceGroup in interface SymmetryInterface

haveSpaceGroup

public boolean haveSpaceGroup()

Specified by:

haveSpaceGroup in interface SymmetryInterface

getSpaceGroupInfo

public java.lang.String getSpaceGroupInfo(java.lang.String name,
                                 SymmetryInterface cellInfo)

Specified by:

getSpaceGroupInfo in interface SymmetryInterface

getLatticeDesignation

public java.lang.Object getLatticeDesignation()

Specified by:

getLatticeDesignation in interface SymmetryInterface

setFinalOperations

public void setFinalOperations(P3[] atoms,
                      int iAtomFirst,
                      int noSymmetryCount,
                      boolean doNormalize)

Specified by:

setFinalOperations in interface SymmetryInterface

getSpaceGroupOperationCount

public int getSpaceGroupOperationCount()

Specified by:

getSpaceGroupOperationCount in interface SymmetryInterface

getSpaceGroupOperation

public Matrix4f getSpaceGroupOperation(int i)

Specified by:

getSpaceGroupOperation in interface SymmetryInterface

getSpaceGroupXyz

public java.lang.String getSpaceGroupXyz(int i,
                                boolean doNormalize)

Specified by:

getSpaceGroupXyz in interface SymmetryInterface

newSpaceGroupPoint

public void newSpaceGroupPoint(int i,
                      P3 atom1,
                      P3 atom2,
                      int transX,
                      int transY,
                      int transZ)

Specified by:

newSpaceGroupPoint in interface SymmetryInterface

rotateEllipsoid

public V3[] rotateEllipsoid(int i,
                   P3 ptTemp,
                   V3[] axes,
                   P3 ptTemp1,
                   P3 ptTemp2)

Specified by:

rotateEllipsoid in interface SymmetryInterface

getSymmetryOperationDescription

public java.lang.Object[] getSymmetryOperationDescription(int isym,
                                                 SymmetryInterface cellInfo,
                                                 P3 pt1,
                                                 P3 pt2,
                                                 java.lang.String id)

Specified by:

getSymmetryOperationDescription in interface SymmetryInterface

fcoord

public java.lang.String fcoord(Tuple3f p)

Specified by:

fcoord in interface SymmetryInterface

getMatrixFromString

public java.lang.String getMatrixFromString(java.lang.String xyz,
                                   float[] rotTransMatrix,
                                   boolean allowScaling)

Specified by:

getMatrixFromString in interface SymmetryInterface

ijkToPoint3f

public P3 ijkToPoint3f(int nnn)

Specified by:

ijkToPoint3f in interface SymmetryInterface

getCoordinatesAreFractional

public boolean getCoordinatesAreFractional()

Specified by:

getCoordinatesAreFractional in interface SymmetryInterface

getCellRange

public int[] getCellRange()

Specified by:

getCellRange in interface SymmetryInterface

getSymmetryInfoString

public java.lang.String getSymmetryInfoString()

Specified by:

getSymmetryInfoString in interface SymmetryInterface

getSymmetryOperations

public java.lang.String[] getSymmetryOperations()

Specified by:

getSymmetryOperations in interface SymmetryInterface

isPeriodic

public boolean isPeriodic()

Specified by:

isPeriodic in interface SymmetryInterface

setSymmetryInfo

public void setSymmetryInfo(int modelIndex,
                   java.util.Map<java.lang.String,java.lang.Object> modelAuxiliaryInfo)

Specified by:

setSymmetryInfo in interface SymmetryInterface

setUnitCell

public void setUnitCell(float[] notionalUnitCell)

Specified by:

setUnitCell in interface SymmetryInterface

haveUnitCell

public boolean haveUnitCell()

Specified by:

haveUnitCell in interface SymmetryInterface

getUnitsymmetryInfo

public java.lang.String getUnitsymmetryInfo()

setUnitCellOrientation

public void setUnitCellOrientation(Matrix3f matUnitCellOrientation)

Specified by:

setUnitCellOrientation in interface SymmetryInterface

toUnitCell

public void toUnitCell(P3 pt,
              P3 offset)

Specified by:

toUnitCell in interface SymmetryInterface

toCartesian

public void toCartesian(P3 fpt,
               boolean isAbsolute)

Specified by:

toCartesian in interface SymmetryInterface

toSupercell

public P3 toSupercell(P3 fpt)

Specified by:

toSupercell in interface SymmetryInterface

toFractional

public void toFractional(P3 pt,
                boolean isAbsolute)

Specified by:

toFractional in interface SymmetryInterface

getNotionalUnitCell

public float[] getNotionalUnitCell()

Specified by:

getNotionalUnitCell in interface SymmetryInterface

getUnitCellAsArray

public float[] getUnitCellAsArray(boolean vectorsOnly)

Specified by:

getUnitCellAsArray in interface SymmetryInterface

getTensor

public Tensor getTensor(float[] parBorU)

Specified by:

getTensor in interface SymmetryInterface

getUnitCellVertices

public P3[] getUnitCellVertices()

Specified by:

getUnitCellVertices in interface SymmetryInterface

getCartesianOffset

public P3 getCartesianOffset()

Specified by:

getCartesianOffset in interface SymmetryInterface

setCartesianOffset

public void setCartesianOffset(Tuple3f origin)

Specified by:

setCartesianOffset in interface SymmetryInterface

getFractionalOffset

public P3 getFractionalOffset()

Specified by:

getFractionalOffset in interface SymmetryInterface

setOffsetPt

public void setOffsetPt(P3 pt)

Specified by:

setOffsetPt in interface SymmetryInterface

setOffset

public void setOffset(int nnn)

Specified by:

setOffset in interface SymmetryInterface

getUnitCellMultiplier

public P3 getUnitCellMultiplier()

Specified by:

getUnitCellMultiplier in interface SymmetryInterface

getCanonicalCopy

public P3[] getCanonicalCopy(float scale)

Specified by:

getCanonicalCopy in interface SymmetryInterface

getUnitCellInfoType

public float getUnitCellInfoType(int infoType)

Specified by:

getUnitCellInfoType in interface SymmetryInterface

getUnitCellInfo

public java.lang.String getUnitCellInfo()

Specified by:

getUnitCellInfo in interface SymmetryInterface

isSlab

public boolean isSlab()

Specified by:

isSlab in interface SymmetryInterface

isPolymer

public boolean isPolymer()

Specified by:

isPolymer in interface SymmetryInterface

setMinMaxLatticeParameters

public void setMinMaxLatticeParameters(P3i minXYZ,
                              P3i maxXYZ)

Specified by:

setMinMaxLatticeParameters in interface SymmetryInterface

setUnitCellAllFractionalRelative

public void setUnitCellAllFractionalRelative(boolean TF)

Specified by:

setUnitCellAllFractionalRelative in interface SymmetryInterface

checkDistance

public boolean checkDistance(P3 f1,
                    P3 f2,
                    float distance,
                    float dx,
                    int iRange,
                    int jRange,
                    int kRange,
                    P3 ptOffset)

Specified by:

checkDistance in interface SymmetryInterface

getUnitCellVectors

public P3[] getUnitCellVectors()

Specified by:

getUnitCellVectors in interface SymmetryInterface

getUnitCell

public SymmetryInterface getUnitCell(Tuple3f[] points)

Specified by:

getUnitCell in interface SymmetryInterface

isSupercell

public boolean isSupercell()

Specified by:

isSupercell in interface SymmetryInterface

getSymmetryOperationInfo

public java.lang.String getSymmetryOperationInfo(java.util.Map<java.lang.String,java.lang.Object> sginfo,
                                        int symOp,
                                        java.lang.String drawID,
                                        boolean labelOnly)

Specified by:

getSymmetryOperationInfo in interface SymmetryInterface

getSpaceGroupInfo

public java.util.Map<java.lang.String,java.lang.Object> getSpaceGroupInfo(ModelSet modelSet,
                                                                 int modelIndex,
                                                                 java.lang.String spaceGroup,
                                                                 int symOp,
                                                                 P3 pt1,
                                                                 P3 pt2,
                                                                 java.lang.String drawID)

Specified by:

getSpaceGroupInfo in interface SymmetryInterface

getSymmetryInfo

public java.lang.Object getSymmetryInfo(ModelSet modelSet,
                               int iModel,
                               int iAtom,
                               SymmetryInterface uc,
                               java.lang.String xyz,
                               int op,
                               P3 pt,
                               P3 pt2,
                               java.lang.String id,
                               int type)

Specified by:

getSymmetryInfo in interface SymmetryInterface

notInCentroid

public BS notInCentroid(ModelSet modelSet,
               BS bsAtoms,
               int[] minmax)

Specified by:

notInCentroid in interface SymmetryInterface

isNotCentroid

private boolean isNotCentroid(P3 center,
                    int n,
                    int[] minmax,
                    boolean centroidPacked)

checkUnitCell

public boolean checkUnitCell(SymmetryInterface uc,
                    P3 cell,
                    P3 ptTemp,
                    boolean isAbsolute)

Specified by:

checkUnitCell in interface SymmetryInterface