|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
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. the equivalent sample size for the class or component that is represented by this model. |
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 sample. |
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()
|
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, 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_MOTIF
length
- 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_MOTIF
length
- 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
s for the sequence motifposPrior
- the DifferentiableSequenceScore
s 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 parsedMethod Detail |
---|
public ExtendedZOOPSDiffSM clone() throws CloneNotSupportedException
DifferentiableSequenceScore
DifferentiableSequenceScore
instance.
clone
in interface MotifDiscoverer
clone
in interface DifferentiableSequenceScore
clone
in interface SequenceScore
clone
in class AbstractMixtureDiffSM
DifferentiableSequenceScore
CloneNotSupportedException
- if something went wrong while cloning the
DifferentiableSequenceScore
Cloneable
public double getHyperparameterForHiddenParameter(int index)
AbstractMixtureDiffSM
index
.
getHyperparameterForHiddenParameter
in class AbstractMixtureDiffSM
index
- the index of the hidden parameter
protected double getLogNormalizationConstantForComponent(int i)
AbstractMixtureDiffSM
i
.
getLogNormalizationConstantForComponent
in class AbstractMixtureDiffSM
i
- the index of the component
public double getLogPartialNormalizationConstant(int parameterIndex) throws Exception
DifferentiableStatisticalModel
parameterIndex
. This is the logarithm of the partial derivation of the
normalization constant for the parameter with index
parameterIndex
,
getLogPartialNormalizationConstant
in interface DifferentiableStatisticalModel
parameterIndex
- 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
DifferentiableSequenceScore
DifferentiableSequenceScore
randomly. It has to
create the underlying structure of the DifferentiableSequenceScore
.
initializeFunctionRandomly
in interface DifferentiableSequenceScore
initializeFunctionRandomly
in class AbstractMixtureDiffSM
freeParams
- 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 Sequence
start
- the start position
protected void fillComponentScores(Sequence seq, int start)
AbstractMixtureDiffSM
AbstractMixtureDiffSM.componentScore
with the logarithmic
scores of the components given a Sequence
.
fillComponentScores
in class AbstractMixtureDiffSM
seq
- the sequencestart
- the start position in seq
public double getLogScoreFor(Sequence seq, int start)
SequenceScore
Sequence
seq
beginning at position start
in the Sequence
.
getLogScoreFor
in interface SequenceScore
getLogScoreFor
in class AbstractMixtureDiffSM
seq
- the Sequence
start
- the start position in the Sequence
Sequence
public double getLogScoreAndPartialDerivation(Sequence seq, int start, IntList indices, DoubleList partialDer)
DifferentiableSequenceScore
Sequence
beginning at
position start
in the Sequence
and fills lists with
the indices and the partial derivations.
getLogScoreAndPartialDerivation
in interface DifferentiableSequenceScore
seq
- the Sequence
start
- the start position in the Sequence
indices
- an IntList
of indices, after method invocation the
list should contain the indices i where
partialDer
- a DoubleList
of partial derivations, after method
invocation the list should contain the corresponding
Sequence
public String toString()
toString
in class Object
protected StringBuffer getFurtherInformation()
AbstractMixtureDiffSM
getFurtherInformation
in class AbstractMixtureDiffSM
StringBuffer
AbstractMixtureDiffSM.extractFurtherInformation(StringBuffer)
protected void extractFurtherInformation(StringBuffer xml) throws NonParsableException
AbstractMixtureDiffSM
AbstractMixtureDiffSM.getFurtherInformation()
. It
extracts further information of the instance from a XML representation.
extractFurtherInformation
in class AbstractMixtureDiffSM
xml
- 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
MutableMotifDiscoverer
motifIndex
. 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 MutableMotifDiscoverer
motif
- 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 MutableMotifDiscoverer
motif
- the index of the motif in the motif discovererdata
- the sample of sequencesweights
- either null
or an array of length data.getNumberofElements()
with non-negative weights.
Exception
- if initialize was not possiblepublic void initializeMotifRandomly(int motif) throws Exception
MutableMotifDiscoverer
motif
randomly using for instance DifferentiableSequenceScore.initializeFunctionRandomly(boolean)
.
Furthermore, if available, it also initializes the positional distribution.
initializeMotifRandomly
in interface MutableMotifDiscoverer
motif
- 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()
MotifDiscoverer
MotifDiscoverer
.
getNumberOfMotifs
in interface MotifDiscoverer
public int getNumberOfMotifsInComponent(int component)
MotifDiscoverer
component
of this MotifDiscoverer
.
getNumberOfMotifsInComponent
in interface MotifDiscoverer
component
- the component of the MotifDiscoverer
public int getIndexOfMaximalComponentFor(Sequence sequence)
MotifDiscoverer
sequence
.
getIndexOfMaximalComponentFor
in interface MotifDiscoverer
sequence
- the given sequence
public int getGlobalIndexOfMotifInComponent(int component, int motif)
MotifDiscoverer
motif
used in
component
. The index returned must be at least 0 and less
than MotifDiscoverer.getNumberOfMotifs()
.
getGlobalIndexOfMotifInComponent
in interface MotifDiscoverer
component
- the component indexmotif
- the motif index in the component
motif in component
getProfileOfScoresFor
public double[] getProfileOfScoresFor(int component,
int motif,
Sequence sequence,
int startpos,
MotifDiscoverer.KindOfProfile dist)
throws WrongLengthException
- Description copied from interface:
MotifDiscoverer
- 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
.
This array should be of length
sequence.length() - startpos - motifs[motif].length() + 1
.
A high score should encode for a probable start position.
- Specified by:
getProfileOfScoresFor
in interface MotifDiscoverer
- Parameters:
component
- 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
- Returns:
- the profile of scores
- Throws:
WrongLengthException
getMotifLength
public int getMotifLength(int motif)
- Description copied from interface:
MotifDiscoverer
- This method returns the length of the motif with index
motif
.
- Specified by:
getMotifLength
in interface MotifDiscoverer
- Parameters:
motif
- the index of the motif
- Returns:
- the length of the motif with index
motif
adjustHiddenParameters
public void adjustHiddenParameters(int classIndex,
DataSet[] data,
double[][] dataWeights)
throws Exception
- Description copied from interface:
MutableMotifDiscoverer
- Adjusts all hidden parameters including duration and mixture parameters according to the current values of the remaining parameters.
- Specified by:
adjustHiddenParameters
in interface MutableMotifDiscoverer
- Parameters:
classIndex
- the index of the class of this MutableMotifDiscoverer
data
- the array of data for all classesdataWeights
- the weights for all sequences in data
- Throws:
Exception
- thrown if the hidden parameters could not be adjusted
initializeUsingPlugIn
protected void initializeUsingPlugIn(int index,
boolean freeParams,
DataSet[] data,
double[][] weights)
throws Exception
- Description copied from class:
AbstractMixtureDiffSM
- This method initializes the functions using the data in some way.
- Specified by:
initializeUsingPlugIn
in class AbstractMixtureDiffSM
- Parameters:
index
- the class indexfreeParams
- if true, the (reduced) parameterization is used
data
- the data
weights
- the weights for the data
Throws:
Exception
- if the initialization could not be done
See Also:
DifferentiableSequenceScore.initializeFunction(int,
boolean, DataSet[], double[][])
getStrandProbabilitiesFor
public double[] getStrandProbabilitiesFor(int component,
int motif,
Sequence sequence,
int startpos)
throws Exception
- Description copied from interface:
MotifDiscoverer
- 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.
- Specified by:
getStrandProbabilitiesFor
in interface MotifDiscoverer
- Parameters:
component
- the component indexmotif
- the index of the motif in the componentsequence
- the given sequencestartpos
- the start position in the sequence
- Returns:
- the probabilities of the strand orientations
- Throws:
Exception
- if the strand could not be computed for any reasons
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD