Project
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
o2::utilities::DataSampling Class Reference

#include <DataSampling.h>

Public Member Functions

 DataSampling ()=delete
 Deleted default constructor. This class is stateless.
 

Static Public Member Functions

static void GenerateInfrastructure (framework::WorkflowSpec &workflow, const std::string &policiesSource, size_t threads=1, const std::string &host="")
 Generates data sampling infrastructure.
 
static void GenerateInfrastructure (framework::WorkflowSpec &workflow, boost::property_tree::ptree const &policies, size_t threads=1, const std::string &host="")
 Generates data sampling infrastructure.
 
static void CustomizeInfrastructure (std::vector< framework::CompletionPolicy > &)
 Configures dispatcher to consume any data immediately.
 
static void CustomizeInfrastructure (std::vector< framework::ChannelConfigurationPolicy > &)
 Applies blocking/nonblocking data sampling configuration to the workflow.
 
static std::vector< framework::InputSpec > InputSpecsForPolicy (const boost::property_tree::ptree &policiesTree, const std::string &policyName)
 Provides InputSpecs to receive data for given DataSamplingPolicy. Expects the "dataSamplingPolicies" tree.
 
static std::vector< framework::OutputSpec > OutputSpecsForPolicy (const boost::property_tree::ptree &policiesTree, const std::string &policyName)
 Provides OutputSpecs of given DataSamplingPolicy. Expects the "dataSamplingPolicies" tree.
 
static std::optional< uint16_t > PortForPolicy (const boost::property_tree::ptree &policiesTree, const std::string &policyName)
 Provides the port to be used for a proxy of given DataSamplingPolicy. Expects the "dataSamplingPolicies" tree.
 
static std::vector< std::string > MachinesForPolicy (const boost::property_tree::ptree &policiesTree, const std::string &policyName)
 Provides the machines where given DataSamplingPolicy is enabled. Expects the "dataSamplingPolicies" tree.
 
static std::string BindLocationForPolicy (const boost::property_tree::ptree &policiesTree, const std::string &policyName)
 Says if remote part (e.g. QC server) should bind the inter-machine channel, according to the configuration. Expects the "dataSamplingPolicies" tree.
 

Detailed Description

A class responsible for providing data from main processing flow to QC tasks.

This class generates message-passing infrastructure to provide desired amount of data to Quality Control tasks or any other clients. Data to be sampled is declared in DataSamplingPolicy'ies configuration file - an example can be found in O2/Framework/TestWorkflows/exampleDataSamplingConfig.json).

In-code usage:

void customize(std::vector<CompletionPolicy>& policies)
{
DataSampling::CustomizeInfrastructure(policies);
}
void customize(std::vector<ChannelConfigurationPolicy>& policies)
{
DataSampling::CustomizeInfrastructure(policies);
}
#include "Framework/runDataProcessing.h"
std::vector<DataProcessorSpec> defineDataProcessing(ConfigContext &ctx)
{
WorkflowSpec workflow;
// <declaration of other DPL processors>
const std::string configurationFilePath = <absolute file path>;
DataSampling::GenerateInfrastructure(workflow, configurationFilePath);
return workflow;
}
file
configStandalone Light OpenGL display display_light Apply smoothing to points Enable Z buffer Highlight links Highlight seeds Highlight sector tracks Highlight final tracks Show individual Show related Highlight grid Show only individual collision Color clusters belonging to track objects Set line Enable drawing TPC data Enable drawing TOF data Enable drawing magnetic field Set field line step count Invert colors configStandalone Heavy OpenGL display display_heavy Show tracks with ITS contribution Show tracks with TOF contribution Enable propagation of loopers Show clusters at nominal x of pad row for early transformed data Split CE tracks when they cross the central Mark clusters Mark adjacent clusters Hide rejected tracks Apply filter on tracks to be displayed Separate increase X h configStandalone Camera window renderer OpenGL display display_camera Orient the camera such that the y axis is always upwards Full Screen MultiSample Anti Downsampling Anti Enable Vertical Sync Target frame or if the backend cannot limit to the refresh Use OpenGL indirect draws to reduce number of draw calls Display h configStandalone Vulkan display display_vulkan Have uniform buffers in host accessible device memory h configStandalone Internal display display_internal Number of updates the Qt GUI may send ahead of the last one the display has before it waits for the display Opacity of the console background Number of console lines the history is shortened to this when it reaches twice the size Time in seconds an info message fades out after setInfoTime h OpenGL display display Font size Do not use Freetype for font Renderer for event Frontend to use for event ROOT macros used as track filter Console script file
Definition GPUSettingsListDisplay.h:140
absolute
Timeframe settings Average distance in cm of events merged into Randomize distance around average distance of merged events Simulate correct bunch interactions instead of placing only the average number of events A value[n] sets TFlen for[n] collisions in Number of bunches per trainsort Number of bunch trains Instantaneous interaction rate Do not simulate border Total number of collisions to be placed in the interior of all time Do not select random but walk over array of events in stride steps h Event generator settings h configStandalone Use CPU for GPU Force usage of the specified GPU device no CPU fallback Continue processing after an error First event to Number of events to Number of iterations to Number of iterations to Number of initial iterations excluded from const char Directory with events to Events directory is absolute
Definition GPUSettingsListStandalone.h:61
defineDataProcessing
WorkflowSpec defineDataProcessing(ConfigContext const &configcontext)
Definition barrel-alignment-workflow.cxx:83
customize
void customize(std::vector< o2::framework::CallbacksPolicy > &policies)
Definition barrel-alignment-workflow.cxx:43
o2::utilities::DataSampling::CustomizeInfrastructure
static void CustomizeInfrastructure(std::vector< framework::CompletionPolicy > &)
Configures dispatcher to consume any data immediately.
Definition DataSampling.cxx:112
o2::utilities::DataSampling::GenerateInfrastructure
static void GenerateInfrastructure(framework::WorkflowSpec &workflow, const std::string &policiesSource, size_t threads=1, const std::string &host="")
Generates data sampling infrastructure.
Definition DataSampling.cxx:40
path
GLsizei const GLchar *const * path
Definition glcorearb.h:3591
o2::framework::WorkflowSpec
std::vector< DataProcessorSpec > WorkflowSpec
Definition HBFUtilsInitializer.h:39

