org.biojava.nbio.structure.symmetry.core

Class QuatSymmetryDetector

java.lang.Object

org.biojava.nbio.structure.symmetry.core.QuatSymmetryDetector

public class QuatSymmetryDetector
extends Object

Detects global and local quaternary protein structure symmetry in a structure. The QuatSymmetryParameter settings affect the calculated results.

Author:

Peter Rose

Constructor Summary

Constructors

Constructor and Description
QuatSymmetryDetector(Structure structure, QuatSymmetryParameters parameters)

Method Summary

Modifier and Type	Method and Description
static QuatSymmetryResults	calcQuatSymmetry(Subunits subunits, QuatSymmetryParameters parameters)
List<QuatSymmetryResults>	getGlobalSymmetry() Returns list of global quaternary structure symmetry results
List<List<QuatSymmetryResults>>	getLocalSymmetries() Returns a list of lists of local quaternary structure symmetry results
boolean	hasProteinSubunits() Returns true if structure contains protein subunits.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuatSymmetryDetector

public QuatSymmetryDetector(Structure structure,
                            QuatSymmetryParameters parameters)

Method Detail

hasProteinSubunits

public boolean hasProteinSubunits()

Returns true if structure contains protein subunits. The other methods in this class will only return data if protein subunits are present. Always use this method first, before retrieving global or local symmetry results.

Returns:

true if protein subunits are present

getGlobalSymmetry

public List<QuatSymmetryResults> getGlobalSymmetry()

Returns list of global quaternary structure symmetry results

Returns:

list of global quaternary structure symmetry results

getLocalSymmetries

public List<List<QuatSymmetryResults>> getLocalSymmetries()

Returns a list of lists of local quaternary structure symmetry results

Returns:

list of lists of local quaternary structure symmetry results

calcQuatSymmetry

public static QuatSymmetryResults calcQuatSymmetry(Subunits subunits,
                                                   QuatSymmetryParameters parameters)