o2::ctf Namespace Reference

pair of input and output size More...

Namespaces
namespace	detail
namespace	internal

Classes
struct	ANSHeader
struct	Block
	binary blob for single entropy-compressed column: metadata + (optional) dictionary and data buffer + their sizes More...
class	CTFCoderBase
struct	CTFDictHeader
	Detector header base. More...
struct	CTFHeader
struct	CTFIOSize
struct	CTFReaderInp
class	CTFReaderSpec
class	CTFWriterSpec
class	EncodedBlocks
	<<======================== Auxiliary classes =======================<< More...
struct	Metadata
struct	Registry
	‍>======================== Auxiliary classes =======================>> More...

Typedefs
using	BufferType = uint8_t
	This is the type of the vector to be used for the EncodedBlocks buffer allocation.
using	DetID = o2::detectors::DetID
using	FTrans = o2::rans::DenseHistogram< int32_t >

Functions
ANSHeader	ansVersionFromString (const std::string &ansVersionString)
std::ostream &	operator<< (std::ostream &stream, const CTFHeader &c)
size_t	alignSize (size_t sizeBytes)
	align size to given diven number of bytes
template<class T >
T *	relocatePointer (const char *oldBase, char *newBase, const T *ptr)
	relocate pointer by the difference of addresses
template<typename source_T , typename dest_T , std::enable_if_t<(sizeof(dest_T) >=sizeof(source_T)), bool > = true>
constexpr size_t	calculateNDestTElements (size_t nElems) noexcept
template<typename source_T , typename dest_T , std::enable_if_t<(sizeof(dest_T) >=sizeof(source_T)), bool > = true>
size_t	calculatePaddedSize (size_t nElems) noexcept
framework::DataProcessorSpec	getCTFReaderSpec (const o2::ctf::CTFReaderInp &inp)
	create a processor spec
framework::DataProcessorSpec	getCTFWriterSpec (o2::detectors::DetID::mask_t dets, const std::string &outType, int verbosity, int reportInterval)
	create a processor spec
template<typename T >
bool	readFromTree (TTree &tree, const std::string brname, T &dest, int ev=0)
template<typename T >
size_t	appendToTree (TTree &tree, const std::string brname, T &ptr)

Variables
constexpr ANSHeader	ANSVersionUnspecified {0, 0}
constexpr ANSHeader	ANSVersionCompat {0, 1}
constexpr ANSHeader	ANSVersion1 {1, 0}
constexpr size_t	PackingThreshold = 512
constexpr size_t	Alignment = 16
constexpr int	WrappersSplitLevel = 99
constexpr int	WrappersCompressionLevel = 1

Detailed Description

pair of input and output size

The Metadata required to decoded the CTF of particular detector.

Typedef Documentation

BufferType

using o2::ctf::BufferType = typedef uint8_t

This is the type of the vector to be used for the EncodedBlocks buffer allocation.

Definition at line 86 of file EncodedBlocks.h.

DetID

typedef o2::detectors::DetID o2::ctf::DetID

this is a base class for particular detector CTF coder/decoder, provides common interface to create external entropy encoders/decoders

Definition at line 51 of file CTFCoderBase.h.

FTrans

using o2::ctf::FTrans = typedef o2::rans::DenseHistogram<int32_t>

Definition at line 95 of file CTFWriterSpec.cxx.

Function Documentation

alignSize()

size_t o2::ctf::alignSize ( size_t  sizeBytes )

inline

align size to given diven number of bytes

Definition at line 89 of file EncodedBlocks.h.

ansVersionFromString()

ANSHeader o2::ctf::ansVersionFromString ( const std::string &  ansVersionString )

inline

Definition at line 57 of file ANSHeader.h.

appendToTree()

template<typename T >

size_t o2::ctf::appendToTree	(	TTree &	tree,
		const std::string	brname,
		T &	ptr
	)

Definition at line 75 of file CTFWriterSpec.cxx.

calculateNDestTElements()

template<typename source_T , typename dest_T , std::enable_if_t<(sizeof(dest_T) >=sizeof(source_T)), bool > = true>

constexpr size_t o2::ctf::calculateNDestTElements ( size_t  nElems )

inlineconstexprnoexcept

Definition at line 103 of file EncodedBlocks.h.

calculatePaddedSize()

template<typename source_T , typename dest_T , std::enable_if_t<(sizeof(dest_T) >=sizeof(source_T)), bool > = true>

size_t o2::ctf::calculatePaddedSize ( size_t  nElems )

inlinenoexcept

Definition at line 110 of file EncodedBlocks.h.

getCTFReaderSpec()

DataProcessorSpec o2::ctf::getCTFReaderSpec

(

const CTFReaderInp &

inp

)

create a processor spec

---

Definition at line 629 of file CTFReaderSpec.cxx.

getCTFWriterSpec()

DataProcessorSpec o2::ctf::getCTFWriterSpec	(	o2::detectors::DetID::mask_t	dets,
		const std::string &	outType,
		int	verbosity,
		int	reportInterval
	)

create a processor spec

Definition at line 791 of file CTFWriterSpec.cxx.

operator<<()

std::ostream & o2::ctf::operator<<	(	std::ostream &	stream,
		const CTFHeader &	c
	)

Definition at line 29 of file CTFHeader.cxx.

readFromTree()

template<typename T >

bool o2::ctf::readFromTree	(	TTree &	tree,
		const std::string	brname,
		T &	dest,
		int	ev = 0
	)

Definition at line 67 of file CTFReaderSpec.cxx.

relocatePointer()

template<class T >

T * o2::ctf::relocatePointer ( const char *  oldBase, char *  newBase, const T *  ptr  )

inline

relocate pointer by the difference of addresses

Definition at line 97 of file EncodedBlocks.h.

Variable Documentation

Alignment

constexpr size_t o2::ctf::Alignment = 16

constexpr

Definition at line 80 of file EncodedBlocks.h.

ANSVersion1

constexpr ANSHeader o2::ctf::ANSVersion1 {1, 0}

inlineconstexpr

Definition at line 55 of file ANSHeader.h.

ANSVersionCompat

constexpr ANSHeader o2::ctf::ANSVersionCompat {0, 1}

inlineconstexpr

Definition at line 54 of file ANSHeader.h.

ANSVersionUnspecified

constexpr ANSHeader o2::ctf::ANSVersionUnspecified {0, 0}

inlineconstexpr

Definition at line 53 of file ANSHeader.h.

PackingThreshold

constexpr size_t o2::ctf::PackingThreshold = 512

constexpr

Definition at line 78 of file EncodedBlocks.h.

WrappersCompressionLevel

constexpr int o2::ctf::WrappersCompressionLevel = 1

constexpr

Definition at line 83 of file EncodedBlocks.h.

WrappersSplitLevel

constexpr int o2::ctf::WrappersSplitLevel = 99

constexpr

Definition at line 82 of file EncodedBlocks.h.