|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectde.jstacs.sequenceScores.differentiable.AbstractDifferentiableSequenceScore
de.jstacs.sequenceScores.statisticalModels.differentiable.AbstractDifferentiableStatisticalModel
de.jstacs.sequenceScores.statisticalModels.differentiable.mixture.AbstractMixtureDiffSM
de.jstacs.sequenceScores.statisticalModels.differentiable.mixture.motif.ExtendedZOOPSDiffSM
public class ExtendedZOOPSDiffSM
This class handles mixtures with at least one hidden motif.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface de.jstacs.motifDiscovery.MotifDiscoverer |
|---|
MotifDiscoverer.KindOfProfile |
| Field Summary | |
|---|---|
static boolean |
CONTAINS_ALWAYS_A_MOTIF
This constant indicates that in each sequence has one binding site of a motif instance (similar to OOPS). |
static boolean |
CONTAINS_SOMETIMES_A_MOTIF
This constant indicates that a sequence possibly has one binding site of a motif instance (similar to ZOOPS). |
| Fields inherited from class de.jstacs.sequenceScores.statisticalModels.differentiable.mixture.AbstractMixtureDiffSM |
|---|
componentScore, dList, freeParams, function, hiddenParameter, hiddenPotential, iList, logGammaSum, logHiddenNorm, logHiddenPotential, norm, optimizeHidden, paramRef, partNorm |
| Fields inherited from class de.jstacs.sequenceScores.differentiable.AbstractDifferentiableSequenceScore |
|---|
alphabets, length, r |
| Fields inherited from interface de.jstacs.sequenceScores.differentiable.DifferentiableSequenceScore |
|---|
UNKNOWN |
| Constructor Summary | |
|---|---|
ExtendedZOOPSDiffSM(boolean type,
int length,
int starts,
boolean plugIn,
HomogeneousDiffSM bg,
DifferentiableStatisticalModel[] motif,
DurationDiffSM[] posPrior,
boolean plugInBg)
This constructor creates an instance of ExtendedZOOPSDiffSM that allows to have one site of the specified motifs in a Sequence. |
|
ExtendedZOOPSDiffSM(boolean type,
int length,
int starts,
boolean plugIn,
HomogeneousDiffSM bg,
DifferentiableStatisticalModel motif,
DurationDiffSM posPrior,
boolean plugInBg)
This constructor creates an instance of ExtendedZOOPSDiffSM that is either an OOPS or a ZOOPS model depending on the chosen type. |
|
ExtendedZOOPSDiffSM(StringBuffer source)
This is the constructor for the interface Storable. |
|
| Method Summary | |
|---|---|
void |
adjustHiddenParameters(int classIndex,
DataSet[] data,
double[][] dataWeights)
Adjusts all hidden parameters including duration and mixture parameters according to the current values of the remaining parameters. |
ExtendedZOOPSDiffSM |
clone()
Creates a clone (deep copy) of the current DifferentiableSequenceScore
instance. |
protected void |
extractFurtherInformation(StringBuffer xml)
This method is the opposite of AbstractMixtureDiffSM.getFurtherInformation(). |
protected int |
fillComponentScoreOf(int i,
Sequence seq,
int start)
This method fills an internal array with the partial scores. |
protected void |
fillComponentScores(Sequence seq,
int start)
Fills the internal array AbstractMixtureDiffSM.componentScore with the logarithmic
scores of the components given a Sequence. |
double |
getESS()
Returns the equivalent sample size (ess) of this model, i.e. |
protected StringBuffer |
getFurtherInformation()
This method is used to append further information of the instance to the XML representation. |
int |
getGlobalIndexOfMotifInComponent(int component,
int motif)
Returns the global index of the motif used in
component. |
double |
getHyperparameterForHiddenParameter(int index)
This method returns the hyperparameter for the hidden parameter with index index. |
int |
getIndexOfMaximalComponentFor(Sequence sequence)
Returns the index of the component with the maximal score for the sequence sequence. |
String |
getInstanceName()
Should return a short instance name such as iMM(0), BN(2), ... |
protected double |
getLogNormalizationConstantForComponent(int i)
Computes the logarithm of the normalization constant for the component i. |
double |
getLogPartialNormalizationConstant(int parameterIndex)
Returns the logarithm of the partial normalization constant for the parameter with index parameterIndex. |
double |
getLogScoreAndPartialDerivation(Sequence seq,
int start,
IntList indices,
DoubleList partialDer)
Returns the logarithmic score for a Sequence beginning at
position start in the Sequence and fills lists with
the indices and the partial derivations. |
double |
getLogScoreFor(Sequence seq,
int start)
Returns the logarithmic score for the Sequence seq
beginning at position start in the Sequence. |
int |
getMotifLength(int motif)
This method returns the length of the motif with index motif
. |
int |
getNumberOfMotifs()
Returns the number of motifs for this MotifDiscoverer. |
int |
getNumberOfMotifsInComponent(int component)
Returns the number of motifs that are used in the component component of this MotifDiscoverer. |
double[] |
getProfileOfScoresFor(int component,
int motif,
Sequence sequence,
int startpos,
MotifDiscoverer.KindOfProfile dist)
Returns the profile of the scores for component component
and motif motif at all possible start positions of the motif
in the sequence sequence beginning at startpos. |
double[] |
getStrandProbabilitiesFor(int component,
int motif,
Sequence sequence,
int startpos)
This method returns the probabilities of the strand orientations for a given subsequence if it is considered as site of the motif model in a specific component. |
void |
initializeFunctionRandomly(boolean freeParams)
This method initializes the DifferentiableSequenceScore randomly. |
void |
initializeMotif(int motif,
DataSet data,
double[] weights)
This method allows to initialize the model of a motif manually using a weighted data set. |
void |
initializeMotifRandomly(int motif)
This method initializes the motif with index motif randomly using for instance DifferentiableSequenceScore.initializeFunctionRandomly(boolean). |
protected void |
initializeUsingPlugIn(int index,
boolean freeParams,
DataSet[] data,
double[][] weights)
This method initializes the functions using the data in some way. |
boolean |
modifyMotif(int motif,
int offsetLeft,
int offsetRight)
Manually modifies the motif model with index motifIndex. |
String |
toString(NumberFormat nf)
This method returns a String representation of the instance. |
| Methods inherited from class de.jstacs.sequenceScores.statisticalModels.differentiable.AbstractDifferentiableStatisticalModel |
|---|
emitDataSet, getInitialClassParam, getLogProbFor, getLogProbFor, getLogProbFor, getLogScoreFor, getLogScoreFor, getMaximalMarkovOrder, isNormalized |
| Methods inherited from class de.jstacs.sequenceScores.differentiable.AbstractDifferentiableSequenceScore |
|---|
getAlphabetContainer, getCharacteristics, getLength, getLogScoreAndPartialDerivation, getLogScoreAndPartialDerivation, getLogScoreFor, getLogScoreFor, getNumberOfStarts, getNumericalCharacteristics |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface de.jstacs.motifDiscovery.MotifDiscoverer |
|---|
getNumberOfComponents |
| Methods inherited from interface de.jstacs.Storable |
|---|
toXML |
| Methods inherited from interface de.jstacs.sequenceScores.differentiable.DifferentiableSequenceScore |
|---|
getInitialClassParam, getLogScoreAndPartialDerivation, getLogScoreAndPartialDerivation |
| Methods inherited from interface de.jstacs.sequenceScores.statisticalModels.StatisticalModel |
|---|
emitDataSet, getLogProbFor, getLogProbFor, getLogProbFor, getMaximalMarkovOrder |
| Methods inherited from interface de.jstacs.sequenceScores.SequenceScore |
|---|
getAlphabetContainer, getCharacteristics, getLength, getLogScoreFor, getLogScoreFor, getLogScoreFor, getLogScoreFor, getNumericalCharacteristics |
| Field Detail |
|---|
public static final boolean CONTAINS_ALWAYS_A_MOTIF
public static final boolean CONTAINS_SOMETIMES_A_MOTIF
| Constructor Detail |
|---|
public ExtendedZOOPSDiffSM(boolean type,
int length,
int starts,
boolean plugIn,
HomogeneousDiffSM bg,
DifferentiableStatisticalModel motif,
DurationDiffSM posPrior,
boolean plugInBg)
throws Exception
ExtendedZOOPSDiffSM that is either an OOPS or a ZOOPS model depending on the chosen type.
type - the type of hidden motifs, either CONTAINS_ALWAYS_A_MOTIF or CONTAINS_SOMETIMES_A_MOTIFlength - the length of the modeled sequences (e.g. 500)starts - the number of recommended startsplugIn - a switch whether to use plug-in or randomly chosen parameter when using DifferentiableSequenceScore.initializeFunction(int, boolean, DataSet[], double[][])bg - the DifferentiableSequenceScore for the overall background (i.e. flanking sequence that does not contain a motif)motif - the DifferentiableSequenceScore for the motifposPrior - the DifferentiableSequenceScore for the positionplugInBg - a switch whether to plug in the (old = last) parameters of the background model, if false the background model is initialized again
Exception - if something went wrong (e.g. the AlphabetContainer is not simple, ...)
public ExtendedZOOPSDiffSM(boolean type,
int length,
int starts,
boolean plugIn,
HomogeneousDiffSM bg,
DifferentiableStatisticalModel[] motif,
DurationDiffSM[] posPrior,
boolean plugInBg)
throws Exception
ExtendedZOOPSDiffSM that allows to have one site of the specified motifs in a Sequence.
type - the type of hidden motifs, either CONTAINS_ALWAYS_A_MOTIF or CONTAINS_SOMETIMES_A_MOTIFlength - the length of the modeled sequences (e.g. 500)starts - the number of recommended startsplugIn - a switch whether to use plug-in or randomly chosen parameter when using DifferentiableSequenceScore.initializeFunction(int, boolean, DataSet[], double[][])bg - the DifferentiableSequenceScore for the overall background (i.e. flanking sequence that does not contain a motif)motif - the DifferentiableSequenceScores for the sequence motifposPrior - the DifferentiableSequenceScores for the position of the the sequence motifsplugInBg - a switch whether to plug in the parameters of the background model in some way, if false the background model is initialized uniformly
Exception - if something went wrong (e.g. the AlphabetContainer is not simple, ...)
public ExtendedZOOPSDiffSM(StringBuffer source)
throws NonParsableException
Storable.
Recreates a new ExtendedZOOPSDiffSM out of a
StringBuffer as returned by AbstractMixtureDiffSM.toXML().
source - the XML representation as StringBuffer
NonParsableException - if the representation could not be parsed| Method Detail |
|---|
public ExtendedZOOPSDiffSM clone()
throws CloneNotSupportedException
DifferentiableSequenceScoreDifferentiableSequenceScore
instance.
clone in interface MotifDiscovererclone in interface DifferentiableSequenceScoreclone in interface SequenceScoreclone in class AbstractMixtureDiffSMDifferentiableSequenceScore
CloneNotSupportedException - if something went wrong while cloning the
DifferentiableSequenceScoreCloneablepublic double getHyperparameterForHiddenParameter(int index)
AbstractMixtureDiffSMindex.
getHyperparameterForHiddenParameter in class AbstractMixtureDiffSMindex - the index of the hidden parameter
protected double getLogNormalizationConstantForComponent(int i)
AbstractMixtureDiffSMi.
getLogNormalizationConstantForComponent in class AbstractMixtureDiffSMi - the index of the component
public double getLogPartialNormalizationConstant(int parameterIndex)
throws Exception
DifferentiableStatisticalModelparameterIndex. This is the logarithm of the partial derivation of the
normalization constant for the parameter with index
parameterIndex,
![\[\log \frac{\partial Z(\underline{\lambda})}{\partial \lambda_{parameterindex}}\]](images/DifferentiableStatisticalModel_LaTeXilb9_1.png)
getLogPartialNormalizationConstant in interface DifferentiableStatisticalModelparameterIndex - the index of the parameter
Exception - if something went wrong with the normalizationDifferentiableStatisticalModel.getLogNormalizationConstant()public double getESS()
DifferentiableStatisticalModel
getESS in interface DifferentiableStatisticalModel
public void initializeFunctionRandomly(boolean freeParams)
throws Exception
DifferentiableSequenceScoreDifferentiableSequenceScore randomly. It has to
create the underlying structure of the DifferentiableSequenceScore.
initializeFunctionRandomly in interface DifferentiableSequenceScoreinitializeFunctionRandomly in class AbstractMixtureDiffSMfreeParams - indicates whether the (reduced) parameterization is used
Exception - if something went wrongpublic String getInstanceName()
SequenceScore
getInstanceName in interface SequenceScore
protected int fillComponentScoreOf(int i,
Sequence seq,
int start)
i - the index of the componentseq - the Sequencestart - the start position
protected void fillComponentScores(Sequence seq,
int start)
AbstractMixtureDiffSMAbstractMixtureDiffSM.componentScore with the logarithmic
scores of the components given a Sequence.
fillComponentScores in class AbstractMixtureDiffSMseq - the sequencestart - the start position in seq
public double getLogScoreFor(Sequence seq,
int start)
SequenceScoreSequence seq
beginning at position start in the Sequence.
getLogScoreFor in interface SequenceScoregetLogScoreFor in class AbstractMixtureDiffSMseq - the Sequencestart - the start position in the Sequence
Sequence
public double getLogScoreAndPartialDerivation(Sequence seq,
int start,
IntList indices,
DoubleList partialDer)
DifferentiableSequenceScoreSequence beginning at
position start in the Sequence and fills lists with
the indices and the partial derivations.
getLogScoreAndPartialDerivation in interface DifferentiableSequenceScoreseq - the Sequencestart - the start position in the Sequenceindices - an IntList of indices, after method invocation the
list should contain the indices i where
is not zeropartialDer - a DoubleList of partial derivations, after method
invocation the list should contain the corresponding
that are not zero
Sequencepublic String toString(NumberFormat nf)
SequenceScoreString representation of the instance.
toString in interface SequenceScorenf - the NumberFormat for the String representation of parameters or probabilities
String representation of the instanceprotected StringBuffer getFurtherInformation()
AbstractMixtureDiffSM
getFurtherInformation in class AbstractMixtureDiffSMStringBufferAbstractMixtureDiffSM.extractFurtherInformation(StringBuffer)
protected void extractFurtherInformation(StringBuffer xml)
throws NonParsableException
AbstractMixtureDiffSMAbstractMixtureDiffSM.getFurtherInformation(). It
extracts further information of the instance from a XML representation.
extractFurtherInformation in class AbstractMixtureDiffSMxml - the StringBuffer containing the information to be
extracted as XML code
NonParsableException - if the StringBuffer could not be parsedAbstractMixtureDiffSM.getFurtherInformation()
public boolean modifyMotif(int motif,
int offsetLeft,
int offsetRight)
throws Exception
MutableMotifDiscoverermotifIndex. The two offsets offsetLeft and offsetRight
define how many positions the left or right border positions shall be moved. Negative numbers indicate moves to the left while positive
numbers correspond to moves to the right. The distribution for sequences to the left and right side of the motif shall be computed internally.
modifyMotif in interface MutableMotifDiscoverermotif - the index of the motif in the motif discovereroffsetLeft - the offset on the left sideoffsetRight - the offset on the right side
true if the motif model was modified otherwise false
Exception - if some unexpected error occurred during the modificationMutableMotifDiscoverer.modifyMotif(int, int, int),
Mutable.modify(int, int)
public void initializeMotif(int motif,
DataSet data,
double[] weights)
throws Exception
MutableMotifDiscoverer
initializeMotif in interface MutableMotifDiscoverermotif - the index of the motif in the motif discovererdata - the data set of sequencesweights - either null or an array of length data.getNumberofElements() with non-negative weights.
Exception - if initialize was not possible
public void initializeMotifRandomly(int motif)
throws Exception
MutableMotifDiscoverermotif randomly using for instance DifferentiableSequenceScore.initializeFunctionRandomly(boolean).
Furthermore, if available, it also initializes the positional distribution.
initializeMotifRandomly in interface MutableMotifDiscoverermotif - the index of the motif
Exception - either if the index is wrong or if it is thrown by the method DifferentiableSequenceScore.initializeFunctionRandomly(boolean)public int getNumberOfMotifs()
MotifDiscovererMotifDiscoverer.
getNumberOfMotifs in interface MotifDiscovererpublic int getNumberOfMotifsInComponent(int component)
MotifDiscoverercomponent of this MotifDiscoverer.
getNumberOfMotifsInComponent in interface MotifDiscoverercomponent - the component of the MotifDiscoverer
public int getIndexOfMaximalComponentFor(Sequence sequence)
MotifDiscoverersequence.
getIndexOfMaximalComponentFor in interface MotifDiscoverersequence - the given sequence
public int getGlobalIndexOfMotifInComponent(int component,
int motif)
MotifDiscoverermotif used in
component. The index returned must be at least 0 and less
than MotifDiscoverer.getNumberOfMotifs().
getGlobalIndexOfMotifInComponent in interface MotifDiscoverercomponent - the component indexmotif - the motif index in the component
motif in component
public double[] getProfileOfScoresFor(int component,
int motif,
Sequence sequence,
int startpos,
MotifDiscoverer.KindOfProfile dist)
throws WrongLengthException
MotifDiscoverercomponent
and motif motif at all possible start positions of the motif
in the sequence sequence beginning at startpos.
This array should be of length sequence.length() - startpos - motifs[motif].getLength() + 1.
getProfileOfScoresFor in interface MotifDiscoverercomponent - the component indexmotif - the index of the motif in the componentsequence - the given sequencestartpos - the start position in the sequencedist - indicates the kind of profile
WrongLengthExceptionpublic int getMotifLength(int motif)
MotifDiscoverermotif
.
getMotifLength in interface MotifDiscoverermotif - the index of the motif
motif
public void adjustHiddenParameters(int classIndex,
DataSet[] data,
double[][] dataWeights)
throws Exception
MutableMotifDiscoverer
adjustHiddenParameters in interface MutableMotifDiscovererclassIndex - the index of the class of this MutableMotifDiscovererdata - the array of data for all classesdataWeights - the weights for all sequences in data
Exception - thrown if the hidden parameters could not be adjusted
protected void initializeUsingPlugIn(int index,
boolean freeParams,
DataSet[] data,
double[][] weights)
throws Exception
AbstractMixtureDiffSM
initializeUsingPlugIn in class AbstractMixtureDiffSMindex - the class indexfreeParams - if true, the (reduced) parameterization is useddata - the dataweights - the weights for the data
- Throws:
Exception - if the initialization could not be done- See Also:
DifferentiableSequenceScore.initializeFunction(int,
boolean, DataSet[], double[][])
public double[] getStrandProbabilitiesFor(int component,
int motif,
Sequence sequence,
int startpos)
throws Exception
MotifDiscoverer
getStrandProbabilitiesFor in interface MotifDiscoverercomponent - the component indexmotif - the index of the motif in the componentsequence - the given sequencestartpos - the start position in the sequence
Exception - if the strand could not be computed for any reasons
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||