#include <showdefline.hpp>
Inheritance diagram for CShowBlastDefline:


Example:
int defline_option = 0; defline_option += CShowBlastDefline::eShowGi; defline_option += CShowBlastDefline::eHtml; ....... CShowBlastDefline sbd(aln_set, scope); sbd.SetRid(rid); sbd.SetOption(defline_option); sbd.DisplayBlastDefline(out);
Definition at line 65 of file showdefline.hpp.
Public Types | |
| typedef map< string, PsiblastSeqStatus > | TIdString2SeqStatus |
| Map of sequence IDs to PSI-BLAST sequence status. | |
| enum | DisplayOption { eHtml = (1 << 0), eLinkout = (1 << 1), eShowGi = (1 << 2), eCheckbox = (1 << 3), eShowSumN = (1 << 4), eCheckboxChecked = (1 << 5), eNoShowHeader = (1 << 6), eNewTargetWindow = (1 << 7), eShowNewSeqGif = (1 << 8), eShowPercentIdent = (1 << 9) } |
| Display options. More... | |
| enum | PsiblastSeqStatus { eUnknown = (0 << 0), eGoodSeq = (1 << 0), eCheckedSeq = (1 << 1), eRepeatSeq = (1 << 2) } |
| PSI-BLAST sequence status (applicable in HTML only). More... | |
| enum | PsiblastStatus { eFirstPass = 0, eRepeatPass, eNewPass } |
| PSI-BLAST defline groupings. More... | |
Public Member Functions | |
| CShowBlastDefline (const objects::CSeq_align_set &seqalign, objects::CScope &scope, size_t line_length=65, size_t deflines_to_show=kDfltArgNumDescriptions, bool translated_nuc_alignment=false, CRange< TSeqPos > *master_range=NULL) | |
| Constructors. | |
| ~CShowBlastDefline () | |
| void | SetOption (int option) |
| options per DisplayOption | |
| void | SetupPsiblast (TIdString2SeqStatus *seq_status=NULL, PsiblastStatus status=eFirstPass) |
| Set psiblast specific options. | |
| void | SetImagePath (string path) |
| Set path to html images. | |
| void | SetQueryNumber (int number) |
| Set this for linking to mapviewer. | |
| void | SetNumAlignToShow (int num) |
| Display top num seqalign. | |
| void | SetEntrezTerm (string term) |
| Set this for constructing structure linkout. | |
| void | SetRid (string rid) |
| Set blast request id. | |
| void | SetCddRid (string cdd_rid) |
| Set this for constructing structure linkout. | |
| void | SetDbType (bool is_na) |
| Set this for constructing seqid url. | |
| void | SetDbName (string database) |
| Set this for constructing seqid url. | |
| void | SetBlastType (string type) |
| Set this for proper construction of seqid url. | |
| void | SetCgiContext (CCgiContext &ctx) |
| void | DisplayBlastDefline (CNcbiOstream &out) |
| Display defline. | |
| void | DisplayBlastDeflineTable (CNcbiOstream &out) |
| void | Init (void) |
| Initialize defline params. | |
| void | Display (CNcbiOstream &out) |
| Display defline. | |
| bool | HasStructureLinkout (void) |
| Indicates if 'Related structures' link should show. | |
| vector< CShowBlastDefline::SDeflineInfo * > | GetDeflineInfo (vector< CConstRef< objects::CSeq_id > > &seqIds) |
| Get defline info for the set of seqIds. | |
Static Public Member Functions | |
| static string | GetSeqIdListString (const list< CRef< objects::CSeq_id > > &id, bool show_gi) |
| Creates a '|' delimited string, corresponding to a list of Seq-ids. | |
| static void | GetSeqIdList (const objects::CBioseq_Handle &bh, list< CRef< objects::CSeq_id > > &ids) |
| Converts a Bioseq handle's sequence id type into a list of objects::CSeq_id references, substituting an artificial gnl|BL_ORD_ID identifier by a corresponding first token of the title. | |
| static void | GetBioseqHandleDeflineAndId (const objects::CBioseq_Handle &handle, list< int > &use_this_gi, string &seqid, string &defline, bool show_gi=true, int this_gi_first=-1) |
| Returns sequence id and a BLAST defline as strings, given a Bioseq handle and a list of gis. | |
Protected Member Functions | |
| SScoreInfo * | x_GetScoreInfo (const objects::CSeq_align &aln, int blast_rank) |
| Internal function to return score info. | |
| SScoreInfo * | x_GetScoreInfoForTable (const objects::CSeq_align_set &aln, int blast_rank) |
| Internal function to return score info. | |
| SDeflineInfo * | x_GetDeflineInfo (CConstRef< objects::CSeq_id > id, list< int > &use_this_gi, int blast_rank) |
| Internal function to return defline info. | |
| SDeflineInfo * | x_GetHitDeflineInfo (const objects::CSeq_align_set &aln) |
| Internal function to return defline info. | |
| bool | x_CheckForStructureLink () |
| Checks the first X deflines (currently X is 200) for a structure link. | |
| void | x_FillDeflineAndId (const objects::CBioseq_Handle &handle, const objects::CSeq_id &aln_id, list< int > &use_this_gi, SDeflineInfo *sdl, int blast_rank) |
| Internal function to fill defline info. | |
| void | x_InitDefline (void) |
| Initialize defline params for regular output. | |
| void | x_InitDeflineTable (void) |
| Initialize defline params for table output. | |
| void | x_DisplayDefline (CNcbiOstream &out) |
| Display defline for regular output. | |
| void | x_DisplayDeflineTable (CNcbiOstream &out) |
| Display defline for table output. | |
Protected Attributes | |
| CConstRef< objects::CSeq_align_set > | m_AlnSetRef |
| Seqalign. | |
| string | m_Database |
| Database name. | |
| CRef< objects::CScope > | m_ScopeRef |
| Scope to fetch sequence. | |
| size_t | m_LineLen |
| Line length. | |
| size_t | m_NumToShow |
| Number of seqalign hits to show. | |
| int | m_Option |
| Display options. | |
| list< SScoreInfo * > | m_ScoreList |
| List containing score info for all seqalign. | |
| string | m_BlastType |
| Blast type. | |
| string | m_ImagePath |
| Gif images path. | |
| auto_ptr< CNcbiIfstream > | m_ConfigFile |
| Internal configure file, i.e. .ncbirc. | |
| auto_ptr< CNcbiRegistry > | m_Reg |
| int | m_QueryNumber |
| query number | |
| string | m_EntrezTerm |
| entrez term | |
| string | m_Rid |
| blast request id | |
| string | m_CddRid |
| cdd blast request id | |
| bool | m_IsDbNa |
| PsiblastStatus | m_PsiblastStatus |
| TIdString2SeqStatus * | m_SeqStatus |
| hash table to track psiblast status for each sequence | |
| bool | m_TranslatedNucAlignment |
| used to calculate the alignment length | |
| size_t | m_MaxScoreLen |
| Score header size. | |
| size_t | m_MaxEvalueLen |
| Eval header size. | |
| size_t | m_MaxSumNLen |
| size_t | m_MaxTotalScoreLen |
| Total score header size. | |
| size_t | m_MaxPercentIdentityLen |
| size_t | m_MaxQueryCoverLen |
| int | m_QueryLength |
| bool | m_StructureLinkout |
| Indicates if 'Related structures' link should show. | |
| CRange< TSeqPos > * | m_MasterRange |
| blast sub-sequnce query | |
| CCgiContext * | m_Ctx |
Friends | |
| struct | ::CShowBlastDeflineTest |
Classes | |
| struct | SDeflineInfo |
| Data Representing each defline. More... | |
| struct | SScoreInfo |
| Internal data with score information for each defline. More... | |
|
|
Map of sequence IDs to PSI-BLAST sequence status.
Definition at line 134 of file showdefline.hpp. |
|
|
Display options.
Definition at line 85 of file showdefline.hpp. |
|
|
PSI-BLAST sequence status (applicable in HTML only).
Definition at line 119 of file showdefline.hpp. |
|
|
PSI-BLAST defline groupings.
Definition at line 127 of file showdefline.hpp. |
|
||||||||||||||||||||||||||||
|
Constructors.
|
|
|
Definition at line 563 of file showdefline.cpp. References ITERATE, and m_ScoreList. |
|
|
Display defline.
Definition at line 585 of file showdefline.cpp. References CCgiContext::GetRequestValue(), CCgiEntry::GetValue(), kEmptyStr, m_Ctx, NStr::ToLower(), x_DisplayDefline(), and x_DisplayDeflineTable(). |
|
|
Display defline.
Definition at line 869 of file showdefline.cpp. References buf, kStructure_Overview, m_CddRid, m_EntrezTerm, m_Rid, m_StructureLinkout, NcbiEmptyString, x_DisplayDefline(), and x_InitDefline(). Referenced by CBlastFormat::x_DisplayDeflines(). |
|
|
Definition at line 1377 of file showdefline.cpp. References buf, kStructure_Overview, m_CddRid, m_EntrezTerm, m_Rid, m_StructureLinkout, NcbiEmptyString, x_DisplayDeflineTable(), and x_InitDeflineTable(). |
|
||||||||||||||||||||||||||||
|
Returns sequence id and a BLAST defline as strings, given a Bioseq handle and a list of gis. to use. Does not need an object.
Referenced by s_SeqAlignToXMLHit(). |
|
|
Get defline info for the set of seqIds.
|
|
||||||||||||
|
Converts a Bioseq handle's sequence id type into a list of objects::CSeq_id references, substituting an artificial gnl|BL_ORD_ID identifier by a corresponding first token of the title.
Definition at line 245 of file showdefline.cpp. References GetTitle(), ITERATE, NcbiEmptyString, and NStr::Tokenize(). |
|
||||||||||||
|
Creates a '|' delimited string, corresponding to a list of Seq-ids.
Definition at line 223 of file showdefline.cpp. References CSeq_id::eContent, ITERATE, and NcbiEmptyString. Referenced by s_GetSeqIdListString(). |
|
|
Indicates if 'Related structures' link should show.
Definition at line 262 of file showdefline.hpp. |
|
|
Initialize defline params.
Definition at line 571 of file showdefline.cpp. References CCgiContext::GetRequestValue(), CCgiEntry::GetValue(), kEmptyStr, m_Ctx, NStr::ToLower(), x_InitDefline(), and x_InitDeflineTable(). |
|
|
Set this for proper construction of seqid url.
Definition at line 204 of file showdefline.hpp. |
|
|
Set this for constructing structure linkout.
Definition at line 183 of file showdefline.hpp. |
|
|
Definition at line 208 of file showdefline.hpp. |
|
|
Set this for constructing seqid url.
Definition at line 197 of file showdefline.hpp. |
|
|
Set this for constructing seqid url.
Definition at line 190 of file showdefline.hpp. |
|
|
Set this for constructing structure linkout.
Definition at line 169 of file showdefline.hpp. |
|
|
Set path to html images.
Definition at line 150 of file showdefline.hpp. |
|
|
Display top num seqalign.
Definition at line 162 of file showdefline.hpp. |
|
|
options per DisplayOption
Definition at line 114 of file showdefline.hpp. Referenced by CShowBlastDeflineTest::GetDeflineInfo(). |
|
|
Set this for linking to mapviewer.
Definition at line 156 of file showdefline.hpp. |
|
|
Set blast request id.
Definition at line 176 of file showdefline.hpp. |
|
||||||||||||
|
Set psiblast specific options.
Definition at line 140 of file showdefline.hpp. Referenced by CBlastFormat::x_DisplayDeflines(). |
|
|
Checks the first X deflines (currently X is 200) for a structure link. If one is not found there it is assumed one is not in the results. If one is found we exit right away. We do this so we can fetch most of the Bioseqs for large results as we format.
Definition at line 598 of file showdefline.cpp. References eStructure, CAlignFormatUtil::GetBlastDefline(), ITERATE, m_ScopeRef, and m_ScoreList. |
|
|
|
||||||||||||||||||||||||
|
Internal function to fill defline info.
|
|
||||||||||||||||
|
Internal function to return defline info.
Referenced by CShowBlastDeflineTest::GetDeflineInfo(), x_DisplayDefline(), and x_DisplayDeflineTable(). |
|
|
Internal function to return defline info.
|
|
||||||||||||
|
Internal function to return score info.
Referenced by CShowBlastDeflineTest::GetDeflineInfo(), and x_InitDefline(). |
|
||||||||||||
|
Internal function to return score info.
Referenced by x_InitDeflineTable(). |
|
|
Initialize defline params for regular output.
Definition at line 633 of file showdefline.cpp. References _ASSERT, CShowBlastDefline::SScoreInfo::evalue_string, CBioseq_Handle::GetBioseqCore(), NStr::IntToString(), kBits, kValue, m_AlnSetRef, m_ConfigFile, m_MaxEvalueLen, m_MaxScoreLen, m_MaxSumNLen, m_NumToShow, m_Option, m_Reg, m_ScopeRef, m_ScoreList, auto_ptr< X >::reset(), and x_GetScoreInfo(). Referenced by DisplayBlastDefline(), and Init(). |
|
|
Initialize defline params for table output.
Definition at line 920 of file showdefline.cpp. References COpenRange< Position >::GetLength(), NStr::IntToString(), kCoverage, kIdentity, kMaxScore, kTotal, kValue, m_AlnSetRef, m_ConfigFile, m_MasterRange, m_MaxEvalueLen, m_MaxPercentIdentityLen, m_MaxQueryCoverLen, m_MaxScoreLen, m_MaxSumNLen, m_MaxTotalScoreLen, m_NumToShow, m_Option, m_QueryLength, m_Reg, m_ScopeRef, m_ScoreList, auto_ptr< X >::reset(), size, CShowBlastDefline::SScoreInfo::total_bit_string, and x_GetScoreInfoForTable(). Referenced by DisplayBlastDeflineTable(), and Init(). |
|
|
Definition at line 416 of file showdefline.hpp. |
|
|
Seqalign.
Definition at line 287 of file showdefline.hpp. Referenced by x_DisplayDefline(), x_DisplayDeflineTable(), x_InitDefline(), and x_InitDeflineTable(). |
|
|
Blast type.
Definition at line 308 of file showdefline.hpp. |
|
|
cdd blast request id
Definition at line 327 of file showdefline.hpp. Referenced by DisplayBlastDefline(), and DisplayBlastDeflineTable(). |
|
|
Internal configure file, i.e. .ncbirc.
Definition at line 314 of file showdefline.hpp. Referenced by x_InitDefline(), and x_InitDeflineTable(). |
|
|
Definition at line 357 of file showdefline.hpp. Referenced by Display(), Init(), and x_DisplayDeflineTable(). |
|
|
Database name.
Definition at line 290 of file showdefline.hpp. |
|
|
entrez term
Definition at line 321 of file showdefline.hpp. Referenced by DisplayBlastDefline(), and DisplayBlastDeflineTable(). |
|
|
Gif images path.
Definition at line 311 of file showdefline.hpp. |
|
|
Definition at line 329 of file showdefline.hpp. Referenced by x_DisplayDeflineTable(). |
|
|
Line length.
Definition at line 296 of file showdefline.hpp. Referenced by x_DisplayDefline(). |
|
|
blast sub-sequnce query
Definition at line 355 of file showdefline.hpp. Referenced by x_InitDeflineTable(). |
|
|
Eval header size.
Definition at line 341 of file showdefline.hpp. Referenced by x_DisplayDefline(), x_DisplayDeflineTable(), x_InitDefline(), and x_InitDeflineTable(). |
|
|
Definition at line 346 of file showdefline.hpp. Referenced by x_DisplayDeflineTable(), and x_InitDeflineTable(). |
|
|
Definition at line 348 of file showdefline.hpp. Referenced by x_DisplayDeflineTable(), and x_InitDeflineTable(). |
|
|
Score header size.
Definition at line 339 of file showdefline.hpp. Referenced by x_DisplayDefline(), x_DisplayDeflineTable(), x_InitDefline(), and x_InitDeflineTable(). |
|
|
Definition at line 342 of file showdefline.hpp. Referenced by x_DisplayDeflineTable(), x_InitDefline(), and x_InitDeflineTable(). |
|
|
Total score header size.
Definition at line 344 of file showdefline.hpp. Referenced by x_DisplayDeflineTable(), and x_InitDeflineTable(). |
|
|
Number of seqalign hits to show.
Definition at line 299 of file showdefline.hpp. Referenced by x_InitDefline(), and x_InitDeflineTable(). |
|
|
Display options.
Definition at line 302 of file showdefline.hpp. Referenced by x_DisplayDefline(), x_DisplayDeflineTable(), x_InitDefline(), and x_InitDeflineTable(). |
|
|
Definition at line 330 of file showdefline.hpp. Referenced by x_DisplayDefline(), and x_DisplayDeflineTable(). |
|
|
Definition at line 350 of file showdefline.hpp. Referenced by x_DisplayDeflineTable(), and x_InitDeflineTable(). |
|
|
query number
Definition at line 318 of file showdefline.hpp. |
|
|
Definition at line 315 of file showdefline.hpp. Referenced by x_InitDefline(), and x_InitDeflineTable(). |
|
|
blast request id
Definition at line 324 of file showdefline.hpp. Referenced by DisplayBlastDefline(), and DisplayBlastDeflineTable(). |
|
|
Scope to fetch sequence.
Definition at line 293 of file showdefline.hpp. Referenced by x_CheckForStructureLink(), x_DisplayDeflineTable(), x_InitDefline(), and x_InitDeflineTable(). |
|
|
List containing score info for all seqalign.
Definition at line 305 of file showdefline.hpp. Referenced by x_CheckForStructureLink(), x_DisplayDefline(), x_DisplayDeflineTable(), x_InitDefline(), x_InitDeflineTable(), and ~CShowBlastDefline(). |
|
|
hash table to track psiblast status for each sequence
Definition at line 333 of file showdefline.hpp. |
|
|
Indicates if 'Related structures' link should show.
Definition at line 352 of file showdefline.hpp. Referenced by DisplayBlastDefline(), and DisplayBlastDeflineTable(). |
|
|
used to calculate the alignment length
Definition at line 336 of file showdefline.hpp. |
1.4.6
Modified on Wed Dec 09 08:19:58 2009 by modify_doxy.py rev. 173732