class AliHLTTTreeProcessor: public AliHLTProcessor

This file is property of and copyright by the ALICE HLT Project
ALICE Experiment at CERN, All rights reserved.

Primary Authors: Timur Pocheptsov <Timur.Pocheptsov@cern.ch>
*                  Matthias Richter <Matthias.Richter@cern.ch>
for The ALICE HLT Project.

Permission to use, copy, modify and distribute this software and its
documentation strictly for non-commercial purposes is hereby granted
without fee, provided that the above copyright notice appears in all
copies and that both the copyright notice and this permission notice
appear in the supporting documentation. The authors make no claims
about the suitability of this software for any purpose. It is
provided "as is" without express or implied warranty.

Function Members (Methods)

This is an abstract class, constructors will not be documented.
Look at the header to check for available constructors.

public:

virtual	~AliHLTTTreeProcessor()
static const char*	AliHLTLogging::BuildLogString(const char* format, va_list& ap, bool bAppend = false)
static AliHLTUInt32_t	AliHLTComponent::CalculateChecksum(const AliHLTUInt8_t* buffer, int size)
int	AliHLTLogging::CheckFilter(AliHLTComponentLogSeverity severity) const
int	AliHLTLogging::CheckGroup(const char* originClass) const
int	AliHLTComponent::CheckOCDBEntries(const TMap *const externList = 0)
static TClass*	Class()
static void	AliHLTComponent::CopyDataType(AliHLTComponentDataType& tgtdt, const AliHLTComponentDataType& srcdt)
static string	AliHLTComponent::DataType2Text(const AliHLTComponentDataType& type, int mode = 0)
virtual int	AliHLTComponent::Deinit()
virtual int	AliHLTProcessor::DoProcessing(const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, AliHLTUInt32_t& size, AliHLTComponentBlockDataList& outputBlocks, AliHLTComponentEventDoneData*& edd)
static int	AliHLTComponent::ExtractComponentTableEntry(const AliHLTUInt8_t* pBuffer, AliHLTUInt32_t size, string& chainId, string& compId, string& compParam, vector<AliHLTUInt32_t>& parents)
static int	AliHLTComponent::ExtractComponentTableEntry(const AliHLTUInt8_t* pBuffer, AliHLTUInt32_t size, string& chainId, string& compId, string& compParam, vector<AliHLTUInt32_t>& parents, int& level)
static AliHLTUInt32_t	AliHLTComponent::ExtractEventTypeFromCDH(const AliHLTCDHWrapper *const cdh)
static int	AliHLTComponent::ExtractTriggerData(const AliHLTComponentTriggerData& trigData, const AliHLTUInt8_t (*)[gkAliHLTBlockDAttributeCount] attributes, AliHLTUInt64_t status, AliHLTCDHWrapper const cdh, AliHLTReadoutList readoutlist, bool printErrors = false)
static void	AliHLTComponent::FillBlockData(AliHLTComponentBlockData& blockData)
static void	AliHLTComponent::FillDataType(AliHLTComponentDataType& dataType)
static void	AliHLTComponent::FillEventData(AliHLTComponentEventData& evtData)
static void	AliHLTComponent::FillShmData(AliHLTComponentShmData& shmData)
int	AliHLTComponent::FindMatchingDataTypes(AliHLTComponent* pConsumer, AliHLTComponentDataTypeList* tgtList)
static TUUID	AliHLTComponent::GenerateGUID()
virtual const char*	AliHLTComponent::GetComponentID()
virtual AliHLTComponent::TComponentType	AliHLTProcessor::GetComponentType()
int	AliHLTComponent::GetCompressionLevel() const
static AliHLTComponentLogSeverity	AliHLTLogging::GetGlobalLoggingLevel()
virtual void	AliHLTComponent::GetInputDataTypes(AliHLTComponentDataTypeList&)
const char*	AliHLTLogging::GetKeyword() const
int	AliHLTComponent::GetLastObjectSize() const
static AliHLTComponentLogSeverity	AliHLTLogging::GetLocalLoggingDefault()
AliHLTComponentLogSeverity	AliHLTLogging::GetLocalLoggingLevel()
virtual void	AliHLTComponent::GetOCDBObjectDescription(TMap *const targetArray)
virtual void	GetOutputDataSize(unsigned long& constBase, double& inputMultiplier)
virtual AliHLTComponentDataType	GetOutputDataType()
virtual int	AliHLTComponent::GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList)
virtual void*	AliHLTLogging::GetParameter() const
static int	AliHLTComponent::GetReadoutList(const AliHLTComponentTriggerData& trigData, AliHLTReadoutList& list, bool printErrors = false)
virtual int	AliHLTComponent::Init(const AliHLTAnalysisEnvironment* comenv, void* environParam, int argc, const char** argv)
static int	AliHLTLogging::InitAliLogFunc(AliHLTComponentHandler* pHandler)
static int	AliHLTLogging::InitAliLogTrap(AliHLTComponentHandler* pHandler)
int	AliHLTComponent::InitCDB(const char* cdbPath, AliHLTComponentHandler* pHandler)
virtual TClass*	IsA() const
int	AliHLTLogging::Logging(AliHLTComponentLogSeverity severity, const char* origin, const char* keyword, const char* message)
virtual int	AliHLTComponent::LoggingVarargs(AliHLTComponentLogSeverity severity, const char* originClass, const char* originFunc, const char* file, int line) const
static int	AliHLTLogging::Message(void* param, AliHLTComponentLogSeverity severity, const char* origin, const char* keyword, const char* message)
static void	AliHLTComponent::PrintComponentDataTypeInfo(const AliHLTComponentDataType& dt)
static void	AliHLTComponent::PrintDataTypeContent(AliHLTComponentDataType& dt, const char* format = 0)
int	AliHLTComponent::ProcessEvent(const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks, AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr, AliHLTUInt32_t& size, AliHLTUInt32_t& outputBlockCnt, AliHLTComponentBlockData& outputBlocks, AliHLTComponentEventDoneData& edd)
int	AliHLTLogging::SendMessage(AliHLTComponentLogSeverity severity, const char* originClass, const char* originFunc, const char* file, int line, const char* message) const
static int	AliHLTLogging::SetBlackList(const char* classnames)
int	AliHLTComponent::SetCDBRunNo(int runNo)
int	AliHLTComponent::SetComponentDescription(const char* desc)
int	AliHLTComponent::SetComponentEnvironment(const AliHLTAnalysisEnvironment* comenv, void* environParam)
static void	AliHLTComponent::SetDataType(AliHLTComponentDataType& tgtdt, const char* id, const char* origin)
static void	AliHLTComponent::SetDataType(AliHLTComponentDataType& dt, AliHLTUInt64_t id, AliHLTUInt32_t orig)
void	AliHLTLogging::SetDefaultKeyword(const char* keyword)
static int	AliHLTComponent::SetGlobalComponentHandler(AliHLTComponentHandler* pCH, int bOverwrite = 0)
static void	AliHLTLogging::SetGlobalLoggingLevel(AliHLTComponentLogSeverity level)
const char*	AliHLTLogging::SetKeyword(const char* keyword)
static void	AliHLTLogging::SetLocalLoggingDefault(AliHLTComponentLogSeverity level)
virtual void	AliHLTLogging::SetLocalLoggingLevel(AliHLTComponentLogSeverity level)
static const char*	AliHLTLogging::SetLogString(const void* p, const char* pfmt, const char* format)
int	AliHLTComponent::SetRunDescription(const AliHLTRunDesc* desc, const char* runType)
int	AliHLTComponent::SetStopwatch(TObject* pSW, AliHLTComponent::AliHLTStopwatchType type = kSWBase)
int	AliHLTComponent::SetStopwatches(TObjArray* pStopwatches)
static int	AliHLTLogging::SetWhiteList(const char* classnames)
virtual void	ShowMembers(TMemberInspector&)
virtual AliHLTComponent*	AliHLTComponent::Spawn()
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
void	AliHLTLogging::SwitchAliLog(int sw)
static int	AliHLTComponent::UnsetGlobalComponentHandler()

protected:

void*	AliHLTComponent::AllocMemory(unsigned long size)
int	AliHLTComponent::CheckCTPTrigger(const char* name) const
int	AliHLTComponent::CloseMemoryFile(AliHLTMemoryFile* pFile)
int	AliHLTComponent::ConfigureFromArgumentString(int argc, const char** argv)
int	AliHLTComponent::ConfigureFromCDBTObjString(const char* entries, const char* key = 0)
int	AliHLTComponent::CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo, const char* structname = "", const char* eventname = "")
int	AliHLTComponent::CreateEventDoneData(AliHLTComponentEventDoneData edd)
AliHLTMemoryFile*	AliHLTComponent::CreateMemoryFile(int capacity, const AliHLTComponentDataType& dt = kAliHLTAnyDataType, AliHLTUInt32_t spec = kAliHLTVoidDataSpec)
AliHLTMemoryFile*	AliHLTComponent::CreateMemoryFile(const AliHLTComponentDataType& dt = kAliHLTAnyDataType, AliHLTUInt32_t spec = kAliHLTVoidDataSpec, float capacity = 1.0)
AliHLTMemoryFile*	AliHLTComponent::CreateMemoryFile(int capacity, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec = kAliHLTVoidDataSpec)
AliHLTMemoryFile*	AliHLTComponent::CreateMemoryFile(const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec = kAliHLTVoidDataSpec, float capacity = 1.0)
const AliHLTCTPData*	AliHLTComponent::CTPData() const
void	AliHLTComponent::DataType2Text(const AliHLTComponentDataType& type, char* output) const
virtual int	DoDeinit()
virtual int	DoEvent(const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData)
virtual int	DoInit(int argc, const char** argv)
virtual int	AliHLTComponent::EndOfRun()
int	AliHLTComponent::EstimateObjectSize(const TObject* pObject) const
bool	AliHLTComponent::EvaluateCTPTriggerClass(const char* expression, AliHLTComponentTriggerData& trigData) const
int	AliHLTComponent::Forward(const TObject* pObject)
int	AliHLTComponent::Forward(const AliHLTComponentBlockData* pBlock = 0)
unsigned short	AliHLTComponent::GetBunchCrossNumber() const
void	AliHLTComponent::GetBxByBz(const Double_t* r, Double_t* b)
Double_t	AliHLTComponent::GetBz()
Double_t	AliHLTComponent::GetBz(const Double_t* r)
const char*	AliHLTComponent::GetChainId() const
AliHLTComponentEventDoneData*	AliHLTComponent::GetCurrentEventDoneData() const
AliHLTComponentDataType	AliHLTComponent::GetDataType(const TObject* pObject = 0)
int	AliHLTComponent::GetEventCount() const
int	AliHLTComponent::GetEventDoneData(unsigned long size, AliHLTComponentEventDoneData** edd) const
AliHLTEventID_t	AliHLTComponent::GetEventId() const
const AliHLTComponentBlockData*	AliHLTComponent::GetFirstInputBlock(const AliHLTComponentDataType& dt = kAliHLTAllDataTypes)
const AliHLTComponentBlockData*	AliHLTComponent::GetFirstInputBlock(const char* dtID, const char* dtOrigin)
const TObject*	AliHLTComponent::GetFirstInputObject(const AliHLTComponentDataType& dt = kAliHLTAllDataTypes, const char* classname = 0, int bForce = 0)
const TObject*	AliHLTComponent::GetFirstInputObject(const char* dtID, const char* dtOrigin, const char* classname = 0, int bForce = 0)
const AliHLTComponentBlockData*	AliHLTComponent::GetInputBlock(int index) const
const AliHLTComponentBlockData*	AliHLTComponent::GetNextInputBlock()
const TObject*	AliHLTComponent::GetNextInputObject(int bForce = 0)
int	AliHLTComponent::GetNumberOfInputBlocks() const
AliHLTUInt32_t	AliHLTComponent::GetOrbitNumber() const
AliHLTUInt32_t	AliHLTComponent::GetPeriodNumber() const
AliHLTUInt32_t	AliHLTComponent::GetRunNo() const
AliHLTUInt32_t	AliHLTComponent::GetRunType() const
AliHLTUInt32_t	AliHLTComponent::GetSpecification(const TObject* pObject = 0)
AliHLTUInt32_t	AliHLTComponent::GetSpecification(const AliHLTComponentBlockData* pBlock)
AliHLTUInt32_t	AliHLTComponent::GetTimeStamp() const
bool	AliHLTComponent::IsDataEvent(AliHLTUInt32_t* pTgt = 0) const
TObject*	AliHLTComponent::LoadAndExtractOCDBObject(const char* path, const char* key = 0) const
int	AliHLTComponent::MakeOutputDataBlockList(const AliHLTComponentBlockDataList& blocks, AliHLTUInt32_t* blockCount, AliHLTComponentBlockData** outputBlocks)
int	AliHLTComponent::PushBack(const TObject* pObject, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec = kAliHLTVoidDataSpec, void* pHeader = 0, int headerSize = 0)
int	AliHLTComponent::PushBack(const TObject* pObject, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec = kAliHLTVoidDataSpec, void* pHeader = 0, int headerSize = 0)
int	AliHLTComponent::PushBack(const void* pBuffer, int iSize, const AliHLTComponentDataType& dt, AliHLTUInt32_t spec = kAliHLTVoidDataSpec, const void* pHeader = 0, int headerSize = 0)
int	AliHLTComponent::PushBack(const void* pBuffer, int iSize, const char* dtID, const char* dtOrigin, AliHLTUInt32_t spec = kAliHLTVoidDataSpec, const void* pHeader = 0, int headerSize = 0)
int	AliHLTComponent::PushEventDoneData(AliHLTUInt32_t eddDataWord)
virtual int	AliHLTComponent::ReadPreprocessorValues(const char* modules)
virtual int	AliHLTComponent::Reconfigure(const char* cdbEntry, const char* chainId)
void	AliHLTComponent::ReleaseEventDoneData()
virtual bool	AliHLTComponent::RequireSteeringBlocks() const
int	AliHLTComponent::ReserveEventDoneData(unsigned long size)
virtual int	ScanConfigurationArgument(int argc, const char** argv)
int	AliHLTComponent::SetupCTPData()
virtual int	AliHLTComponent::StartOfRun()
int	AliHLTComponent::Write(AliHLTMemoryFile* pFile, const TObject* pObject, const char* key = 0, int option = TObject::kOverwrite)

