4. rootpy Package¶

4.1. rootpy Package¶

exception rootpy.__init__.ROOTError(level, location, msg)[source]¶

Bases: exceptions.RuntimeError

Exception class representing a ROOT error/warning message.

4.2. classfactory Module¶

This module handles dictionary generation of classes for use in the Python environment. Dictionaries are kept in $ROOTPY_DATA for later use so they are not repeatedly regenerated

rootpy.classfactory.generate(declaration, headers=None)[source]¶

4.3. core Module¶

This module contains base classes defining core functionality

class rootpy.core.NamelessConstructorObject(name, title, *args, **kwargs)[source]¶

Bases: rootpy.core.Object

Handle special cases like TGraph where the ROOT constructor does not take name/title

class rootpy.core.Object(name, title, *args, **kwargs)[source]¶

Bases: object

Overrides TObject methods. Name and title for TObject-derived classes are optional. If no name is specified, a UUID is used to ensure uniqueness.

Clone(name=None, title=None, **kwargs)[source]¶

name[source]¶

title[source]¶

class rootpy.core.RequireFile[source]¶

Bases: object

static cd(f)[source]¶

A decorator Useful for TTree.Write...

rootpy.core.camel_to_snake(name)[source]¶

http://stackoverflow.com/questions/1175208/ elegant-python-function-to-convert-camelcase-to-camel-case

rootpy.core.isbasictype(thing)[source]¶

Is this thing a basic builtin numeric type?

rootpy.core.snake_case_methods(cls, debug=False)[source]¶

A class decorator adding snake_case methods that alias capitalized ROOT methods

rootpy.core.wrap_call(cls, method, *args, **kwargs)[source]¶

Will provide more detailed info in the case that a method call on a ROOT object raises a TypeError

4.4. objectproxy Module¶

class rootpy.objectproxy.MethodProxy(obj, func, name)[source]¶

Bases: object

Wrapper object for a method to be called.

class rootpy.objectproxy.ObjectProxy(obj)[source]¶

Bases: object

4.5. path Module¶

rootpy.path.expand(s)[source]¶

rootpy.path.expand_and_glob(s)[source]¶

rootpy.path.expand_and_glob_all(s)[source]¶

4.6. registry Module¶

rootpy.registry.lookup(cls)[source]¶

rootpy.registry.lookup_by_name(cls_name)[source]¶

rootpy.registry.lookup_demotion(cls)[source]¶

class rootpy.registry.register(names=None, demote=None, builtin=False)[source]¶

Bases: object

4.7. root2tables Module¶

4.8. types Module¶

Wrappers for basic types that are compatible with ROOT TTrees

