Home > src > initVerbosePrint.m

# initVerbosePrint

## PURPOSE

- initializes the flags which control the verbosity of output

## SYNOPSIS

function initVerbosePrint()

## DESCRIPTION

     - initializes the flags which control the verbosity of output

     copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut

        This file is part of SOS

        SOS is free software: you can redistribute it and/or modify
        it for academic and non-commercial purposes
        under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.  For commercial or for-profit
        uses, please contact the authors (sos@cnbc.cmu.edu).

        SOS is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

## CROSS-REFERENCE INFORMATION

This function calls:

This function is called by:

- setVerbosePrintVerbosity - function for setting the verbosity of the SOS software cmd line output
- verbosePrint - master print function that regulates cmd line output based on verbosity flags

## SOURCE CODE

    0001 % - initializes the flags which control the verbosity of output
    0002 %
    0003 % copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut
    0004 %
    0005 %    This file is part of SOS
    0006 %
    0007 %    SOS is free software: you can redistribute it and/or modify
    0008 %    it for academic and non-commercial purposes
    0009 %    under the terms of the GNU General Public License as published by
    0010 %    the Free Software Foundation, either version 3 of the License, or
    0011 %    (at your option) any later version.  For commercial or for-profit
    0012 %    uses, please contact the authors (sos@cnbc.cmu.edu).
    0013 %
    0014 %    SOS is distributed in the hope that it will be useful,
    0015 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
    0016 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    0017 %    GNU General Public License for more details.
    0018
    0019 %    You should have received a copy of the GNU General Public License
    0020 %    along with SOS (see COPYING.txt).
    0021 %    If not, see <http://www.gnu.org/licenses/>.
    0022
    0023
    0024
    0025 function  initVerbosePrint()
    0026     %% initializes the verbose printing parameters
    0027     % the idea is that different verbosity flags could allow for different
    0028     % styles of output, though currently flags are always ==1 and this
    0029     % outputs to stdout
    0030     %
    0031     % each parameter indicates a specific print function, so it is possible
    0032     % to suppress or activate individual messages to create a custom level
    0033     % of verbosity.
    0034
    0035     global verbosityFlags;
    0036
    0037     if(isempty(verbosityFlags))
    0038         verbosityFlags = struct( ...
    0039             'setSeed_set',1,...
    0040             'population_constructor_startObjCreation',1, ...
    0041             'population_constructor_fileExists',1,...
    0042             'population_constructor_endObjCreation',1, ...
    0043         ...
    0044             'sample_constructor_startObjCreation',1, ...
    0045             'sample_constructor_fileExists',1,...
    0046             'sample_constructor_endObjCreation', 1, ...
    0047             'sample_setPop_end',1,...
    0048             'sample_lockAll_end',1,...
    0049             'sample_unlockAll_end',1,...
    0050         ...
    0051             'dataFrame_readDataFrameData_reading',1, ...
    0052             'dataFrame_readDataFrameData_HeaderPresent',1, ...
    0053             'dataFrame_readDataFrameData_FormattingPresent',1, ...
    0054             'dataFrame_readDataFrameData_DoneReadingData',1, ...
    0055             'dataFrame_readDataFrameData_HeaderAbsent',1, ...
    0056             'dataFrame_readDataFrameData_FormattingAbsent',1, ...
    0057             'dataFrame_writeData_done',1,...
    0058             'dataFrame_overlap_percent',1,...
    0059         ...
    0060             'sos_constructor_startObjCreation',1, ...
    0061             'sos_constructor_endObjCreation', 1, ...
    0062             'sos_parseConstructor_defaultMaxIt',1, ...
    0063             'sos_parseConstructor_pSwapFunction',1,...
    0064             'sos_parseConstructor_targSampleCandSelectMethod',1,...
    0065             'sos_parseConstructor_feederdfCandSelectMethod',1,...
    0066             'sos_parseConstructor_reportInterval',1,...
    0067             'sos_parseConstructor_stopFreezeIt',1,...
    0068             'sos_parseConstructor_statReports',1,...
    0069             'sos_addSample_NoPopForSampleWarn',1, ...
    0070             'sos_addSample_SampleAlreadyAddedWarn',1, ...
    0071             'sos_addSample_sampleAdded',1, ...
    0072             'sos_initFillSamples_start',1,...
    0073             'sos_normalizeData_start',1, ...
    0074             'sos_normalizeData_noVarWarn',1,...
    0075             'sos_initCost_startInit',1,...
    0076             'sos_initCost_indivHardCost',1,...
    0077             'sos_initCost_totalHardCost',1,...
    0078             'sos_initCost_indivSoftCost',1,...
    0079             'sos_initCost_totalSoftCost',1,...
    0080             'sos_initCost_indivMetaCost',1,...
    0081             'sos_initCost_totalMetaCost',1,...
    0082             'sos_initCost_totalSoftMetaCost',1,...
    0083             'sos_dispCost_start',1,...
    0084             'sos_dispCost_indivHardCost',1,...
    0085             'sos_dispCost_totalHardCost',1,...
    0086             'sos_dispCost_indivSoftCost',1,...
    0087             'sos_dispCost_totalSoftCost',1,...
    0088             'sos_dispCost_indivMetaCost',1,...
    0089             'sos_dispCost_totalMetaCost',1,...
    0090             'sos_dispCost_totalSoftMetaCost',1,...
    0091             'sos_dispCost_warnCostNaN',1,...
    0092             'sos_optimize_begin',1,...
    0093             'sos_optimize_startOptimization',1,...
    0094             'sos_optimize_resetFreezeIt',1,...
    0095             'sos_optimize_reportHeader',1,...
    0096             'sos_optimize_report',1,...
    0097             'sos_optimize_endMaxIt',1,...
    0098             'sos_optimize_endstopFreezeIt',1,...
    0099             'sos_optimize_endallStatsPass',1,...
    0100             'sos_optimize_endUserGuiInterrupt',1,...
    0101             'sos_setAnnealSchedule_defaultAnneal',1,...
    0102             'sos_writeSamples_begin',1, ...
    0103             'sos_writePopulations_begin',1,...
    0104             'sos_addttest_end',1,...
    0105             'sos_addztest_end',1,...
    0106             'sos_addkstest_end',1,...
    0107             'sos_doStatTests_begin',1,...
    0108             'sos_deltaCostPercentiles_Header',1,...
    0109             'sos_deltaCostPercentiles_Scores',1,...
    0110             'sos_deltaCostPercentiles_deltaCost95',1,...
    0111             'sos_createHistory_alreadyCreated',1,...
    0112             'sos_createPlots_alreadyCreated',1,...
    0113         ...
    0114             'hardBoundConstraint_Constructor_endObjCreation',1, ...
    0115             'hardBoundConstraint_initCost',1, ...
    0116         ...
    0117             'softDistanceConstraint_Constructor_endObjCreation',1,...
    0118         ...
    0119             'softEntropyConstraint_Constructor_endObjCreation',1,...
    0120         ...
    0121             'softMatchCorrelConstraint_Constructor_endObjCreation',1,...
    0122         ...
    0123             'softMetaConstraint_Constructor_endObjCreation',1,...
    0124         ...
    0125             'randSampleCandidateSelection_const',1, ...
    0126         ...
    0127             'randPopulationCandidateSelection_const',1, ...
    0128         ...
    0129             'randPopulationAndSampleCandidateSelection_const',1, ...
    0130         ...
    0131             'greedyAnneal_constructor_startObjCreation',1,...
    0132         ...
    0133             'expAnneal_constructor_startObjCreation',1, ...
    0134             'expAnneal_anneal_calibration',1, ...
    0135             'expAnneal_anneal_dropTemp',1,...
    0136             'expAnneal_anneal_pthermalEquil',1, ...
    0137             'expAnneal_numSteps_nStep',1,...
    0138             'expAnneal_numSteps_Warn',1,...
    0139             'expAnneal_maxpDecrease_maxpDecrease',1,...
    0140         ...
    0141             'sosttest_ruIndependentSamplettest',1, ...
    0142             'sosttest_runPairedSamplettest',1, ...
    0143             'sosttest_runSingleSamplettest',1, ...
    0144         ...
    0145              'sosCorrelTest_runMatchCorrelztest',1,...
    0146         ...
    0147              'soskstest_runMatchUniformkstest',1,...
    0148         ...
    0149             'sosHistory_constructor_end',1,...
    0150             'sosHistory_bufferedHistoryWrite_end',1, ...
    0151             'sosHistory_enableBufferedHistoryWrite_end',1,...
    0152             'sosHistory_disableBufferedHistoryWrite_end',1, ...
    0153             'sosHistory_writeHistory_begin',1, ...
    0154         ...
    0155             'sosPlots_constructor_end',1, ...
    0156         ...
    0157         ...
    0158         ... % GUI COMMAND OUTPUTS
    0159             'sos_gui_runScript_CallBack_runScript',1, ...
    0160             'sos_gui_cmdWindow_CallBack_runcmd',1, ...
    0161             'sosGui_writeDF',1, ...
    0162             'sosGui_links2p',1, ...
    0163             'sosGui_simpleCmd',1,...
    0164             'sosGui_addSample',1, ...
    0165             'sosGui_setFeederdfCandMethod',1, ...
    0166             'sosGui_initFillSamples',1, ...
    0167             'sosGui_normalizeData',1,...
    0168             'sosGui_setgreedyAnneal',1,...
    0169             'sosGui_greedyAnneal',1,...
    0170             'sosGui_initCost',1,...
    0171             'sosGui_doStats',1,...
    0172             'sosGui_createHistory',1,...
    0173             'sosGui_enableBufferedHistory',1,...
    0174             'sosGui_disableBufferedHistory',1,...
    0175             'sosGui_dispCost',1,...
    0176             'sosGui_deltaCostDeciles',1,...
    0177             'sosGui_writeSamples',1,...
    0178             'sosGui_writePopulations',1,...
    0179             'sosGui_writeAll',1,...
    0180             'sosGui_optimize',1,...
    0181         ...
    0182             'setSeed_Dialog_Set',1, ...
    0183         ...
    0184             'createPop_Dialog_Create',1, ...
    0185         ...
    0186             'createSample_Dialog_Create',1, ...
    0187         ...
    0188             'calculateOverlapDialog_calculateOverlap',1, ...
    0189         ...
    0190             'createSOSDialog_createSOS', 1, ...
    0191         ...
    0192             'expAnneal_Dialog_createExpAnneal',1, ...
    0193         ...
    0194             'numSteps_Dialog_calculate',1, ...
    0195         ...
    0196             'maxpDecrease_Dialog_calculate',1, ...
    0197         ...
    0198             'createHardBoundConstraint_Dialog_create',1, ...
    0199         ...
    0200             'createSingleSampleSoftDistanceConstraint_Dialog_create',1, ...
    0201         ...
    0202             'createTwoSampleSoftDistanceConstraint_Dialog_create',1, ...
    0203         ...
    0204             'createSoftMatchCorrelConstraint_Dialog_create',1,...
    0205         ...
    0206             'createSoftEntropyConstraint_Dialog_create',1, ...
    0207         ...
    0208             'createSoftMetaConstraint_Dialog_create',1, ...
    0209         ...
    0210             'createsinglesamplettest_Dialog_create',1, ...
    0211         ...
    0212             'create2samplettest_Dialog_create',1, ...
    0213         ...
    0214             'createMatchCorrelztest_Dialog_create',1,...
    0215         ...
    0216             'createMatchUniformkstest_Dialog_create',1,...
    0217         ...
    0218             'setBufferedHistoryOutfile_Dialog_create',1, ...
    0219         ...
    0220             'saveHistory_Dialog_save',1, ...
    0221         ...
    0222             'createPlots_Dialog_create',1 ...
    0223             );
    0224     end;
    0225
    0226
    0227 end
    0228