Changeset 1050

Show
Ignore:
Timestamp:
06/07/10 13:41:10 (14 years ago)
Author:
smidl
Message:

doc toolbox

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • applications/bdmtoolbox/doc/local/mainpage.dox

    r1044 r1050  
    66\author Vaclav Smidl 
    77 
    8 BDMToolbox is a high-level frontend to low level C++ routines of BDM. 
     8BDMToolbox is a high-level front-end to low level C++ routines of BDM. 
    99 
    10 It has three main categories of usecases: 
    11  -# Easy access to ready solutions of typical decision-making scenarios: 
    12   
    13   For example simulation, estimation, feedback control. These objects are described by matlab structures. 
    14   See \ref bdt_scenarios 
    15  -# Wrappers for selected C++ functions  
    16   
    17    Taking matlab structures as inputs and retunring matlab structures as outputs, see \ref bdt_wrappers 
    18   
    19  -# Native Matlab classes that reflect the basic classes of BDM.  
    20   
    21    These classes are pure Matlab classes and can be used without BDM.  
    22    
    23    However, their main advantage is that BDM attach to these calsses and use them via C++ classes (e.g. mexEpdf and mexBM). Hence, these calsses can be used as building blocks in advances  
    24    algorithms implemnetyed in BDM, see \ref bdt_mex_classes 
     10It has three main categories of use cases: 
    2511 
    26 For tutorial on the above scenarios see \ref pages.html 
     12\section bdt_int_ready Standard scenarios 
     13 Typical decision-making scenarios has been prepared as standalone functions, which can be configured using  
     14Matlab structures with definition of experimental conditions. \n 
     15These include: 
     16 - simulation, as a trivial example, where data are generated by a chosen simulator (or any prepared DataSource) and stored in the required format, 
     17 - estimation, same as the simulation scenario above extended by connection to an array of estimators, 
     18 - feedback control, where the systems simulator (or real system) is connected to an array of controllers.  
     19 - multiple-participant decision making, where autonomous agents operate in their environment. 
     20 
     21The purpose of this use case is to create a consistent experimental environment for rapid exploration of new data,  
     22new application domains, where different estimation and control algorithms can be quickly exchanges and mutually compared. 
     23 
     24See \ref bdt_scenarios for details. 
     25 
     26 
     27\section bdt_int_wrap Matlab interface to C++ algorithms 
     28 
     29Selected individual algorithms of the BDM toolbox are accessible via dedicated mex functions. 
     30These mex functions operate as follows: 
     31 -# Matlab structures on their input is translated into C++ data structures 
     32 -# run the required algorithm, 
     33 -# the output is again converted to Matlab structures. 
     34 
     35The purpose of this use case is to allow composition of existing algorithms in a new arrangement.  
     36For example, it allows non-standard steps in the main loop, manipulation with configuration structures of scenarios,  
     37novel combination of conditionally independent filters, etc. 
     38 
     39See, \ref bdt_wrappers for details. 
     40 
     41\section bdt_int_class Matlab classes extending BDM classes 
     42 
     43These classes are pure Matlab classes and can be used without BDM. 
     44 
     45However, their main advantage is that BDM attach to these classes and use them via C++ classes (e.g. mexEpdf and mexBM). Hence, these classes can be used as building blocks in advances  
     46algorithms implemented in BDM. 
     47 
     48The purpose of this use case is to allow seamless integration of pure Matlab algorithm into the routines of BDM.  
     49 
     50See \ref bdt_mex_classes for details 
    2751 
    2852 */