# uproot.interpretation.custom.CustomInterpretation

Defined in [uproot.interpretation.custom](https://github.com/scikit-hep/uproot/blob/f1299d71fa4f435b1901386346c8a42adbd72642/src/uproot/interpretation/custom.py) on [line 21](https://github.com/scikit-hep/uproot/blob/f1299d71fa4f435b1901386346c8a42adbd72642/src/uproot/interpretation/custom.py#L21).

| **Inheritance order:**                                                                 |
|----------------------------------------------------------------------------------------|
| 1. [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md) |

### *class* uproot.interpretation.custom.CustomInterpretation(branch: [TBranch](uproot.behaviors.TBranch.TBranch.html.md#uproot.behaviors.TBranch.TBranch), context: dict, simplify: bool)

<a id="uproot-interpretation-custom-custominterpretation-match-branch"></a>

## match_branch

#### *classmethod* CustomInterpretation.match_branch(branch: [TBranch](uproot.behaviors.TBranch.TBranch.html.md#uproot.behaviors.TBranch.TBranch), context: dict, simplify: bool) → bool

* **Parameters:**
  * **branch** ([uproot.TBranch](uproot.behaviors.TBranch.TBranch.html.md)) – The `TBranch` to
    interpret as an array.
  * **context** (*dict*) – Auxiliary data used in deserialization.
  * **simplify** (*bool*) – If True, call
    [simplify](uproot.interpretation.objects.AsObjects.html.md#uproot-interpretation-objects-asobjects-simplify) on any
    [uproot.AsObjects](uproot.interpretation.objects.AsObjects.html.md) to try to get a
    more efficient interpretation.

Accept arguments from uproot.interpretation.identify.interpretation_of,
determine whether this interpretation can be applied to the given branch.

<a id="uproot-interpretation-custom-custominterpretation-cache-key"></a>

## cache_key

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.cache_key

The cache key of the interpretation.

<a id="uproot-interpretation-custom-custominterpretation-typename"></a>

## typename

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.typename

The name of the type of the interpretation.

<a id="uproot-interpretation-custom-custominterpretation-numpy-dtype"></a>

## numpy_dtype

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.numpy_dtype

The `numpy.dtype` to use to put objects of this type in a NumPy array.

<a id="uproot-interpretation-custom-custominterpretation-awkward-form"></a>

## awkward_form

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.awkward_form(file, context=None, index_format='i64', header=False, tobject_header=False, breadcrumbs=())

* **Parameters:**
  * **file** ([uproot.ReadOnlyFile](uproot.reading.ReadOnlyFile.html.md)) – File to use to generate
    [uproot.Model](uproot.model.Model.html.md) classes from its
    [streamers](uproot.reading.ReadOnlyFile.html.md#uproot-reading-readonlyfile-streamers) and `file_path`
    for error messages.
  * **context** (*dict*) – Context for the Form-generation; defaults are
    the remaining arguments below.
  * **index_format** (*str*) – Format to use for indexes of the
    `awkward.forms.Form`; may be `"i32"`, `"u32"`, or
    `"i64"`.
  * **header** (*bool*) – If True, include header fields of each C++ class.
  * **tobject_header** (*bool*) – If True, include header fields of each `TObject`
    base class.
  * **breadcrumbs** (*tuple* *of* *class objects*) – Used to check for recursion.
    Types that contain themselves cannot be Awkward Arrays because the
    depth of instances is unknown.

The `awkward.forms.Form` to use to put objects of type type in an
Awkward Array.

<a id="uproot-interpretation-custom-custominterpretation-basket-array"></a>

## basket_array

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.basket_array(data, byte_offsets, basket, branch, context, cursor_offset, library, interp_options)

* **Parameters:**
  * **data** (array of `numpy.uint8`) – Raw but uncompressed data from the
    `TBasket`. If the `TBasket` has offsets and navigational
    metadata, it is not included in this array.
  * **byte_offsets** (array of `numpy.int32`) – Index where each entry of
    the `TBasket` starts and stops. The header is not included
    (i.e. the first offset is `0`), and the length of this array
    is one greater than the number of entries in the `TBasket`.
  * **basket** ([uproot.models.TBasket.Model_TBasket](uproot.models.TBasket.Model_TBasket.html.md)) – The `TBasket` object.
  * **context** (*dict*) – Auxiliary data used in deserialization.
  * **cursor_offset** (*int*) – Correction to the integer keys used in
    [refs](uproot.source.cursor.Cursor.html.md#uproot-source-cursor-cursor-refs) for objects
    deserialized by reference
    ([uproot.deserialization.read_object_any](uproot.deserialization.read_object_any.html.md)).
  * **library** ([uproot.interpretation.library.Library](uproot.interpretation.library.Library.html.md)) – The
    requested library for output.
  * **interp_options** (*dict*) – Flags and other options passed through the
    interpretation process.

Performs the first step of interpretation, from uncompressed `TBasket`
data to a temporary array.

<a id="uproot-interpretation-custom-custominterpretation-final-array"></a>

## final_array

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.final_array(basket_arrays, entry_start, entry_stop, entry_offsets, library, branch, options)

Concatenate the arrays from the baskets and return the final array.

<a id="uproot-interpretation-custom-custominterpretation-hook-before-basket-array"></a>

## hook_before_basket_array

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.hook_before_basket_array(\*args, \*\*kwargs)

Called in [basket_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-basket-array),
before any interpretation.

This is the first hook called in
[basket_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-basket-array).

<a id="uproot-interpretation-custom-custominterpretation-hook-after-basket-array"></a>

## hook_after_basket_array

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.hook_after_basket_array(\*args, \*\*kwargs)

Called in [basket_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-basket-array),
after all interpretation.

This is the last hook called in
[basket_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-basket-array).

<a id="uproot-interpretation-custom-custominterpretation-hook-before-final-array"></a>

## hook_before_final_array

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.hook_before_final_array(\*args, \*\*kwargs)

Called in [final_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-final-array),
before any trimming, finalization, or grouping.

This is the first hook called in
[final_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-final-array).

<a id="uproot-interpretation-custom-custominterpretation-hook-before-library-finalize"></a>

## hook_before_library_finalize

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.hook_before_library_finalize(\*args, \*\*kwargs)

Called in [final_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-final-array),
after trimming but before calling the
[finalize](uproot.interpretation.library.Library.html.md#uproot-interpretation-library-library-finalize) routine.

<a id="uproot-interpretation-custom-custominterpretation-hook-after-final-array"></a>

## hook_after_final_array

Inherited from [uproot.interpretation.Interpretation](uproot.interpretation.Interpretation.html.md).

#### CustomInterpretation.hook_after_final_array(\*args, \*\*kwargs)

Called in [final_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-final-array),
after all trimming, finalization, and grouping.

This is the last hook called in
[final_array](uproot.interpretation.Interpretation.html.md#uproot-interpretation-interpretation-final-array).
