histogrammar.primitives.irregularlybin.IrregularlyBin

class histogrammar.primitives.irregularlybin.IrregularlyBin(thresholds, quantity, value=<Count 0.0>, nanflow=<Count 0.0>)[source]

Bases: histogrammar.defs.Factory, histogrammar.defs.Container

Accumulate a suite of aggregators, each between two thresholds, filling exactly one per datum.

This is a variation on Stack, which fills N + 1 aggregators with N successively tighter cut thresholds. IrregularlyBin fills N + 1 aggregators in the non-overlapping intervals between N thresholds.

IrregularlyBin is also similar to CentrallyBin, in that they both partition a space into irregular subdomains with no gaps and no overlaps. However, CentrallyBin is defined by bin centers and IrregularlyBin is defined by bin edges, the first and last of which are at negative and positive infinity.

__add__(other)

Add two containers of the same type. The originals are unaffected.

__init__(thresholds, quantity, value=<Count 0.0>, nanflow=<Count 0.0>)

Create a IrregularlyBin that is capable of being filled and added.

Parameters:
  • thresholds (list of float) –
  • quantity (function returning float) – computes the quantity of interest from the data.
  • value (Container) – generates sub-aggregators for each bin.
  • nanflow (Container) – a sub-aggregator to use for data whose quantity is NaN.
Other Parameters:
 
  • entries (float) – the number of entries, initially 0.0.
  • bins (list of float, Container pairs) – the N + 1 thresholds and sub-aggregators. (The first threshold is minus infinity; the rest are the ones specified by thresholds).
children

List of sub-aggregators, to make it possible to walk the tree.

copy()

Copy this container, making a clone with no reference to the original.

static ed(entries, bins, nanflow)

Create a IrregularlyBin that is only capable of being added.

Parameters:
  • entries (float) – the number of entries.
  • bins (list of float, Container pairs) – the N + 1 thresholds and sub-aggregator pairs.
  • nanflow (Container) – the filled nanflow bin.
factory

Reference to the container’s factory for runtime reflection.

fill(datum, weight=1.0)

Increment the aggregator by providing one datum to the fill rule with a given weight.

Usually all containers in a collection of histograms take the same input data by passing it recursively through the tree. Quantities to plot are specified by the individual container’s lambda functions.

The container is changed in-place.

fromJson(json)

User’s entry point for reconstructing a container from JSON text.

static fromJsonFragment(json, nameFromParent)

staticmethod(function) -> method

Convert a function to be a static method.

A static method does not receive an implicit first argument. To declare a static method, use this idiom:

class C: def f(arg1, arg2, ...): ... f = staticmethod(f)

It can be called either on the class (e.g. C.f()) or on an instance (e.g. C().f()). The instance is ignored except for its class.

Static methods in Python are similar to those found in Java or C++. For a more advanced concept, see the classmethod builtin.

static ing(bins, quantity, value=<Count 0.0>, nanflow=<Count 0.0>)

Synonym for __init__.

name

Name of the concrete Factory as a string; used to label the container type in JSON.

plot(httpServer=None, **parameters)

Generate a VEGA visualization and serve it via HTTP.

register(factory)

Add a new Factory to the registry, introducing a new container type on the fly. General users usually wouldn’t do this, but they could. This method is used internally to define the standard container types.

specialize()

Explicitly invoke histogrammar.specialized.addImplicitMethods on this object, usually right after construction (in each of the methods that construct: __init__, ed, ing, fromJsonFragment, etc).

Objects used as default parameter arguments are created too early for this to be possible, since they are created before the histogrammar.specialized module can be defined. These objects wouldn’t satisfy any of addImplicitMethod‘s checks anyway.

thresholds

Cut thresholds (first items of bins).

toImmutable()

Return a copy of this container as though it was created by the ed function or from JSON (the “immutable form” in languages that support it, not Python).

toJson()

Convert this container to dicts and lists representing JSON (dropping its fill method).

Note that the dicts and lists can be turned into a string with json.dumps.

toJsonFragment(suppressName)

Used internally to convert the container to JSON without its "type" header.

values

Sub-aggregators (second items of bins).

zero()

Create an empty container with the same parameters as this one. The original is unaffected.