API Reference for Enthought Tool Suite 3.0.1

Classes

• AbstractTickGenerator - Abstract class for tick generators.
• DefaultTickGenerator - An implementation of AbstractTickGenerator that simply uses the auto_ticks() and log_auto_ticks() functions.
• ShowAllTickGenerator - Uses the abstract interface, but returns all "positions" instead of decimating the ticks

Function summary

• auto_bounds(data_low, data_high, tick_interval)
• auto_interval(data_low, data_high)
• auto_ticks(data_low, data_high, bound_low, bound_high, tick_interval, use_endpoints = True)
• calc_bound(end_point, tick_interval, is_upper)
• heckbert_interval(data_low, data_high, numticks = 8)
• is_base2(range)
• log2(num)
• log_auto_ticks(data_low, data_high, bound_low, bound_high, tick_interval, use_endpoints = True)
• tick_intervals(data_low, data_high, intervals)

Functions

• auto_bounds(data_low, data_high, tick_interval)

  Calculates appropriate upper and lower bounds for the axis from the data bounds and the given axis interval.

  The boundaries hit either exactly on the lower and upper values or on the tick mark just beyond the lower and upper values.

• auto_interval(data_low, data_high)

  Calculates the tick interval for a range.

  The boundaries for the data to be plotted on the axis are:

  data_bounds = (data_low,data_high)
  

  The function chooses the number of tick marks, which can be between 3 and 9 marks (including end points), and chooses tick intervals at 1, 2, 2.5, 5, 10, 20, ...

  Returns

  interval : float

  tick mark interval for axis

• auto_ticks(data_low, data_high, bound_low, bound_high, tick_interval, use_endpoints = True)

  Finds locations for axis tick marks.

  Calculates the locations for tick marks on an axis. The bound_low, bound_high, and tick_interval parameters specify how the axis end points and tick interval are calculated.

  Parameters

  data_low, data_high : number

  The minimum and maximum values of the data along this axis. If any of the bound settings are 'auto' or 'fit', the axis traits are calculated automatically from these values.

  bound_low, bound_high : 'auto', 'fit', or a number.

  The lower and upper bounds of the axis. If the value is a number, that value is used for the corresponding end point. If the value is 'auto', then the end point is calculated automatically. If the value is 'fit', then the axis bound is set to the corresponding data_low or data_high value.

  tick_interval : can be 'auto' or a number

  If the value is a positive number, it specifies the length of the tick interval; a negative integer specifies the number of tick intervals; 'auto' specifies that the number and length of the tick intervals are automatically calculated, based on the range of the axis.

  use_endpoints : Boolean

  If True, the lower and upper bounds of the data are used as the lower and upper end points of the axis. If False, the end points might not fall exactly on the bounds.

  Returns

  An array of tick mark locations. The first and last tick entries are the axis end points.

• calc_bound(end_point, tick_interval, is_upper)

  Finds an axis end point that includes the value end_point.

  If the tick mark interval results in a tick mark hitting directly on the end point, end_point is returned. Otherwise, the location of the tick mark just past end_point is returned. The is_upper parameter specifies whether end_point is at the upper (True) or lower (False) end of the axis.

• heckbert_interval(data_low, data_high, numticks = 8)

  Returns a "nice" range and interval for a given data range and a preferred number of ticks. From Paul Heckbert's algorithm in Graphics Gems.

• is_base2(range)

  Returns True if range is a positive base-2 number (2, 4, 8, 16, ...).

• log2(num)

  Returns the base 2 logarithm of a number (or array).

• log_auto_ticks(data_low, data_high, bound_low, bound_high, tick_interval, use_endpoints = True)

  Like auto_ticks(), but for log scales.

• tick_intervals(data_low, data_high, intervals)

  Computes the best tick interval length to achieve a specified number of tick intervals.

  Parameters

  data_low, data_high : number

  The minimum and maximum values of the data along this axis. If any of the bound settings are 'auto' or 'fit', the axis traits are calculated automatically from these values.

  intervals : number

  The desired number of intervals

  Returns

  Returns a float indicating the tick interval length.

Imported Names

© Copyright 2002-2008 Enthought, Inc.