Search Toolkit Book for CMultiAlignerOptions
Options and parameters for multiple alignement. More...
#include <algo/cobalt/options.hpp>
Options and parameters for multiple alignement.
Definition at line 94 of file options.hpp.
◆ TConstraints ◆ TKMethods ◆ TMode ◆ TScore ◆ EInClustAlnMethod Enumerator eNoneNo clustering.
eToPrototypeAll cluster elements are aligner to cluster prototype.
eMultiAlignment guide tree for each cluster is attached to the main alignment guide tree.
Definition at line 264 of file options.hpp.
◆ EModeMode of multi aligner setings. Values can be combined.
Enumerator fNoQueryClustersNo query clustering.
fNoRpsBlastDo not use RPS Blast.
fNoPatternsDo not use conserved domain patterns.
fNoIterateDo not use Iterative alignment.
fNoRealignDo not realign with different tree root.
fFastAlignDo Fast and rough profile-profile alignment.
fFastSet options for very fast alignment (speed over accuracy)
fNonStandardNot used as input, indicates that.
non-standard settings were selected after
Definition at line 225 of file options.hpp.
◆ ETreeMethodMethod for construction of guide tree for progressive alignment.
Enumerator eNJNeighbot Joining.
eFastMEFast Minimum Evolution.
eClustersClustering dendrogram.
Definition at line 258 of file options.hpp.
◆ CMultiAlignerOptions() [1/4] CMultiAlignerOptions::CMultiAlignerOptions ( void ) ◆ CMultiAlignerOptions() [2/4] CMultiAlignerOptions::CMultiAlignerOptions ( TMode mode ) explicitCreate options with desired mode.
Definition at line 54 of file options.cpp.
References x_InitParams().
◆ CMultiAlignerOptions() [3/4]Create options with RPS database and desired mode.
Definition at line 59 of file options.cpp.
References m_RpsDb, and x_InitParams().
◆ CMultiAlignerOptions() [4/4]Forbidding copy constructor.
◆ CanGetDomainHits() bool CMultiAlignerOptions::CanGetDomainHits ( void ) const inline ◆ GetBlastpEvalue() double CMultiAlignerOptions::GetBlastpEvalue ( void ) const inline ◆ GetCddPatterns() const vector<CPattern>& CMultiAlignerOptions::GetCddPatterns ( void ) const inline ◆ GetCentralSeq() int CMultiAlignerOptions::GetCentralSeq ( void ) const inlineGet central sequence.
This is used for fast alignment of BLAST results. One sequence (typically BLAST query) is made artificially similar to all other sequences to make fast alignment more agreeable with BLAST alignments.
Definition at line 740 of file options.hpp.
Referenced by CMultiAligner::x_FindQueryClusters().
◆ GetConservedCutoffScore() double CMultiAlignerOptions::GetConservedCutoffScore ( void ) const inline ◆ GetDomainHitlistSize() int CMultiAlignerOptions::GetDomainHitlistSize ( void ) const inline ◆ GetDomainHits() CConstRef<objects::CBlast4_archive> CMultiAlignerOptions::GetDomainHits ( void ) const inline ◆ GetDomainResFreqBoost() double CMultiAlignerOptions::GetDomainResFreqBoost ( void ) const inline ◆ GetEndGapExtendPenalty() TScore CMultiAlignerOptions::GetEndGapExtendPenalty ( void ) const inline ◆ GetEndGapOpenPenalty() TScore CMultiAlignerOptions::GetEndGapOpenPenalty ( void ) const inline ◆ GetFastAlign() bool CMultiAlignerOptions::GetFastAlign ( void ) const inline ◆ GetGapExtendPenalty() TScore CMultiAlignerOptions::GetGapExtendPenalty ( void ) const inline ◆ GetGapOpenPenalty() TScore CMultiAlignerOptions::GetGapOpenPenalty ( void ) const inline ◆ GetInClustAlnMethod() ◆ GetIterate() bool CMultiAlignerOptions::GetIterate ( void ) const inline ◆ GetKmerAlphabet() ◆ GetKmerDistMeasure() ◆ GetKmerLength() int CMultiAlignerOptions::GetKmerLength ( void ) const inline ◆ GetLocalResFreqBoost() double CMultiAlignerOptions::GetLocalResFreqBoost ( void ) const inline ◆ GetMaxInClusterDist() double CMultiAlignerOptions::GetMaxInClusterDist ( void ) const inline ◆ GetMessages() const vector<string>& CMultiAlignerOptions::GetMessages ( void ) inline ◆ GetMode() TMode CMultiAlignerOptions::GetMode ( void ) const inline ◆ GetPseudocount() double CMultiAlignerOptions::GetPseudocount ( void ) const inline ◆ GetRealign() bool CMultiAlignerOptions::GetRealign ( void ) const inline ◆ GetRpsDb() string CMultiAlignerOptions::GetRpsDb ( void ) const inline ◆ GetRpsEvalue() double CMultiAlignerOptions::GetRpsEvalue ( void ) const inline ◆ GetScoreMatrixName() string CMultiAlignerOptions::GetScoreMatrixName ( void ) const inline ◆ GetTreeMethod() ETreeMethod CMultiAlignerOptions::GetTreeMethod ( void ) const inline ◆ GetUsePreRpsHits() bool CMultiAlignerOptions::GetUsePreRpsHits ( void ) const inlineGet use of precomputed RPS Blast hits.
Definition at line 526 of file options.hpp.
◆ GetUseQueryClusters() bool CMultiAlignerOptions::GetUseQueryClusters ( void ) const inline ◆ GetUserConstraints() ◆ GetUserConstraintsScore() int CMultiAlignerOptions::GetUserConstraintsScore ( void ) const inline ◆ GetUseRpsBlast() bool CMultiAlignerOptions::GetUseRpsBlast ( void ) const inlineDetermine if RPS Blast is to be used.
Definition at line 368 of file options.hpp.
◆ GetVerbose() bool CMultiAlignerOptions::GetVerbose ( void ) const inlineGet verbose mode.
If set, intermidiate results will be provided in stdout
Definition at line 691 of file options.hpp.
Referenced by CMultiAligner::x_AlignInClusters(), CMultiAligner::x_AlignProfileProfile(), CMultiAligner::x_AlignProfileProfileUsingHit(), CMultiAligner::x_BuildAlignment(), CMultiAligner::x_BuildAlignmentIterative(), CMultiAligner::x_BuildFullTree(), CMultiAligner::x_ComputeClusterTrees(), CMultiAligner::x_ComputeTree(), CMultiAligner::x_FindConservedColumns(), CMultiAligner::x_FindConsistentHitSubset(), CMultiAligner::x_FindConstraints(), CMultiAligner::x_FindDomainHits(), CMultiAligner::x_FindInClusterConstraints(), CMultiAligner::x_FindLocalHits(), CMultiAligner::x_FindLocalInClusterHits(), CMultiAligner::x_FindPatternHits(), CMultiAligner::x_FindQueryClusters(), CMultiAligner::x_FindRPSHits(), CMultiAligner::x_MakeFillerBlocks(), CMultiAligner::x_MultiAlignClusters(), CMultiAligner::x_RealignBlocks(), CMultiAligner::x_RealignSequences(), and CMultiAligner::x_SetDomainHits().
◆ IsStandardMode() bool CMultiAlignerOptions::IsStandardMode ( void ) const inlineCheck whether parameter values belong to any of the standard modes.
The mode is standard when parameters are not changed after the options object is created, with exception of RPS database name.
Definition at line 676 of file options.hpp.
Referenced by BOOST_AUTO_TEST_CASE().
◆ operator=()Forbidding assignment operator.
◆ SetBlastpEvalue() void CMultiAlignerOptions::SetBlastpEvalue ( double evalue ) inline ◆ SetCddPatterns() vector<CPattern>& CMultiAlignerOptions::SetCddPatterns ( void ) inlineSet regular expression patterns for identification of conserved domains.
Patterns are not freed when object is deleted.
Regular expresion patterns will be used to find conserved domains. Pairwise alignmnents will be constained to so that matching conserved domains are aligned. Parameter ownership is transfered to options.
Definition at line 379 of file options.hpp.
Referenced by BOOST_AUTO_TEST_CASE(), and CMultiApplication::Run().
◆ SetCentralSeq() void CMultiAlignerOptions::SetCentralSeq ( int c ) inlineSet central sequence.
This is used for fast alignment of BLAST results. One sequence (typically BLAST query) is made artificially similar to all other sequences to make fast alignment more agreeable with BLAST alignments.
Definition at line 749 of file options.hpp.
◆ SetConservedCutoffScore() void CMultiAlignerOptions::SetConservedCutoffScore ( double score ) inline ◆ SetDefaultCddPatterns() void CMultiAlignerOptions::SetDefaultCddPatterns ( void )Set default patterns for identification of conserved domains.
Regular expresion patterns will be used to find conserved domains. Pairwise alignmnents will be constained to so that matching conserved domains are aligned. Parameter ownership is transfered to options.
Definition at line 67 of file options.cpp.
References AssignDefaultPatterns(), fNonStandard, m_Mode, and m_Patterns.
◆ SetDomainHitlistSize() void CMultiAlignerOptions::SetDomainHitlistSize ( int size ) inline ◆ SetDomainHits() void CMultiAlignerOptions::SetDomainHits ( CConstRef< objects::CBlast4_archive > archive ) inline ◆ SetDomainResFreqBoost() void CMultiAlignerOptions::SetDomainResFreqBoost ( double boost ) inlineSet boost for residue frequencies in conserved domains from RPS data base.
Definition at line 507 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetEndGapExtendPenalty() void CMultiAlignerOptions::SetEndGapExtendPenalty ( TScore penalty ) inlineSet gap extension penalty for end gaps in pairwise global alignment of profiles.
Definition at line 651 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetEndGapOpenPenalty() void CMultiAlignerOptions::SetEndGapOpenPenalty ( TScore penalty ) inlineSet gap opening penalty for end gaps in pairwise global alignment of profiles.
Definition at line 638 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetFastAlign() void CMultiAlignerOptions::SetFastAlign ( bool f ) inlineTurn fast alignment method on/off.
Fast alignment means that constraints will be used instead of profile- profile alignment
Definition at line 731 of file options.hpp.
References f.
◆ SetGapExtendPenalty() void CMultiAlignerOptions::SetGapExtendPenalty ( TScore penalty ) inlineSet gap extension penalty for middle gaps in pairwise global alignment of profiles.
Definition at line 625 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetGapOpenPenalty() void CMultiAlignerOptions::SetGapOpenPenalty ( TScore penalty ) inlineSet gap opening penalty for middle gaps in pairwise global alignment of profiles.
Definition at line 612 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetInClustAlnMethod() ◆ SetIterate() void CMultiAlignerOptions::SetIterate ( bool use ) inlineSet use of iterative alignment option.
After initial multiple alignment is done, conserved columns will be found and sequences will be re-aligned using this information. Default parameters will be used. Iterative alignment parameters can be changed with expert functions.
Definition at line 322 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetKmerAlphabet() ◆ SetKmerDistMeasure()Set measure for computing distance between word count vectors.
Definition at line 456 of file options.hpp.
◆ SetKmerLength() void CMultiAlignerOptions::SetKmerLength ( int len ) inline ◆ SetLocalResFreqBoost() void CMultiAlignerOptions::SetLocalResFreqBoost ( double boost ) inlineSet frequency boost for a letter that appears in query sequence in given position.
Definition at line 585 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetMaxInClusterDist() void CMultiAlignerOptions::SetMaxInClusterDist ( double dist ) inlineSet maximum allowed distance between sequences in a cluster.
Definition at line 470 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetPseudocount() void CMultiAlignerOptions::SetPseudocount ( double pseudocount ) inline ◆ SetRealign() void CMultiAlignerOptions::SetRealign ( bool r ) inlineSet realigning MSA with different root nodes in the progressive alignment tree.
Definition at line 329 of file options.hpp.
References r().
◆ SetRpsDb() void CMultiAlignerOptions::SetRpsDb ( const string & dbname ) inline ◆ SetRpsEvalue() void CMultiAlignerOptions::SetRpsEvalue ( double evalue ) inline ◆ SetScoreMatrixName() void CMultiAlignerOptions::SetScoreMatrixName ( const string & matrix ) inline ◆ SetTreeMethod() void CMultiAlignerOptions::SetTreeMethod ( ETreeMethod method ) inlineSet method for creating tree that guides progressive alignment.
Definition at line 573 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ SetUsePreRpsHits() void CMultiAlignerOptions::SetUsePreRpsHits ( bool use ) inlineSet use of precomputed RPS Blast hits.
Definition at line 518 of file options.hpp.
◆ SetUseQueryClusters() void CMultiAlignerOptions::SetUseQueryClusters ( bool use )Set use of query clustering option.
If the option in set on, query sequences will be clustered. Each cluster Will be aligned independently without searching for conserved domains (RPS Blast) and local hist (Blastp). Multiple alignment will be performed on cluster profiles. Parameters of clustering procedure are set based on EMode value and can be chanded with expert functions.
Definition at line 75 of file options.cpp.
References eMulti, fNonStandard, m_InClustAlnMethod, m_Mode, and m_UseQueryClusters.
Referenced by BOOST_AUTO_TEST_CASE(), and CMultiApplication::Run().
◆ SetUserConstraints() TConstraints& CMultiAlignerOptions::SetUserConstraints ( void ) inline ◆ SetUserConstraintsScore() void CMultiAlignerOptions::SetUserConstraintsScore ( int score ) inlineSet score for user alignment constraints.
Definition at line 417 of file options.hpp.
◆ SetVerbose() void CMultiAlignerOptions::SetVerbose ( bool verbose ) inlineSet verbose mode.
If set, intermidiate results will be provided in stdout
Definition at line 683 of file options.hpp.
Referenced by CMultiApplication::Run().
◆ Validate() bool CMultiAlignerOptions::Validate ( void )Validate parameter values.
Definition at line 86 of file options.cpp.
References CanGetDomainHits(), eClusters, eFastME, TKmerMethods< TKmerCounts >::eFractionCommonKmersGlobal, TKmerMethods< TKmerCounts >::eFractionCommonKmersLocal, TKmerMethods< TKmerCounts >::eLastAlphabet, eNJ, eNone, fNoIterate, fNonStandard, fNoPatterns, fNoQueryClusters, fNoRpsBlast, ITERATE, m_BlastpEvalue, m_ClustDistMeasure, m_DomainHitlistSize, m_InClustAlnMethod, m_KmerAlphabet, m_KmerLength, m_Messages, m_Mode, m_Patterns, m_Pseudocount, m_RpsDb, m_RpsEvalue, m_TreeMethod, m_UseQueryClusters, m_UserHits, and NCBI_THROW.
Referenced by BOOST_AUTO_TEST_CASE(), and CMultiApplication::Run().
◆ x_InitParams() void CMultiAlignerOptions::x_InitParams ( TMode mode ) privateInitiate parameter values based on the specified mode.
Definition at line 215 of file options.cpp.
References AssignDefaultPatterns(), COBALT_BLAST_EVALUE, COBALT_CONSERVED_CUTOFF, COBALT_DEFAULT_MATRIX, COBALT_DOMAIN_BOOST, COBALT_DOMAIN_HITLIST_SIZE, COBALT_END_GAP_EXTNT, COBALT_END_GAP_OPEN, COBALT_GAP_EXTNT, COBALT_GAP_OPEN, COBALT_KMER_ALPH, COBALT_KMER_LEN, COBALT_LOCAL_BOOST, COBALT_MAX_CLUSTER_DIAM, COBALT_PSEUDO_COUNT, COBALT_RPS_EVALUE, COBALT_TREE_METHOD, TKmerMethods< TKmerCounts >::eFractionCommonKmersGlobal, eMulti, eNone, fFastAlign, fNoIterate, fNonStandard, fNoPatterns, fNoQueryClusters, fNoRealign, kDefaultUserConstraintsScore, m_BlastpEvalue, m_CentralSeq, m_ClustDistMeasure, m_ConservedCutoff, m_DomainHitlistSize, m_DomainResFreqBoost, m_EndGapExtend, m_EndGapOpen, m_FastAlign, m_GapExtend, m_GapOpen, m_InClustAlnMethod, m_Iterate, m_KmerAlphabet, m_KmerLength, m_LocalResFreqBoost, m_MatrixName, m_MaxInClusterDist, m_Mode, m_Patterns, m_Pseudocount, m_Realign, m_RpsEvalue, m_TreeMethod, m_UsePreRpsHits, m_UseQueryClusters, m_UserHitsScore, m_Verbose, and NCBI_THROW.
Referenced by CMultiAlignerOptions().
◆ kDefaultMode const TMode CMultiAlignerOptions::kDefaultMode = 0 static ◆ kDefaultUserConstraintsScore const int CMultiAlignerOptions::kDefaultUserConstraintsScore = 1000000 staticprivate ◆ m_BlastpEvalue double CMultiAlignerOptions::m_BlastpEvalue private ◆ m_CentralSeq int CMultiAlignerOptions::m_CentralSeq private ◆ m_ClustDistMeasure ◆ m_ConservedCutoff double CMultiAlignerOptions::m_ConservedCutoff private ◆ m_DomainHitlistSize int CMultiAlignerOptions::m_DomainHitlistSize private ◆ m_DomainHits CConstRef<objects::CBlast4_archive> CMultiAlignerOptions::m_DomainHits privateDefinition at line 831 of file options.hpp.
◆ m_DomainResFreqBoost double CMultiAlignerOptions::m_DomainResFreqBoost private ◆ m_EndGapExtend TScore CMultiAlignerOptions::m_EndGapExtend private ◆ m_EndGapOpen TScore CMultiAlignerOptions::m_EndGapOpen private ◆ m_FastAlign bool CMultiAlignerOptions::m_FastAlign private ◆ m_GapExtend TScore CMultiAlignerOptions::m_GapExtend private ◆ m_GapOpen TScore CMultiAlignerOptions::m_GapOpen private ◆ m_InClustAlnMethod ◆ m_Iterate bool CMultiAlignerOptions::m_Iterate private ◆ m_KmerAlphabet ◆ m_KmerLength unsigned int CMultiAlignerOptions::m_KmerLength private ◆ m_LocalResFreqBoost double CMultiAlignerOptions::m_LocalResFreqBoost private ◆ m_MatrixName string CMultiAlignerOptions::m_MatrixName private ◆ m_MaxInClusterDist double CMultiAlignerOptions::m_MaxInClusterDist private ◆ m_Messages vector<string> CMultiAlignerOptions::m_Messages private ◆ m_Mode TMode CMultiAlignerOptions::m_Mode private ◆ m_Patterns vector<CPattern> CMultiAlignerOptions::m_Patterns private ◆ m_Pseudocount double CMultiAlignerOptions::m_Pseudocount private ◆ m_Realign bool CMultiAlignerOptions::m_Realign private ◆ m_RpsDb string CMultiAlignerOptions::m_RpsDb private ◆ m_RpsEvalue double CMultiAlignerOptions::m_RpsEvalue private ◆ m_TreeMethod ◆ m_UsePreRpsHits bool CMultiAlignerOptions::m_UsePreRpsHits private ◆ m_UseQueryClusters bool CMultiAlignerOptions::m_UseQueryClusters private ◆ m_UserHits ◆ m_UserHitsScore int CMultiAlignerOptions::m_UserHitsScore private ◆ m_Verbose bool CMultiAlignerOptions::m_Verbose privateThe documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4