Axis

class sherpa.models.regrid.Axis

Bases: object

Represent an axis of a N-D object.

Attributes Summary

end	The ending point of the data axis
is_ascending	Is the axis ascending?
is_empty	Is the axis empty?
is_integrated	Is the axis integrated?
size	The size of the axis.
start	The starting point (lowest value) of the data axis.

Methods Summary

overlaps(other)

Check if this axis overlaps with another.

Attributes Documentation

end

The ending point of the data axis

If the data axis is ascending the end boundary is the last element of the hi array when the axis is integrated, otherwise it’s the last element of lo. Conversely, for descending axes, the last element is either the first element of the hi array or of the lo array, depending on whether the axis is integrated or not, respectively.

is_ascending

Is the axis ascending?

The axis is ascending if the elements in lo are sorted in ascending order. Only the first and last elements are checked, and it is assumed that the elements are sorted.

is_empty

Is the axis empty?

An empty axis is either set to None or a zero-element sequence.

is_integrated

Is the axis integrated?

size

The size of the axis.

start

The starting point (lowest value) of the data axis.

Methods Documentation

overlaps(other)

Check if this axis overlaps with another.

Parameters:

other (Axis instance) – The axis to compare to.

Returns:

True if they overlap, False if not

Return type:

bool