larray.AxisCollection

class larray.AxisCollection(axes=None)[source]
__init__(axes=None)[source]

Methods

__init__([axes])

align(other[, join, axes])

Align this axis collection with another.

append(axis)

Append axis at the end of the collection.

axis_id(axis)

Return the id of an axis.

check_compatible(axes)

Check if axes passed as argument are compatible with those contained in the collection.

combine_axes([axes, sep, wildcard, ...])

Combine several axes into one.

copy()

Return a copy.

extend(axes[, validate, replace_wildcards])

Extend the collection by appending the axes from axes.

get(key[, default, name])

Return axis corresponding to key.

get_all(key)

Return all axes from key if present and length 1 wildcard axes otherwise.

get_by_pos(key, i)

Return axis corresponding to a key, or to position i if the key has no name and key object not found.

index(axis[, compatible])

Return the index of axis.

insert(index, axis)

Insert axis before index.

isaxis(value)

Test if input is an Axis object or the name of an axis contained in self.

iter_labels([axes, ascending])

Return a view of the axes labels.

keys()

Return list of all axis names.

pop([axis])

Remove and return an axis.

rename([renames, to])

Rename axes of the collection.

replace([axes_to_replace, new_axis, inplace])

Replace one, several or all axes of the collection.

set_labels([axis, labels, inplace])

Replace the labels of one or several axes.

split_axes([axes, sep, names, regex])

Split axes and returns a new collection.

split_axis(**kwargs)

union(*args[, validate, replace_wildcards])

without(axes)

Return a new collection without some axes.

Attributes

display_names

Return the list of (display) names of the axes.

ids

Return the list of ids of the axes.

info

Describe the collection (shape and labels for each axis).

labels

Return the list of labels of the axes.

names

Return the list of (raw) names of the axes.

ndim

shape

Return the shape of the collection.

size

Return the size of the collection, i.e. the number of elements of the array.