S1S2Display Class Reference

A purely static class to manage S1/S2 display modes. More...

#include <XeCore.h>

Inheritance diagram for S1S2Display:

List of all members.

Static Public Member Functions
static bool	areCutsHatched ()
static bool	checkFull ()
static void	drawBox (double x0, double x1, double y0, double y1, int color, bool ratio=false)
	Draw a box in current frame (internal method).
static void	drawFrame (string title)
	Draw a frame (holder for objects to be drawn) with current limits.
static void	drawFrameZ (string title, double zmin, double zmax, int zScale=LINEAR)
	Draw a frame (holder for 3D objects to be drawn) with current limits in x & y.
static string	getCanvasName ()
static Flattener *	getCurrentFlattener ()
static int	getDefaultLogMode (int m=CURRENT_DISPLAY)
static int	getMode (int m=CURRENT_DISPLAY)
static string	getName ()
static string	getXLabel ()
static double	getXmax ()
static double	getXmin ()
static double	getY (double x, double y)
static string	getYLabel ()
static double	getYmax ()
static double	getYmin ()
static void	hatchTheCuts (bool h=true)
static bool	isFullyDefined ()
static bool	isModeDefined ()
static void	openCanvas (int nx=1, int ny=1, bool square=false)
	Open a canvas with default display mode name.
static bool	requiresComputation (int m=CURRENT_DISPLAY)
static void	setCurrentFlattener (Flattener *flatten)
static void	setLimits (double xmi, double xma, double ymi, double yma)
	Set the limits.
static void	setMode (int mode)
	Set the display mode.
static void	setNBands (int nb)
static void	setNSlices (int ns)
static void	setTheDefaultLimits ()
	Set the default limits.
static void	setXmax (double xma)
static void	setXmin (double xmi)
static void	setYmax (double yma)
static void	setYmin (double ymi)
static double	undoY (double x, double y)
Static Protected Attributes
static Flattener *	currentFlattener
static bool	cutsAreHatched
static int	displayMode
static int	nBands
static int	nSlices
static double	xmax
static double	xmin
static double	ymax
static double	ymin

---

Detailed Description

A purely static class to manage S1/S2 display modes.

---

Member Function Documentation

static void S1S2Display::drawBox	(	double	x0,
		double	x1,
		double	y0,
		double	y1,
		int	color,
		bool	ratio = false
	)			[static]

Draw a box in current frame (internal method).

Parameters:

	x0	lowest x corner of box
	x1	highest x corner of box
	y0	lowest y corner of box
	y1	highest y corner of box

static void S1S2Display::drawFrame

(

string

title

)

[static]

Draw a frame (holder for objects to be drawn) with current limits.

Parameters:

title

frame title

static void S1S2Display::drawFrameZ	(	string	title,
		double	zmin,
		double	zmax,
		int	zScale = LINEAR
	)			[static]

Draw a frame (holder for 3D objects to be drawn) with current limits in x & y.

Parameters:

	title	frame title
	zmin	lowest z scale
	zmax	highest z scale
	zScale	LINEAR or LOG

static void S1S2Display::openCanvas	(	int	nx = 1,
		int	ny = 1,
		bool	square = false
	)			[static]

Open a canvas with default display mode name.

Parameters:

	nx	divide it in nx columns of sub canvases
	ny	divide it in ny rows of subcanvas
	square	make it square

static void S1S2Display::setLimits	(	double	xmi,
		double	xma,
		double	ymi,
		double	yma
	)			[static]

Set the limits.

Parameters:

	xmi	Lowest X
	xma	Highest X
	ymi	Lowest Y
	yma	Highest Y

static void S1S2Display::setMode

(

int

mode

)

[static]

Set the display mode.

Parameters:

mode

S2_VS_S1, S2_OVER_S1_VS_S1, FLATTENED_S2_VS_S1 or BAND_VS_SLICE

---

The documentation for this class was generated from the following file:

• /home/lellouch/Dropbox/Xenon/Xephyr/XeCore.h