Range Histogram

Calculates a histogram over a defined percentile range for a data map.

Written By: Matthew Stadelman

Date Written: 2016/03/07

Last Modifed: 2016/10/25

class apmapflow.data_processing.histogram_range.HistogramRange(field, **kwargs)

Performs a histogram where the minimum and maximum bin limits are set by percentiles and all values outside of that range are excluded. The interior values are handled the same as a basic histogram with bin sizes evenly spaced between the min and max percentiles given.

kwargs include:

num_bins - integer value for the total number of bins range - list with two numeric values to define the minimum and maximum

data percentiles.

__delattr__

Implement delattr(self, name).

__dir__() → list

default dir() implementation

__eq__

Return self==value.

__format__()

default object formatter

__ge__

Return self>=value.

__getattribute__

Return getattr(self, name).

__gt__

Return self>value.

__hash__

Return hash(self).

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__

Return repr(self).

__setattr__

Implement setattr(self, name, value).

__sizeof__() → int

size of object in memory, in bytes

__str__

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

classmethod _add_subparser(subparsers, parent)

Adds a specific action based sub-parser to the supplied arg_parser instance.

_output_data(filename=None, delim=', ')

Creates the output content for histograms

_process_data(preserve_bins=False)

Calculates a histogram from a range of data. This uses the 1st and 99th percentiles as limits when defining bins

copy_processed_data(data_dict, alt_key=False)

Copys the current processed data array to a dict object using a key defined in the subclass initialization or a key supplied by the alt_key keyword.

define_bins(**kwargs)

This defines the bins for a range histogram

gen_output(**kwargs)

Calls the subclassed routine output_data to create outfile content

print_data()

Writes the data processor’s data the screen

process(**kwargs)

Calls the subclassed routine process_data to create outfile content

setup(**kwargs)

Sets or resets arguments

write_data(path='/home/docs/checkouts/readthedocs.org/user_builds/netl-ap-map-flow/checkouts/latest/docs')

Writes the data processor’s data to its outfile