private:

TH1*	CreateHistogram(const AliHLTTTreeProcessor::AliHLTHistogramDefinition& def)
virtual TTree*	CreateTree(int argc, const char** argv)
virtual void	FillHistogramDefinitions()
virtual int	FillTree(TTree* pTree, const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData)
virtual AliHLTUInt32_t	GetDataSpec() const
virtual AliHLTComponentDataType	GetOriginDataType() const
AliHLTTTreeProcessor&	operator=(const AliHLTTTreeProcessor&)
int	ParseHistogramDefinition(int argc, const char** argv, int pos, AliHLTTTreeProcessor::AliHLTHistogramDefinition& dst) const

Data Members

public:

enum EDefaults {	kMaxEntries
	kDefaultNBins
	kInterval
};
enum AliHLTComponent::TComponentType {	kUnknown
	kSource
	kProcessor
	kSink
};
enum AliHLTComponent::AliHLTStopwatchType {	kSWBase
	kSWDA
	kSWInput
	kSWOutput
	kSWTypeCount
};

public:

static ostringstream	AliHLTLogging::fgLogstr	! transient

protected:

list<AliHLTHistogramDefinition>	fDefinitions
static void*	AliHLTLogging::fgAliLoggingFunc	! transient

private:

float	fCycleTimeFactor	! weight for the cycle time
AliHLTUInt32_t	fForcedEventsCount	! event count for the forced events
AliHLTUInt32_t	fIgnoreCycleTime	! ignore cycle time for n seconds
unsigned int	fLastTime	! last time the histogramms were published
int	fMaxEntries	! maximum number of entries in the circular tree
AliHLTUInt32_t	fMaxEventTime	! allowed maximum processing time in usec
AliHLTUInt32_t	fMaxMemory	! maximum memory consumption allowed for the process
AliHLTUInt32_t	fNewEventsCount	! number of new events since last publishing
AliHLTUInt32_t	fNofEventsForce	! number of events to ignore the processing time
unsigned int	fPublishInterval	! publish interval in s
AliHLTUInt32_t	fSkippedEventsCount	! number of skipped events
TTree*	fTree	! the tree instance
AliHLTUInt32_t	fUniqueId	! a unique id for this process used to identify the output of multiple processes
static const AliHLTUInt32_t	fgkTimeScale
TStopwatch*	fpCycleTimer	! stopwatch for event cycle
TStopwatch*	fpEventTimer	! stopwatch for event processing

