Collaboration diagram for Tool DEPRECATED: Functions, Enums, Classes for JKQTFastPlotter:

Macros
#define	JKQTFASTPLOTTER_LIB_EXPORT

#define	JKQTFASTPLOTTER_LIB_EXPORT_LIBRARY
	is only defined while compiling JKQTFastPlotter into `JKQTFastPlotterSharedLib_XYZ` and ensures thet the symbols are exported. If it is not defined (e.g. while compiling an application), the symbols are imported

#define	JKQTFASTPLOTTER_LIB_IN_DLL
	declares that the application should link against a shared version of JKQTFastPlotter, i.e. `JKQTFastPlotterSharedLib_XYZ` . This needs to be defined while compiling the library and while compiling any application linking against `JKQTFastPlotterSharedLib_XYZ`.

Enumerations
enum	JKQTFPColorPalette { JKQTFP_RED =0 , JKQTFP_INVERTEDRED =1 , JKQTFP_GREEN =2 , JKQTFP_INVERTEDGREEN =3 , JKQTFP_BLUE =4 , JKQTFP_INVERTEDBLUE =5 , JKQTFP_GRAY =6 , JKQTFP_INVERTEDGRAY =7 , JKQTFP_MATLAB =8 , JKQTFP_RYGB =9 , JKQTFP_HSV =10 , JKQTFP_INVERTED_HSV =11 , JKQTFP_RAINBOW =12 , JKQTFP_HOT =13 , JKQTFP_OCEAN =14 , JKQTFP_TRAFFICLIGHT =15 , JKQTFP_BLUEMAGENTAYELLOW =16 , JKQTFP_BLUEYELLOW =17 , JKQTFP_CYAN =18 }
	An enum for selecting the palette for coloring. More...

enum	JKQTFPImageFormat { JKQTFP_uint8 =0 , JKQTFP_uint16 =1 , JKQTFP_uint32 =2 , JKQTFP_float =3 , JKQTFP_double =4 , JKQTFP_int64 =5 }
	datatype for an image plotpalette for coloring More...

Functions
template<class T >
void	JKQTFPimagePlot_array2image (T *dbl, int width, int height, QImage &img, JKQTFPColorPalette palette, double minColor, double maxColor)
	convert a 2D image (as 1D array) into a QImage with given palette (see JKQTFPColorPalette)

JKQTFASTPLOTTER_LIB_EXPORT QIcon	JKQTFPimagePlot_getPaletteIcon (int i)
	get QIcon representing the given palette

JKQTFASTPLOTTER_LIB_EXPORT QIcon	JKQTFPimagePlot_getPaletteIcon (JKQTFPColorPalette palette)
	get QIcon representing the given palette

JKQTFASTPLOTTER_LIB_EXPORT QStringList	JKQTFPimagePlot_getPalettes ()
	get list with all available palettes

template<class T >
void	JKQTFPRGBImageOverlayPlot_array2image (T *dbl, int width, int height, QImage &img, int channel, double minColor_, double maxColor_)
	convert a 2D image (as 1D array) into a QImage and puts the image values into one color channel (set by channel).

Detailed Description

Deprecated:: The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

Macro Definition Documentation

◆ JKQTFASTPLOTTER_LIB_EXPORT

#define JKQTFASTPLOTTER_LIB_EXPORT

This define allows to export functions and classes from the jkqtcommon-library when building a dynamic/shared library. Usage is as follows:

#include "jkqtfastplotter/jkqtfastplotter_imexport.h"
 
class JKQTFASTPLOTTER_LIB_EXPORT exportedClassName {
   ...
};
 
JKQTFASTPLOTTER_LIB_EXPORT void exportedFunctionName();

These macros append the appropriate Q_DECL_EXPORT and Q_DECL_IMPORT to the function/class body and thus tell windows compilers to export these sysmbols from the shared library, or import them from a shared library.

Note that these attributes are only necessary on windows systems!

These macros are controlled by two other macros:

JKQTFASTPLOTTER_LIB_IN_DLL declares that the application should link against a shared version of JKQTFastPlotter, i.e. JKQTFastPlotterSharedLib_XYZ . This needs to be defined while compiling the library and while compiling any application linking against JKQTFastPlotterSharedLib_XYZ.
JKQTFASTPLOTTER_LIB_EXPORT_LIBRARY is only defined while compiling JKQTFastPlotter into JKQTFastPlotterSharedLib_XYZ and ensures thet the symbols are exported. If it is not defined (e.g. while compiling an application), the symbols are imported .

◆ JKQTFASTPLOTTER_LIB_EXPORT_LIBRARY

#define JKQTFASTPLOTTER_LIB_EXPORT_LIBRARY

is only defined while compiling JKQTFastPlotter into JKQTFastPlotterSharedLib_XYZ and ensures thet the symbols are exported. If it is not defined (e.g. while compiling an application), the symbols are imported

◆ JKQTFASTPLOTTER_LIB_IN_DLL

#define JKQTFASTPLOTTER_LIB_IN_DLL

declares that the application should link against a shared version of JKQTFastPlotter, i.e. JKQTFastPlotterSharedLib_XYZ . This needs to be defined while compiling the library and while compiling any application linking against JKQTFastPlotterSharedLib_XYZ.

Enumeration Type Documentation

◆ JKQTFPColorPalette

enum JKQTFPColorPalette

An enum for selecting the palette for coloring.

Deprecated:: The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

Here, the color palettes are illustrated (left is the color for the minimum and right for the maximum).

Enumerator
JKQTFP_RED
JKQTFP_INVERTEDRED
JKQTFP_GREEN
JKQTFP_INVERTEDGREEN
JKQTFP_BLUE
JKQTFP_INVERTEDBLUE
JKQTFP_GRAY
JKQTFP_INVERTEDGRAY
JKQTFP_MATLAB
JKQTFP_RYGB
JKQTFP_HSV
JKQTFP_INVERTED_HSV
JKQTFP_RAINBOW
JKQTFP_HOT
JKQTFP_OCEAN
JKQTFP_TRAFFICLIGHT
JKQTFP_BLUEMAGENTAYELLOW
JKQTFP_BLUEYELLOW
JKQTFP_CYAN

◆ JKQTFPImageFormat

enum JKQTFPImageFormat

datatype for an image plotpalette for coloring

Deprecated:: The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

Here, the color palettes are illustrated (left is the color for the minimum and right for the maximum).

Enumerator
JKQTFP_uint8	8 bit int
JKQTFP_uint16	16 bit int
JKQTFP_uint32	32 bit int
JKQTFP_float	float
JKQTFP_double	double
JKQTFP_int64	64 bit signed int

Function Documentation

◆ JKQTFPimagePlot_array2image()

template<class T >

void JKQTFPimagePlot_array2image	(	T *	dbl,
		int	width,
		int	height,
		QImage &	img,
		JKQTFPColorPalette	palette,
		double	minColor,
		double	maxColor
	)

inline

convert a 2D image (as 1D array) into a QImage with given palette (see JKQTFPColorPalette)

Deprecated:: The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

This method uses lookup tables which are saved as static variables to convert the 2D array into an image. The luts are only created once, and stored then, so mor CPU time is saved. The precompiler define JKQTFastPlotter::LUTSIZE sets the size of the LUTs. Note that if you don't use a specific color palette, the according LUT won't be calculated and stored!

◆ JKQTFPimagePlot_getPaletteIcon() [1/2]

JKQTFASTPLOTTER_LIB_EXPORT QIcon JKQTFPimagePlot_getPaletteIcon ( int i )

get QIcon representing the given palette

See also: JKQTFPimagePlot_array2image()

Deprecated:: The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

◆ JKQTFPimagePlot_getPaletteIcon() [2/2]

JKQTFASTPLOTTER_LIB_EXPORT QIcon JKQTFPimagePlot_getPaletteIcon ( JKQTFPColorPalette palette )

get QIcon representing the given palette

Deprecated:: The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

See also: JKQTFPimagePlot_array2image()

◆ JKQTFPimagePlot_getPalettes()

JKQTFASTPLOTTER_LIB_EXPORT QStringList JKQTFPimagePlot_getPalettes ( )

get list with all available palettes

See also: JKQTFPimagePlot_array2image()

Deprecated:: The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

◆ JKQTFPRGBImageOverlayPlot_array2image()