ajhist.c

Function ajHistDisplay

Display the histogram.

Synopsis

Prototype

void ajHistDisplay (
      const AjPHist hist
);

Input

hist:(Input)Histogram Structure.

Returns

void:No return value

Description

Display the histogram.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistClose

Closes the histograms window.

Synopsis

Prototype

void ajHistClose (
      void
);

Returns

void:No return value

Description

Closes the histograms window.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistDelete

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

Synopsis

Prototype

void ajHistDelete (
      AjPHist* phist
);

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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

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 (
      ajint numofsets,
      ajint numofpoints
);

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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistNewG

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

Synopsis

Prototype

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

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 orignial 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.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetMultiTitle

Set ptr for title for index'th set..

Synopsis

Prototype

void ajHistSetMultiTitle (
      AjPHist hist,
      ajint index,
      const AjPStr title
);

Input

index:(Input)Index for the set number.
title:(Input)Title.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

Set ptr for title for index'th set..

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetMultiTitleC

Store title for the index'th set.

Synopsis

Prototype

void ajHistSetMultiTitleC (
      AjPHist hist,
      ajint index,
      const char* title
);

Input

index:(Input)Index for the set number.
title:(Input)Title.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

Store title for the index'th set.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetMultiXTitle

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

Synopsis

Prototype

void ajHistSetMultiXTitle (
      AjPHist hist,
      ajint index,
      const AjPStr title
);

Input

index:(Input)Index for the set number.
title:(Input)x Title.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetMultiXTitleC

Store X axis title for the index'th set.

Synopsis

Prototype

void ajHistSetMultiXTitleC (
      AjPHist hist,
      ajint index,
      const char* title
);

Input

index:(Input)Index for the set number.
title:(Input)x Title.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

Store X axis title for the index'th set.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetMultiYTitle

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

Synopsis

Prototype

void ajHistSetMultiYTitle (
      AjPHist hist,
      ajint index,
      const AjPStr title
);

Input

index:(Input)Index for the set number.
title:(Input)Y Title.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetMultiYTitleC

Store Y axis title for the index'th set.

Synopsis

Prototype

void ajHistSetMultiYTitleC (
      AjPHist hist,
      ajint index,
      const char* title
);

Input

index:(Input)Index for the set number.
title:(Input)Y Title.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

Store Y axis title for the index'th set.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetPtrToData

Set ptr to data for a set of data points for index'th set..

Synopsis

Prototype

void ajHistSetPtrToData (
      AjPHist hist,
      ajint index,
      PLFLT* data
);

Input

index:(Input)Index for the set number.

Input & Output

hist:(Modify)Histogram to have ptr set.
data:(Modify)Ptr to the data. Will now be used by the AjPHist

Returns

void:No return value

Description

Set ptr to data for a set of data points for index'th set..

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistCopyData

Copy data from data ptr to histogram for index'th set.

Synopsis

Prototype

void ajHistCopyData (
      AjPHist hist,
      ajint index,
      const PLFLT* data
);

Input

index:(Input)Index for the set number.
data:(Input)Ptr to the data.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

Copy data from data ptr to histogram for index'th set.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetTitleC

Copy Title for the histogram.

Synopsis

Prototype

void ajHistSetTitleC (
      AjPHist hist,
      const char* strng
);

Input

strng:(Input)text to be copied.

Input & Output

hist:(Modify)histogram to set string in.

Returns

void:No return value

Description

Copy Title for the histogram.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetXAxisC

Store X axis label for the histogram

Synopsis

Prototype

void ajHistSetXAxisC (
      AjPHist hist,
      const char* strng
);

Input

strng:(Input)text to be copied.

Input & Output

hist:(Modify)histogram to set string in.

Returns

void:No return value

Description

Store X axis label for the histogram

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetYAxisLeftC

Store Y Axis Left Label for the histogram

Synopsis

Prototype

void ajHistSetYAxisLeftC (
      AjPHist hist,
      const char* strng
);

Input

strng:(Input)text to be copied.

Input & Output

hist:(Modify)histogram to set string in.

Returns

void:No return value

Description

Store Y Axis Left Label for the histogram

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetYAxisRightC

Store Y Axis Right Label for the histogram

Synopsis

Prototype

void ajHistSetYAxisRightC (
      AjPHist hist,
      const char* strng
);

Input

strng:(Input)text to be copied.

Input & Output

hist:(Modify)histogram to set string in.

Returns

void:No return value

Description

Store Y Axis Right Label for the histogram

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetColour

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

Synopsis

Prototype

void ajHistSetColour (
      AjPHist hist,
      ajint index,
      ajint colour
);

Input

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

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetPattern

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

Synopsis

Prototype

void ajHistSetPattern (
      AjPHist hist,
      ajint index,
      ajint style
);

Input

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

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0

Function ajHistSetBlackandWhite

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

Synopsis

Prototype

void ajHistSetBlackandWhite (
      AjPHist hist,
      AjBool set
);

Input

set:(Input)Set to use patterns or colour for filling.

Input & Output

hist:(Modify)Histogram to have ptr set.

Returns

void:No return value

Description

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

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 3.0.0