TextAxis¶

This is a Python binding to the C++ class Mantid::API::TextAxis.

bases: mantid.api.MantidAxis

class mantid.api.TextAxis¶

static create((int)length) → MantidAxis :¶

Creates a new TextAxis of a specified length

extractValues((MantidAxis)self) → object :¶

Return a numpy array of the axis values

getMax((MantidAxis)self) → float :¶

Get max value specified on the axis

getMin((MantidAxis)self) → float :¶

Get min value specified on the axis

getUnit((MantidAxis)self) → Unit :¶

Returns the unit object for the axis

getValue((MantidAxis)self, (int)index[, (int)vertical_index]) → float :¶

Returns the value at the given point on the Axis. The vertical axis index [default=0]

indexOfValue((MantidAxis)arg1, (float)arg2) → int :¶

Returns the index of the given value on the Axis.

indexOfValue( (MantidAxis)arg1, (float)value) -> int :

Returns the index of the closest to the given value on the axis

isNumeric((MantidAxis)self) → bool :¶

Returns true if this is a NumericAxis

isSpectra((MantidAxis)self) → bool :¶

Returns true if this is a SpectraAxis

isText((MantidAxis)self) → bool :¶

Returns true if this is a TextAxis

label((TextAxis)self, (int)index) → str :¶

Return the label at the given position

length((MantidAxis)self) → int :¶

Returns the length of the axis

setLabel((TextAxis)self, (int)index, (str)label) → None :¶

Set the label at the given entry

setUnit((MantidAxis)self, (str)unit_name) → Unit :¶

Set the unit for this axis by name.

setValue((MantidAxis)self, (int)index, (float)value) → None :¶

Set a value at the given index

title((MantidAxis)self) → str :¶

Get the axis title