IntegratedAxis

class sherpa.models.regrid.IntegratedAxis(lo, hi)[source] [edit on github]

Bases: Axis

Represent an integrated axis of a N-D object.

Parameters:

loarray_like or None: The starting point of the axis. If lo is None or [] then the data axis is said to be empty. The axis can be in ascending or descending order.
hiarray_like or None: The ending point of the axis. The number of elements must match lo (either None or a sequence of the same size). Each element is expected to be larger than the corresponding element of the lo axis, even if the lo array is in descending order.

Attributes:

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

Methods

overlaps(other)

Check if this axis overlaps with another.

Attributes Summary

`end`	The ending point of the data axis
`hi`
`is_ascending`	Is the axis ascending?
`is_empty`	Is the axis empty?
`is_integrated`	Is the axis integrated?
`lo`
`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

hi

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

lo

size

start

Methods Documentation

overlaps(other) [edit on github]

Check if this axis overlaps with another.

Parameters:

otherAxis instance: The axis to compare to.

Returns:

bool: True if they overlap, False if not