|
| WCCSAxisLabeller () |
| Constructor. More...
|
|
virtual | ~WCCSAxisLabeller () |
| Destructor. More...
|
|
virtual void | setCoordinateSystem (const DisplayCoordinateSystem &coordsys) |
| Install a DisplayCoordinateSystem. More...
|
|
virtual DisplayCoordinateSystem | coordinateSystem () const |
| Get the DisplayCoordinateSystem. More...
|
|
casacore::Bool | hasCoordinateSystem () const |
| Has a CS been set? More...
|
|
virtual void | setDefaultOptions () |
| install the default options for this labeller. More...
|
|
virtual casacore::Bool | setOptions (const casacore::Record &rec, casacore::Record &updatedOptions) |
| apply options stored in rec to the labeller; return value true means a refresh is needed. More...
|
|
virtual casacore::Record | getOptions () const |
| retrieve the current and default options and parameter types. More...
|
|
virtual casacore::String | xAxisText (WorldCanvas *wc) const |
| return the X and Y label text - over-ridden from base class More...
|
|
virtual casacore::String | yAxisText (WorldCanvas *wc) const |
|
virtual casacore::String | xAxisText () const |
|
virtual casacore::String | yAxisText () const |
|
virtual casacore::String | zLabelType () const |
|
virtual casacore::String | zLabelPos () const |
|
virtual void | setZIndex (casacore::Int zindex) |
|
virtual casacore::Int | uiBase () const |
| DD 'Absolute Pixel Coordinates', e.g. More...
|
|
virtual void | setUIBase (casacore::Int uibase) |
|
const casacore::String & | spectralunitStr () const |
|
casacore::Int | spectralprec () const |
|
| WCAxisLabeller () |
| Constructor. More...
|
|
virtual | ~WCAxisLabeller () |
| Destructor. More...
|
|
virtual casacore::Bool | draw (const WCRefreshEvent &ev)=0 |
| Draw axis labels for the provided WorldCanvas refresh event. More...
|
|
virtual void | invalidate () |
| Invalidate any cached drawings. More...
|
|
virtual casacore::Bool | setAxisLabelSwitch (const casacore::Bool labelswitch=false) |
| set/return whether labelling is on or off. More...
|
|
virtual casacore::Bool | axisLabelSwitch () const |
|
virtual void | setSubstituteTitleText (const casacore::String substituteImageName) |
| set/return the title text. More...
|
|
virtual casacore::String | titleText () const |
|
virtual casacore::String | displayedTitleText () const |
|
virtual casacore::Bool | setTitleTextColor (const casacore::String color=casacore::String("foreground")) |
| set/return the color of the title text. More...
|
|
virtual casacore::String | titleTextColor () const |
|
virtual casacore::Bool | setXAxisText (const casacore::String text=casacore::String("")) |
| set/return the X and Y label text. More...
|
|
virtual casacore::Bool | setYAxisText (const casacore::String text=casacore::String("")) |
|
virtual casacore::Bool | unsetXAxisText () |
|
virtual casacore::Bool | unsetYAxisText () |
|
virtual casacore::Bool | isXAxisTextUnset () const |
|
virtual casacore::Bool | isYAxisTextUnset () const |
|
virtual casacore::Bool | setXAxisTextColor (const casacore::String color=casacore::String("foreground")) |
| set/return the color of the label text. More...
|
|
virtual casacore::Bool | setYAxisTextColor (const casacore::String color=casacore::String("foreground")) |
|
virtual casacore::String | xAxisTextColor () const |
|
virtual casacore::String | yAxisTextColor () const |
|
virtual casacore::Bool | setXGridType (const casacore::String type=casacore::String("None")) |
| set/return what type of grid is marked in each direction. More...
|
|
virtual casacore::Bool | setYGridType (const casacore::String type=casacore::String("None")) |
|
virtual casacore::String | xGridType () const |
|
virtual casacore::String | yGridType () const |
|
virtual casacore::Bool | setXGridColor (const casacore::String color=casacore::String("foreground")) |
| set/return the color of the grid lines per direction. More...
|
|
virtual casacore::Bool | setYGridColor (const casacore::String color=casacore::String("foreground")) |
|
virtual casacore::String | xGridColor () const |
|
virtual casacore::String | yGridColor () const |
|
virtual casacore::Bool | setTickLength (const casacore::Float length=4.0) |
| set/return the tick length in millimetres. More...
|
|
virtual casacore::Float | tickLength () const |
|
virtual casacore::Bool | setLabelPosition (const casacore::String position=casacore::String("Auto")) |
| set/return the position of World label strings More...
|
|
virtual casacore::String | labelPosition () const |
|
virtual casacore::Bool | setPlotOutline (const casacore::Bool outline=true) |
| set/return whether there is a plot outline or not. More...
|
|
virtual casacore::Bool | plotOutline () const |
|
virtual casacore::Bool | setPlotOutlineColor (const casacore::String color=casacore::String("foreground")) |
| set/return the color used for the plot outline. More...
|
|
virtual casacore::String | plotOutlineColor () const |
|
virtual casacore::Bool | setCharSize (const casacore::Float size=1.2) |
| set/return the char size for the plot graphics More...
|
|
virtual casacore::Float | charSize () const |
|
virtual casacore::Bool | setCharFont (const casacore::String font="normal") |
| set/return the char font for the plot graphics More...
|
|
virtual casacore::String | charFont () const |
|
virtual casacore::Bool | setLineWidth (const casacore::Float width=0.0) |
| set/return the line width for the plot graphics. More...
|
|
virtual casacore::Float | lineWidth () const |
|
| DisplayOptions () |
| Constructor. More...
|
|
virtual | ~DisplayOptions () |
| Destructor. More...
|
|
template<class T > |
casacore::Bool | readOptionRecord (casacore::Vector< T > &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const |
| Find the field fieldname in casacore::Record rec , containing the requested type (casacore::Bool, casacore::String, casacore::Float, casacore::Int) in itself or its "value" sub-field, and return the value in target . More...
|
|
template<class T > |
casacore::Bool | readOptionRecord (T &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const |
|
virtual casacore::Bool | readOptionRecord (casacore::String &target, casacore::Bool &unsetTarget, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const |
| Find the field fieldname in casacore::Record rec , containing the requested type (casacore::String) in itself or its "value" sub-field, and return the value in target . More...
|
|
casacore::Record | unset () const |
| Return a casacore::Record which is an "unset" casacore::Record, ie. More...
|
|
casacore::Bool | isUnset (const casacore::Record &rec) const |
| Return true or false indicating if the provided casacore::Record is equal to an "unset" Record. More...
|
|
Base class for WorldCanvas axis labelling using a DisplayCoordinateSystem.
Synopsis
This (base) class adds to the interface of WCAxisLabeller functions which support the use/provision of a DisplayCoordinateSystem to assist with axis labelling.
Definition at line 47 of file WCCSAxisLabeller.h.
DD 'Absolute Pixel Coordinates', e.g.
channel numbers, are internally 0-based (they begin numbering at 0), but 'Absolute Pixel coordinates' have traditionally been displayed as 1-based in the glish viewer. uiBase_, and related methods uiBase() and setUIBase(), allow newer (python/Qt-based) code to cause such labelling to be produced with 0-based values instead. Unless setUIBase(0) is called, the traditional 1-based labelling behavior is retained by default.
If you are using 0-basing for 'Absolute Pixel casacore::Coordinate' labelling, you should call setUIBase(0), before using draw().
Definition at line 141 of file WCCSAxisLabeller.h.
References uiBase_.