API Reference for Enthought Tool Suite 3.0.1

Classes

• DataRange1D - Represents a 1-D data range.

Function summary

• calc_bounds(low_set, high_set, mins, maxes, epsilon, tight_bounds, margin = 0.080000000000000002, track_amount = 0, bounds_func = None)

Functions

• calc_bounds(low_set, high_set, mins, maxes, epsilon, tight_bounds, margin = 0.080000000000000002, track_amount = 0, bounds_func = None)

  Calculates bounds for a given 1-D set of data.

  Parameters

  low_set : 'auto', 'track', or number

  Current low setting

  high_set : 'auto', 'track', or number

  Current high setting

  mins : list of numbers

  Potential minima.

  maxes : list

  Potential maxima.

  epsilon : number

  Minimum percentage difference between bounds

  tight_bounds : Boolean

  Do 'auto' bounds imply an exact fit to the data? If False, they pad a little bit of margin on either side.

  margin : float (default=0.08)

  The margin, expressed as a percentage of total data width, to place on either side of the data if tight_bounds is False.

  track_amount : number

  The amount by which a 'track' bound tracks another bound.

  bounds_func : Callable

  A callable which can override the bounds calculation.

  Returns

  (min, max) for the new bounds. If either of the calculated bounds is NaN, returns (0,0).

  Description

  Setting both low_set and high_set to 'track' is an invalid state; the method copes by setting high_set to 'auto', and proceeding.

Imported Names

© Copyright 2002-2008 Enthought, Inc.