cdms2.axis

axisMatchIndex(axes, specifications=None, omit=None, order=None)[source]

Match a list of axes following a specification or list of specificatons, and a specification or list of specifications of those axes to omit.

Parameters
specifications :
  • is None, include all axes less the omitted ones.

  • Individual specifications must be integer indices into axes or matching criteria as detailed in axisMatches.

omit :
  • is None, do not omit any axis.

  • Individual specifications must be integer indices into axes or matching criteria as detailed in axisMatches.

order :
  • A string containing the symbols t,x,y,z or -. If a - is given, any elements of the result not chosen otherwise are filled in from left to right with remaining candidates.

Returns
A list of axis’ indices which match the specification omitting any axes that matches an omit specification.
Axes are returned in the order they occur in the axes argument unless order is given.