Class Charts

Inheritance Chart:

AliHLTLogging

←

AliHLTComponent

←

AliHLTProcessor

←

AliHLTTTreeProcessor

Function documentation

~AliHLTTTreeProcessor()

 see header file for class documentation

AliHLTComponentDataType GetOutputDataType()

 get the component output data type

void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier)

 get the output size estimator

int DoInit(int argc, const char** argv)

 init component
 ask child to create the tree.

int DoDeinit()

 cleanup component

int DoEvent(const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData)

Process event and publish histograms.

int ScanConfigurationArgument(int argc, const char** argv)

 scan one argument and its parameters from the list
 return number of processed entries.
 possible arguments:
 -maxentries number
 -interval number
 -histogram name -size number -expression expression [-title expression ] -cut expression ][-opt option]
 As soon as "-histogram" found, -size and -expression and -outtype are required,
 cut and option can be omitted.

TH1* CreateHistogram(const AliHLTTTreeProcessor::AliHLTHistogramDefinition& def)

int ParseHistogramDefinition(int argc, const char** argv, int pos, AliHLTTTreeProcessor::AliHLTHistogramDefinition& dst) const

Histogram-definition:
    -histogram name -size number -expression expression [-title expression][-cut expression][-opt option]

TTree* CreateTree(int argc, const char** argv)

 create the tree instance and all branches

int FillTree(TTree* pTree, const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData)

 process input blocks and fill tree

AliHLTUInt32_t GetDataSpec() const

 dtOrigin for PushBack.
 spec for PushBack

{return fUniqueId;}

void FillHistogramDefinitions()

 default histogram definitions.