Libpiv API documentation

 Search for 

gpiv-post_utils.h File Reference

utilities for GpivScalarData and GpivBinData More...

Go to the source code of this file.

Functions
void	gpiv_null_scdata (GpivScalarData *scal_data)
GpivScalarData *	gpiv_alloc_scdata (const gint nx, const gint ny)
void	gpiv_free_scdata (GpivScalarData *scal_data)
gchar *	gpiv_scalar_gnuplot (const gchar *fname_out, const gchar *title, const gchar *GNUPLOT_DISPLAY_COLOR, const gint GNUPLOT_DISPLAY_SIZE)
void	gpiv_null_bindata (GpivBinData *bin_data)
GpivBinData *	gpiv_alloc_bindata (const guint nbins)
void	gpiv_free_bindata (GpivBinData *bin_data)
void	gpiv_histo (const GpivPivData *data, GpivBinData *klass)
void	gpiv_cumhisto (const GpivPivData *data, GpivBinData *klass)
gchar *	gpiv_histo_gnuplot (const gchar *fname_out, const gchar *title, const gchar *GNUPLOT_DISPLAY_COLOR, const gint GNUPLOT_DISPLAY_SIZE)

---

Detailed Description

utilities for GpivScalarData and GpivBinData

SOURCES: lib/post_utils.c

LAST MODIFICATION DATE:

Id

Definition in file gpiv-post_utils.h.

---

Function Documentation

GpivBinData* gpiv_alloc_bindata

(

const guint

nbins

)

Allocates memory for GpivBinData.

Parameters:

[in]

nbins

number of bins or klasses in GpivBinData

Returns:

GpivBinData on success or NULL on failure

GpivScalarData* gpiv_alloc_scdata	(	const gint	nx,
		const gint	ny
	)

Allocates memory for GpivScalarData.

Parameters:

[in]	nx	columns array length of GpivScalarData
[in]	ny	row array length of GpivScalarData structure

Returns:

GpivScalarData or NULL on failure

void gpiv_cumhisto	(	const GpivPivData *	data,
		GpivBinData *	klass
	)

Calculates cumulative histogram from GpivPivData (NOT from GpivScalarData!!).

Parameters:

[in]	data	Input data
[out]	klass	Output data

Returns:

void

void gpiv_free_bindata

(

GpivBinData *

bin_data

)

Frees memory for GpivBinData.

Parameters:

[in]	bin_data	data of bins
[out]	bin_data	NULL pointer to count, bound, centre

Returns:

void

void gpiv_free_scdata

(

GpivScalarData *

scal_data

)

Frees memory for GpivScalarData.

Parameters:

[in]	scal_data	scalar data structure
[out]	scal_data	NULL pointer to point_x, point_y, scalar, flag

Returns:

void

void gpiv_histo	(	const GpivPivData *	data,
		GpivBinData *	klass
	)

Calculates histogram from GpivPivData (NOT from GpivScalarData!!).

Parameters:

[in]	data	Input data
[out]	klass	Output data

Returns:

void

gchar* gpiv_histo_gnuplot	(	const gchar *	fname_out,
		const gchar *	title,
		const gchar *	GNUPLOT_DISPLAY_COLOR,
		const gint	GNUPLOT_DISPLAY_SIZE
	)

Plots histogram on screen with gnuplot.

Parameters:

[in]	fname_out	output filename
[in]	title	plot title
[in]	GNUPLOT_DISPLAY_COLOR	display color of window containing graph
[in]	GNUPLOT_DISPLAY_SIZE	display size of window containing graph

Returns:

NULL on success or error message on failure

void gpiv_null_bindata

(

GpivBinData *

bin_data

)

Sets all elements of bin_data structure to NULL.

Parameters:

[in]	bin_data	Input Bin data structure
[out]	bin_data	Output Bin data structure

Returns:

void

void gpiv_null_scdata

(

GpivScalarData *

scal_data

)

Sets all elements of sc_data structure to NULL.

Parameters:

[in]	scal_data	Input Scalar data structure
[out]	scal_data	Output Scalar data structure

Returns:

void

gchar* gpiv_scalar_gnuplot	(	const gchar *	fname_out,
		const gchar *	title,
		const gchar *	GNUPLOT_DISPLAY_COLOR,
		const gint	GNUPLOT_DISPLAY_SIZE
	)

Graphical output with gnuplot for scalar data.

Parameters:

[in]	fname_out	file name containing plot
[in]	title	title of plot
[in]	GNUPLOT_DISPLAY_COLOR	display color of window containing graph
[in]	GNUPLOT_DISPLAY_SIZE	display size of window containing graph

Returns:

NULL on success or error message on failure

---