API Reference for Enthought Tool Suite 3.0.1

Variables

• CubeTrait

  An 3D array of numbers of shape (Nx, Ny, Nz)

  CubeTrait = Trait(None, None, CArray(value = empty(0)))
  
  

• DimensionTrait

  This enumeration lists the fundamental mathematical coordinate types that Chaco supports.

  DimensionTrait = Enum('scalar', 'point', 'image', 'cube')
  
  

• ImageTrait

  An NxM array of numbers.

  ImageTrait = Trait(None, None, CArray(value = empty(0)))
  
  

• NumericalSequenceTrait

  A single array of numbers.

  NumericalSequenceTrait = Trait(None, None, CArray(value = empty(0)))
  
  

• PointTrait

  A sequence of pairs of numbers, i.e., an Nx2 array.

  PointTrait = Trait(None, None, CArray(value = empty(0)))
  
  

• SortOrderTrait

  Linear sort order.

  SortOrderTrait = Enum('ascending', 'descending', 'none')
  
  

Function summary

• arg_find_runs(int_array, order = 'ascending')
• bin_search(values, value, ascending)
• find_runs(int_array, order = 'ascending')
• left_shift(ary, newval)
• n_gon(center, r, nsides, rot_degrees = 0)
• point_line_distance(pt, p1, p2)
• poly_point(center, r, degrees)
• reverse_map_1d(data, pt, sort_order, floor_only = False)
• right_shift(ary, newval)
• sort_points(points, index = 0)

Functions

• arg_find_runs(int_array, order = 'ascending')

  Like find_runs(), but returns a list of tuples indicating the start and end indices of runs in the input int_array.

• bin_search(values, value, ascending)

  Performs a binary search of a sorted array looking for a specified value.

  Returns the lowest position where the value can be found or where the array value is the last value less (greater) than the desired value. Returns -1 if value is beyond the minimum or maximum of values.

• find_runs(int_array, order = 'ascending')

  find_runs(int_array, order=<'ascending'|'flat'|'descending'>) -> list_of_int_arrays

  Given an integer array sorted in ascending/descending order or flat order, returns a list of continuous runs of integers inside the list. for example:

  find_runs([1,2,3,6,7,8,9,10,11,15])
  

  returns [ [1,2,3], [6,7,8,9,10,11], [15] ] and:

  find_runs([0,0,0,1,1,1,1,0,0,0,0], "flat")
  

  return [ [0,0,0], [1,1,1,1], [0,0,0,0] ]

• left_shift(ary, newval)

  Returns a left-shifted version of ary with newval inserted on the right.

• n_gon(center, r, nsides, rot_degrees = 0)

  Generates the points of a regular polygon with specified center, radius, and number of sides.

  By default the rightmost point of the polygon is (r,0) but a rotation about the center may be specified with rot_degrees.

• point_line_distance(pt, p1, p2)

  Returns the perpendicular distance between pt and the line segment between the points p1 and p2.

• poly_point(center, r, degrees)
• reverse_map_1d(data, pt, sort_order, floor_only = False)

  Returns the index of pt in the array data.

  Parameters

  data : 1-D array

  data to search

  pt : scalar value

  value to find, which must be within the value range of data

  sort_order : string

  "ascending" or "descending"

  floor_only : bool

  if true, don't find "nearest" point, instead find last point less (greater) than pt

  Raises IndexError if pt is outside the range of values in data.

• right_shift(ary, newval)

  Returns a right-shifted version of ary with newval inserted on the left.

• sort_points(points, index = 0)

  sort_points(array_of_points, index=<0|1>) -> sorted_array

  Takes a list of points as an Nx2 array and sorts them according to their x- or y-coordinate. If index is zero, the points are sorted on their x-coordinate.

Imported Names

© Copyright 2002-2008 Enthought, Inc.