Warning, /jana2/docs/doxygen/doxygen_index.md is written in an unsupported language. File is not indexed.
0001 JANA2 C++ Reference Guide
0002 =========================
0003
0004 JANA2 is a cutting-edge C++ framework designed for High Energy and Nuclear Physics experimental data reconstruction. It excels in multi-threaded processing, ensuring maximum efficiency and scalability. With its intuitive setup and extensive customization options, JANA2 empowers both novice and experienced programmers to contribute effectively. Whether running on a local machine or a large computing cluster, JANA2 optimizes performance, making it the ideal choice for any scale of project.
0005
0006 - Read more information on [MAIN DOCUMENTATION](https://JeffersonLab.github.io/JANA2/) website
0007 - Contribute [on GitHub](https://github.com/JeffersonLab/JANA2)
0008
0009 This website provides documentation for JANA2 C++ API automatically generated by Doxygen.
0010
0011 ## Main API
0012
0013 * [JApplication](class_j_application.html): The main entry point into the program
0014 * [JObject](class_j_object.html): Data containers for specific results
0015 * [JEventSource](class_j_event_source.html): From a file or messaging producer, expose a stream of events. Each event is an aggregate of JObjects
0016 * [JFactory](class_j_factory.html): Given an event, calculate a specific result, potentially calling other JFactories recursively to obtain any prereqs
0017 * [JEventProcessor](class_j_event_processor.html): Run desired JFactories over the event stream, writing results to an output file or messaging consumer
0018
0019 ## User-facing utilities
0020
0021 * [JParameter](class_j_parameter.html): Configure the behavior of components at runtime
0022 * [JLogger](struct_j_logger.html): Publish debugging information to standard out in a structured, convenient, threadsafe way
0023 * [JService](struct_j_service.html): Share external (stateful) services such as calibration constants and magnetic field maps
0024
0025 ## Internal services
0026
0027 * [JParameterManager](class_j_parameter_manager.html): Furnish the user with parameters extracted from command line flags and configuration files
0028
0029 * [JExecutionEngine](class_j_execution_engine.html): Runs the topology. Manages the thread team and the topology status.
0030
0031
0032
