ajhist.c

Datatypes: none AjPHist

Datatype: none

Histogram internals

Sections: modifiers

Section: modifiers

Controlling the internals

Functions: ajHistogramClose ajHistogramSetMark

Synopsis

Prototype

void ajHistogramClose (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
void		RETURN

Returns

void:

No return value

Description

Closes the histograms window.

Availability

In release 6.4.0

Synopsis

Prototype

void ajHistogramSetMark (
      ajint mark
);

Type Name Read/Write Description

ajint mark Input Mark value

void RETURN

Type	Name	Read/Write	Description
ajint	mark	Input	Mark value
void		RETURN

Input

mark:

(Input)

Mark value

Returns

void:

No return value

Description

Set the histogram mark internal value

Availability

In release 6.4.0

Datatype: AjPHist

Histogram object

Sections: Constructors Destructors Display modifiers Histogram data management

Section: Constructors

Construct a new histogram object to be populated by other functions

Functions: ajHistNew ajHistNewG

Function ajHistNew

Create a histogram Object. Which can hold "numofsets" set of data of which all must have "numofpoints" data points in them.

Synopsis

Prototype

AjPHist ajHistNew (
      ajuint numofsets,
      ajuint numofpoints
);

Type Name Read/Write Description

ajuint numofsets Input Number of sets of data.

ajuint numofpoints Input Number of data points per set.

AjPHist RETURN histogram structure.

Type	Name	Read/Write	Description
ajuint	numofsets	Input	Number of sets of data.
ajuint	numofpoints	Input	Number of data points per set.
AjPHist		RETURN	histogram structure.

Input

numofsets:	(Input)	Number of sets of data.
numofpoints:	(Input)	Number of data points per set.

Returns

AjPHist:

histogram structure.

Description

Create a histogram Object. Which can hold "numofsets" set of data of which all must have "numofpoints" data points in them.

Availability

In release 6.4.0

Function ajHistNewG

Create a histogram Object which has the histogram data and graph data storage capacity.

Synopsis

Prototype

AjPHist ajHistNewG (
      ajuint numofsets,
      ajuint numofpoints,
      AjPGraph graph
);

Type Name Read/Write Description

ajuint numofsets Input Number of sets of data.

ajuint numofpoints Input Number of data points per set.

AjPGraph graph Modify Graph object, device, multi and name are set. The original AjPGraph object will be used by the AjPHist

AjPHist RETURN histogram structure.

Type	Name	Read/Write	Description
ajuint	numofsets	Input	Number of sets of data.
ajuint	numofpoints	Input	Number of data points per set.
AjPGraph	graph	Modify	Graph object, device, multi and name are set. The original AjPGraph object will be used by the AjPHist
AjPHist		RETURN	histogram structure.

Input

numofsets:	(Input)	Number of sets of data.
numofpoints:	(Input)	Number of data points per set.

Input & Output

graph:

(Modify)

Graph object, device, multi and name are set. The original AjPGraph object will be used by the AjPHist

Returns

AjPHist:

histogram structure.

Description

Create a histogram Object which has the histogram data and graph data storage capacity.

Availability

In release 6.4.0

Section: Destructors

Destructors for histogram objects

Functions: ajHistDel

Function ajHistDel

Delete and free all memory associated with the histogram. Does not delete the graph.

Synopsis

Prototype

void ajHistDel (
      AjPHist* phist
);

Type Name Read/Write Description

AjPHist* phist Delete Histogram to be deleted.

void RETURN

Type	Name	Read/Write	Description
AjPHist*	phist	Delete	Histogram to be deleted.
void		RETURN

Output

phist:

(Delete)

Histogram to be deleted.

Returns

void:

No return value

Description

Delete and free all memory associated with the histogram. Does not delete the graph.

Availability

In release 6.4.0

Section: Display

Functions to display or write the histogram

Functions: ajHistDisplay

Function ajHistDisplay

Display the histogram.

Synopsis

Prototype

void ajHistDisplay (
      const AjPHist thys
);

Type Name Read/Write Description

const AjPHist thys Input Histogram Structure.

void RETURN

Type	Name	Read/Write	Description
const AjPHist	thys	Input	Histogram Structure.
void		RETURN

Input

thys:

(Input)

Histogram Structure.

Returns

void:

No return value

Description

Display the histogram.

Availability

In release 6.4.0

Section: modifiers

Controlling the internals

Functions: ajHistSetMono ajHistSetRlabelC ajHistSetTitleC ajHistSetXlabelC ajHistSetYlabelC ajHistSetmultiColour ajHistSetmultiPattern ajHistSetmultiTitleC ajHistSetmultiTitleS ajHistSetmultiXlabelC ajHistSetmultiXlabelS ajHistSetmultiYlabelC ajHistSetmultiYlabelS

Function ajHistSetMono

Set patterns instead of colours for printing to B/W printers etc.

Synopsis

Prototype

void ajHistSetMono (
      AjPHist thys,
      AjBool set
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

AjBool set Input Set to use patterns or colour for filling, false to reset to colour.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	Histogram to have ptr set.
AjBool	set	Input	Set to use patterns or colour for filling, false to reset to colour.
void		RETURN

Input

set:

(Input)

Set to use patterns or colour for filling, false to reset to colour.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Set patterns instead of colours for printing to B/W printers etc.

Availability

In release 6.4.0

Function ajHistSetRlabelC

Store Y Axis Right Label for the histogram

Synopsis

Prototype

void ajHistSetRlabelC (
      AjPHist thys,
      const char* txt
);

Type Name Read/Write Description

AjPHist thys Modify histogram to set string in.

const char* txt Input text to be copied.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	histogram to set string in.
const char*	txt	Input	text to be copied.
void		RETURN

Input

txt:

(Input)

text to be copied.

Input & Output

thys:

(Modify)

histogram to set string in.

Returns

void:

No return value

Description

Store Y Axis Right Label for the histogram

Availability

In release 6.4.0

Function ajHistSetTitleC

Copy Title for the histogram.

Synopsis

Prototype

void ajHistSetTitleC (
      AjPHist thys,
      const char* txt
);

Type Name Read/Write Description

AjPHist thys Modify histogram to set string in.

const char* txt Input text to be copied.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	histogram to set string in.
const char*	txt	Input	text to be copied.
void		RETURN

Input

txt:

(Input)

text to be copied.

Input & Output

thys:

(Modify)

histogram to set string in.

Returns

void:

No return value

Description

Copy Title for the histogram.

Availability

In release 6.4.0

Function ajHistSetXlabelC

Store X axis label for the histogram

Synopsis

Prototype

void ajHistSetXlabelC (
      AjPHist thys,
      const char* txt
);

Type Name Read/Write Description

AjPHist thys Modify histogram to set string in.

const char* txt Input text to be copied.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	histogram to set string in.
const char*	txt	Input	text to be copied.
void		RETURN

Input

txt:

(Input)

text to be copied.

Input & Output

thys:

(Modify)

histogram to set string in.

Returns

void:

No return value

Description

Store X axis label for the histogram

Availability

In release 6.4.0

Function ajHistSetYlabelC

Store Y Axis Left Label for the histogram

Synopsis

Prototype

void ajHistSetYlabelC (
      AjPHist thys,
      const char* txt
);

Type Name Read/Write Description

AjPHist thys Modify histogram to set string in.

const char* txt Input text to be copied.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	histogram to set string in.
const char*	txt	Input	text to be copied.
void		RETURN

Input

txt:

(Input)

text to be copied.

Input & Output

thys:

(Modify)

histogram to set string in.

Returns

void:

No return value

Description

Store Y Axis Left Label for the histogram

Availability

In release 6.4.0

Function ajHistSetmultiColour

Set colour for bars in histogram for index'th set.

Synopsis

Prototype

void ajHistSetmultiColour (
      AjPHist thys,
      ajuint indexnum,
      ajint colour
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

ajint colour Input Colour for bar set.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	Histogram to have ptr set.
ajuint	indexnum	Input	Index for the set number.
ajint	colour	Input	Colour for bar set.
void		RETURN

Input

indexnum:	(Input)	Index for the set number.
colour:	(Input)	Colour for bar set.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Set colour for bars in histogram for index'th set.

Availability

In release 6.4.0

Function ajHistSetmultiPattern

Set colour for bars in histogram for one set.

Synopsis

Prototype

void ajHistSetmultiPattern (
      AjPHist thys,
      ajuint indexnum,
      ajint style
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

ajint style Input Line style number for bar set.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	Histogram to have ptr set.
ajuint	indexnum	Input	Index for the set number.
ajint	style	Input	Line style number for bar set.
void		RETURN

Input

indexnum:	(Input)	Index for the set number.
style:	(Input)	Line style number for bar set.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Set colour for bars in histogram for one set.

Availability

In release 6.4.0

Function ajHistSetmultiTitleC

Store title for the index'th set.

Synopsis

Prototype

void ajHistSetmultiTitleC (
      AjPHist thys,
      ajuint indexnum,
      const char* txt
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

const char* txt Input Title.

void RETURN

Type	Name	Read/Write	Description
AjPHist	thys	Modify	Histogram to have ptr set.
ajuint	indexnum	Input	Index for the set number.
const char*	txt	Input	Title.
void		RETURN

Input

indexnum:	(Input)	Index for the set number.
txt:	(Input)	Title.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Store title for the index'th set.

Availability

In release 6.4.0

Function ajHistSetmultiTitleS

Set ptr for title for index'th set..

Synopsis

Prototype

void ajHistSetmultiTitleS (
      AjPHist thys,
      ajuint indexnum,
      const AjPStr str
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

const AjPStr str Input Title.

void RETURN

Input

indexnum:	(Input)	Index for the set number.
str:	(Input)	Title.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Set ptr for title for index'th set..

Availability

In release 6.4.0

Function ajHistSetmultiXlabelC

Store X axis title for the index'th set.

Synopsis

Prototype

void ajHistSetmultiXlabelC (
      AjPHist thys,
      ajuint indexnum,
      const char* txt
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

const char* txt Input x Title.

void RETURN

Input

indexnum:	(Input)	Index for the set number.
txt:	(Input)	x Title.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Store X axis title for the index'th set.

Availability

In release 6.4.0

Function ajHistSetmultiXlabelS

Set ptr for X axis title for index'th set..

Synopsis

Prototype

void ajHistSetmultiXlabelS (
      AjPHist thys,
      ajuint indexnum,
      const AjPStr str
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

const AjPStr str Input x Title.

void RETURN

Input

indexnum:	(Input)	Index for the set number.
str:	(Input)	x Title.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Set ptr for X axis title for index'th set..

Availability

In release 6.4.0

Function ajHistSetmultiYlabelC

Store Y axis title for the index'th set.

Synopsis

Prototype

void ajHistSetmultiYlabelC (
      AjPHist thys,
      ajuint indexnum,
      const char* txt
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

const char* txt Input Y Title.

void RETURN

Input

indexnum:	(Input)	Index for the set number.
txt:	(Input)	Y Title.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Store Y axis title for the index'th set.

Availability

In release 6.4.0

Function ajHistSetmultiYlabelS

Set ptr for Y axis title for index'th set..

Synopsis

Prototype

void ajHistSetmultiYlabelS (
      AjPHist thys,
      ajuint indexnum,
      const AjPStr str
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

const AjPStr str Input Y Title.

void RETURN

Input

indexnum:	(Input)	Index for the set number.
str:	(Input)	Y Title.

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Set ptr for Y axis title for index'th set..

Availability

In release 6.4.0

Section: Histogram data management

Functions to manage the data values associated with a histogram object

Functions: ajHistDataAdd ajHistDataCopy

Function ajHistDataAdd

Set internal pointer to data for a set of data points for one set.

Synopsis

Prototype

void ajHistDataAdd (
      AjPHist thys,
      ajuint indexnum,
      PLFLT* data
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

PLFLT* data Modify Data values to be owned by the histogram object

void RETURN

Input

indexnum:

(Input)

Index for the set number.

Input & Output

thys:	(Modify)	Histogram to have ptr set.
data:	(Modify)	Data values to be owned by the histogram object

Returns

void:

No return value

Description

Set internal pointer to data for a set of data points for one set.

Availability

In release 6.4.0

Function ajHistDataCopy

Copy data from data array to histogram for one set.

Synopsis

Prototype

void ajHistDataCopy (
      AjPHist thys,
      ajuint indexnum,
      PLFLT const* srcdata
);

Type Name Read/Write Description

AjPHist thys Modify Histogram to have ptr set.

ajuint indexnum Input Index for the set number.

PLFLT const* srcdata Input Data to be copied

void RETURN

Input

indexnum:	(Input)	Index for the set number.
srcdata:	(Input)	Data to be copied

Input & Output

thys:

(Modify)

Histogram to have ptr set.

Returns

void:

No return value

Description

Copy data from data array to histogram for one set.

Availability

In release 6.4.0

ajhist.c

Synopsis

Prototype

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

See Also

Availability

Synopsis

Prototype

Output

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns

Description

See Also

Availability

Synopsis

Prototype

Input

Input & Output

Returns