API

Modules

    Types and constants

    Functions and macros

    Documentation

    UpROOT.OpaqueObjectType
    UpROOT.OpaqueObject{tp,B<:AbstractVector{UInt8}}

    An opaque object of symbolic type tp. tp must be a Symbol. Use the data field to access the byte representation.

    source
    UpROOT.TBranchType
    TBranch <: AbstractVector{Any}

    UpROOT.TBranch is a wrapper around Python objects with mix-in uproot.tree.TBranchMethods. It behaves like a Julia AbstractVector. Ff the branch has children, it also behaves like a Tables.Table (with column access).

    TBranch is an on-disk data structure, iteration over single elements is very inefficient.

    Limitations: Write access is not implemented yet.

    source
    UpROOT.TDirectoryType
    TDirectory

    UpROOT.TDirectory is a wrapper around Python objects of type uproot.rootio.ROOTDirectory.

    TDirectory behaves similar to a Julia Dict, it supports the functions keys, length and getindex.

    Limitations: Write access is not implemented yet.

    TFile is defined as an alias for TDirectory in UpROOT.jl.

    source
    UpROOT.TFileType
    TFile = TDirectory

    The uproot Python package doesn't use separate types for the ROOT classes TFile and TDirectoy - so in UpROOT.jl, so in UpROOT.jl, TFile is just defined as an alias for TDirectory.

    Constructors:

    * `TFile(filename::AbstractString)::TFile`

    Use TFile(filename) to open files instead of TDirectory(filename) for increased clarity in your code.

    source
    UpROOT.TTreeType
    TTree <: AbstractVector{Any}

    UpROOT.TTree is a wrapper around Python objects with mix-in uproot.tree.TTreeMethods. It behaves like a Julia AbstractVector and Tables.Table (with column access).

    TTree is an on-disk data structure, iteration over single elements is very inefficient.

    Even though TTree is semantically a vector over the tree entries, a two dimensional getindex(tree::TTree, entries, branches) is defined for convenience. So you may use, e.g.:

    tree[1:5, (:branch1, :branch2)]
    tree[:, [:branch1, :branch2]]
    tree[[1,4,7,10], ["branch1", "branch2"]]

    Limitations: Write access is not implemented yet.

    source
    UpROOT.testdatadirMethod
    UpROOT.testdatadir()::String

    Path to some test data installed by UpROOT.jl for testing and experimentation purposes.

    Use UpROOT.testfiles to get Dict of all test files.

    source