cplot.h File Reference

---

Detailed Description

C functions for 2D plotting directly to a compressed bitmap.

Author:

Glenn D. MacGougan (GDM)

Date:

2008-04-18

Since:

2007-12-19

"LICENSE INFORMATION"
Copyright (c) 2007, refer to 'author' doxygen tags
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  
• The name(s) of the contributor(s) may not be used to endorse or promote products derived from this software without specific prior written permission.
  

THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file cplot.h.

Go to the source code of this file.

Data Structures
struct	CPLOT_structAxisSubOption
	A container struct used in CPLOT_structAxisOptions. More...
struct	CPLOT_structAxisOptions
	A container struct for axis options. More...
struct	CPLOT_structPlotOptions
	The user specified plot options. More...
struct	CPLOT_structImageSizeInPixels
	These are the dimensions of the plot part of the image in pixels. More...
struct	CPLOT_structAxes
	These are the coordinates in the image of parts of the axes. More...
struct	CPLOT_structStats
	A container for statistics information. More...
struct	CPLOT_structSeries
	The container for series data and user options. More...
struct	CPLOT_structRGB
	An RGB container. More...
struct	CPLOT_structInfoInDataUnits
	Internal information container. More...
struct	CPLOT_structColorTable
	The 22 color default color table! More...
struct	CPLOT_structByteMatrix
	A data container for holding the bitmap bytes. More...
struct	CPLOT
	The CPLOT C sytle object. More...
Enumerations
enum	CPLOT_enumColor
	These are the supported colors. More...
Functions
BOOL	CPLOT_PlotOptionsInit (CPLOT_structPlotOptions *Opt)
	Initialize the general plotting options.
BOOL	CPLOT_Init (CPLOT *P)
	Initialize the main CPLOT data container.
BOOL	CPLOT_SetPlotOptions (CPLOT *P, CPLOT_structPlotOptions *opt)
	Set all the general plotting options.
BOOL	CPLOT_Plot (CPLOT *P, CPLOT_structSeries *Series)
	Plot a data series. Call this function repeatedly for each data series.
BOOL	CPLOT_SaveToFile (CPLOT *P, const char *FileName)
	Once plotting is complete, save the bitmap to the file specified.

---

Enumeration Type Documentation

enum CPLOT_enumColor

These are the supported colors.

Definition at line 56 of file cplot.h.

---

Function Documentation

BOOL CPLOT_Init

(

CPLOT *

P

)

Initialize the main CPLOT data container.

Returns:

TRUE(1) if successful, FALSE(0) otherwise.

Definition at line 2889 of file cplot.c.

BOOL CPLOT_Plot	(	CPLOT *	P,
		CPLOT_structSeries *	Series
	)

Plot a data series. Call this function repeatedly for each data series.

Returns:

TRUE(1) if successful, FALSE(0) otherwise.

Definition at line 5688 of file cplot.c.

BOOL CPLOT_PlotOptionsInit

(

CPLOT_structPlotOptions *

Opt

)

Initialize the general plotting options.

Returns:

TRUE(1) if successful, FALSE(0) otherwise.

Definition at line 2874 of file cplot.c.

BOOL CPLOT_SaveToFile	(	CPLOT *	P,
		const char *	FileName
	)

Once plotting is complete, save the bitmap to the file specified.

Returns:

TRUE(1) if successful, FALSE(0) otherwise.

Definition at line 5350 of file cplot.c.

BOOL CPLOT_SetPlotOptions	(	CPLOT *	P,
		CPLOT_structPlotOptions *	opt
	)

Set all the general plotting options.

Returns:

TRUE(1) if successful, FALSE(0) otherwise.

Definition at line 5672 of file cplot.c.

---