class rootpy.types.Bool(default=False, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing a Boolean type

classmethod convert(value)[source]¶

type = 'O'¶

typename = 'Bool_t'¶

class rootpy.types.BoolArray(length, default=False, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of Booleans

type = 'O'¶

typename = 'Bool_t'¶

class rootpy.types.BoolArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of BoolArray

class rootpy.types.BoolCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of Bool

class rootpy.types.Char(default=False, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing a character type

classmethod convert(value)[source]¶

type = 'C'¶

typename = 'Char_t'¶

class rootpy.types.CharArray(length, default=False, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of characters

type = 'C'¶

typename = 'Char_t'¶

class rootpy.types.CharArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of CharArray

class rootpy.types.CharCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of Char

class rootpy.types.Column(*args, **kwargs)[source]¶

Bases: object

class rootpy.types.Double(default=0.0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing a double

classmethod convert(value)[source]¶

type = 'D'¶

typename = 'Double_t'¶

class rootpy.types.DoubleArray(length, default=0.0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of doubles

type = 'D'¶

typename = 'Double_t'¶

class rootpy.types.DoubleArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of DoubleArray

class rootpy.types.DoubleCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of Double

class rootpy.types.Float(default=0.0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing a float

classmethod convert(value)[source]¶

type = 'F'¶

typename = 'Float_t'¶

class rootpy.types.FloatArray(length, default=0.0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of floats

type = 'F'¶

typename = 'Float_t'¶

class rootpy.types.FloatArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of FloatArray

class rootpy.types.FloatCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of Float

class rootpy.types.Int(default=0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing an integer

classmethod convert(value)[source]¶

type = 'I'¶

typename = 'Int_t'¶

class rootpy.types.IntArray(length, default=0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of integers

type = 'I'¶

typename = 'Int_t'¶

class rootpy.types.IntArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of IntArray

class rootpy.types.IntCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of Int

class rootpy.types.Long(default=0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing a long

classmethod convert(value)[source]¶

type = 'L'¶

typename = 'Long64_t'¶

class rootpy.types.LongArray(length, default=0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of longs

type = 'L'¶

typename = 'Long64_t'¶

class rootpy.types.LongArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of LongArray

class rootpy.types.LongCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of Long

class rootpy.types.ObjectCol(cls, *args, **kwargs)[source]¶

Bases: rootpy.types.Column

class rootpy.types.Short(default=0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing an integer

classmethod convert(value)[source]¶

type = 'S'¶

typename = 'Short_t'¶

class rootpy.types.ShortArray(length, default=0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of integers

type = 'S'¶

typename = 'Short_t'¶

class rootpy.types.ShortArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of ShortArray

class rootpy.types.ShortCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of Short

class rootpy.types.UChar(default=False, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing an unsigned character type

classmethod convert(value)[source]¶

type = 'c'¶

typename = 'UChar_t'¶

class rootpy.types.UCharArray(length, default=False, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of unsigned characters

type = 'c'¶

typename = 'UChar_t'¶

class rootpy.types.UCharArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of UCharArray

class rootpy.types.UCharCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of UChar

class rootpy.types.UInt(default=0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing an unsigned integer

classmethod convert(value)[source]¶

type = 'i'¶

typename = 'UInt_t'¶

class rootpy.types.UIntArray(length, default=0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of unsigned integers

type = 'i'¶

typename = 'UInt_t'¶

class rootpy.types.UIntArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of UIntArray

class rootpy.types.UIntCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of UInt

class rootpy.types.ULong(default=0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing an unsigned long

classmethod convert(value)[source]¶

type = 'l'¶

typename = 'ULong64_t'¶

class rootpy.types.ULongArray(length, default=0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is of unsigned longs

type = 'l'¶

typename = 'ULong64_t'¶

class rootpy.types.ULongArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of ULongArray

class rootpy.types.ULongCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of ULong

class rootpy.types.UShort(default=0, **kwargs)[source]¶

Bases: rootpy.types.Variable

This is a variable containing a short

classmethod convert(value)[source]¶

type = 's'¶

typename = 'UShort_t'¶

class rootpy.types.UShortArray(length, default=0, **kwargs)[source]¶

Bases: rootpy.types.VariableArray

This is an array of unsigned shorts

type = 's'¶

typename = 'UShort_t'¶

class rootpy.types.UShortArrayCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of UShortArray

class rootpy.types.UShortCol(*args, **kwargs)[source]¶

Bases: rootpy.types.Column

type¶

alias of UShort

class rootpy.types.Variable(resetable=True)[source]¶

Bases: array.array

This is the base class for all variables

clear()[source]¶

Supplied to match the interface of ROOT.vector

reset()[source]¶

Reset the value to the default

set(value)[source]¶

Set the value

value[source]¶

The current value

class rootpy.types.VariableArray(resetable=True)[source]¶

Bases: array.array

This is the base class for all array variables

clear()[source]¶

Supplied to match the interface of ROOT.vector

reset()[source]¶

Reset the value to the default

set(other)[source]¶

rootpy.types.convert(origin, target, type)[source]¶

convert type from origin to target origin/target must be ROOTCODE, ROOTNAME, ARRAY, or NUMPY

4.9. userdata Module¶

This module handles creation of the user-data area

4.10. utils Module¶

rootpy.utils.asrootpy(tobject, **kwargs)[source]¶

rootpy.utils.create(cls_name, *args, **kwargs)[source]¶

4.11. Subpackages¶