Definition at line 74 of file DataSampling.h.

Constructor & Destructor Documentation

◆ DataSampling()

o2::utilities::DataSampling::DataSampling ( )
delete

Deleted default constructor. This class is stateless.

Member Function Documentation

◆ BindLocationForPolicy()

std::string o2::utilities::DataSampling::BindLocationForPolicy ( const boost::property_tree::ptree &  policiesTree,
const std::string &  policyName 
)
static

Says if remote part (e.g. QC server) should bind the inter-machine channel, according to the configuration. Expects the "dataSamplingPolicies" tree.

Definition at line 182 of file DataSampling.cxx.

◆ CustomizeInfrastructure() [1/2]

void o2::utilities::DataSampling::CustomizeInfrastructure ( std::vector< framework::ChannelConfigurationPolicy > &  policies)
static

Applies blocking/nonblocking data sampling configuration to the workflow.

Definition at line 118 of file DataSampling.cxx.

◆ CustomizeInfrastructure() [2/2]

void o2::utilities::DataSampling::CustomizeInfrastructure ( std::vector< framework::CompletionPolicy > &  policies)
static

Configures dispatcher to consume any data immediately.

Definition at line 112 of file DataSampling.cxx.

◆ GenerateInfrastructure() [1/2]

void o2::utilities::DataSampling::GenerateInfrastructure ( framework::WorkflowSpec &  workflow,
boost::property_tree::ptree const &  policies,
size_t  threads = 1,
const std::string &  host = "" 
)
static

Generates data sampling infrastructure.

Parameters
workflowDPL workflow with already declared data processors which provide data desired by QC tasks.
policiesSourceboost::property_tree::ptree with the configuration
threadsNumber of dispatcher threads, that will handle the data
hostHost name. If the host or a policy machine list are empty, the policy will always be created.

Definition at line 52 of file DataSampling.cxx.

◆ GenerateInfrastructure() [2/2]

void o2::utilities::DataSampling::GenerateInfrastructure ( framework::WorkflowSpec &  workflow,
const std::string &  policiesSource,
size_t  threads = 1,
const std::string &  host = "" 
)
static

Generates data sampling infrastructure.

Parameters
workflowDPL workflow with already declared data processors which provide data desired by QC tasks.
policiesSourcePath to configuration file.
threadsNumber of dispatcher threads, that will handle the data
hostHost name. If the host or a policy machine list are empty, the policy will always be created.

Definition at line 40 of file DataSampling.cxx.

◆ InputSpecsForPolicy()

std::vector< framework::InputSpec > o2::utilities::DataSampling::InputSpecsForPolicy ( const boost::property_tree::ptree &  policiesTree,
const std::string &  policyName 
)
static

Provides InputSpecs to receive data for given DataSamplingPolicy. Expects the "dataSamplingPolicies" tree.

Definition at line 124 of file DataSampling.cxx.

◆ MachinesForPolicy()

std::vector< std::string > o2::utilities::DataSampling::MachinesForPolicy ( const boost::property_tree::ptree &  policiesTree,
const std::string &  policyName 
)
static

Provides the machines where given DataSamplingPolicy is enabled. Expects the "dataSamplingPolicies" tree.

Definition at line 166 of file DataSampling.cxx.

◆ OutputSpecsForPolicy()

std::vector< framework::OutputSpec > o2::utilities::DataSampling::OutputSpecsForPolicy ( const boost::property_tree::ptree &  policiesTree,
const std::string &  policyName 
)
static

Provides OutputSpecs of given DataSamplingPolicy. Expects the "dataSamplingPolicies" tree.

Definition at line 140 of file DataSampling.cxx.

◆ PortForPolicy()

std::optional< uint16_t > o2::utilities::DataSampling::PortForPolicy ( const boost::property_tree::ptree &  policiesTree,
const std::string &  policyName 
)
static

Provides the port to be used for a proxy of given DataSamplingPolicy. Expects the "dataSamplingPolicies" tree.

Definition at line 155 of file DataSampling.cxx.

The documentation for this class was generated from the following files: