PointAxis

class sherpa.models.regrid.PointAxis(x)[source] [edit on github]

Bases: Axis

Represent a point (not integrated) axis of a N-D object.

The length can not be changed once set.

Parameters:

x (array_like or None) – The starting point of the axis. If None or [] then the data axis is said to be empty. The axis can be in ascending or descending order but this is not checked.

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.

x

Methods Summary

overlaps(other)

Check if this axis overlaps with another.

Attributes Documentation

end
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
size
start
x

Methods Documentation

overlaps(other) [edit on github]

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