ajhist.c

Datatypes:

none Histogram internals

AjPHist Histogram object

Datatype: none

Function is for controlling the histogram internals without using an AjPGraph object

Sections:

modifiers Modifiers

Section: modifiers

Controlling the internals

Functions:

ajHistogramClose Closes the histograms window.

ajHistogramSetMark Set the histogram mark internal value

Prototype

void ajHistogramClose (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 6.2.0

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

From EMBOSS 6.2.0

Datatype: AjPHist

Function is for manipulating an AjPHist histogram object

Sections:

Constructors Constructors

Destructors Destructors

Display General use

modifiers Modifiers

Histogram data management Modifiers

AjPHist: Constructors

Construct a new histogram object to be populated by other functions

Functions:

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

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

Function ajHistNew

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

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.

From EMBOSS 1.0.0

Function ajHistNewG

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

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.

From EMBOSS 1.0.0

AjPHist: Destructors

Destructors for histogram objects

Functions:

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

Function ajHistDel

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

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

From EMBOSS 6.2.0

AjPHist: Display

Functions to display or write the histogram

Functions:

ajHistDisplay Display the histogram.

Function ajHistDisplay

Display the histogram.

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

From EMBOSS 1.0.0

AjPHist: modifiers

Controlling the internals

Functions:

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

ajHistSetRlabelC Store Y Axis Right Label for the histogram

ajHistSetTitleC Copy Title for the histogram.

ajHistSetXlabelC Store X axis label for the histogram

ajHistSetYlabelC Store Y Axis Left Label for the histogram

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

ajHistSetmultiPattern Set colour for bars in histogram for one set.

ajHistSetmultiTitleC Store title for the index'th set.

ajHistSetmultiTitleS Set ptr for title for index'th set..

ajHistSetmultiXlabelC Store X axis title for the index'th set.

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

ajHistSetmultiYlabelC Store Y axis title for the index'th set.

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

Function ajHistSetMono

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

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

From EMBOSS 6.2.0

Function ajHistSetRlabelC

Store Y Axis Right Label for the histogram

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

From EMBOSS 6.2.0

Function ajHistSetTitleC

Copy Title for the histogram.

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

From EMBOSS 1.0.0

Function ajHistSetXlabelC

Store X axis label for the histogram

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

From EMBOSS 6.2.0

Function ajHistSetYlabelC

Store Y Axis Left Label for the histogram

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

From EMBOSS 6.2.0

Function ajHistSetmultiColour

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

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

From EMBOSS 6.2.0

Function ajHistSetmultiPattern

Set colour for bars in histogram for one set.

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

From EMBOSS 6.2.0

Function ajHistSetmultiTitleC

Store title for the index'th set.

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

From EMBOSS 6.2.0

Function ajHistSetmultiTitleS

Set ptr for title for index'th set..

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

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

From EMBOSS 6.2.0

Function ajHistSetmultiXlabelC

Store X axis title for the index'th set.

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

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

From EMBOSS 6.2.0

Function ajHistSetmultiXlabelS

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

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

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

From EMBOSS 6.2.0

Function ajHistSetmultiYlabelC

Store Y axis title for the index'th set.

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

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

From EMBOSS 6.2.0

Function ajHistSetmultiYlabelS

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

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

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

From EMBOSS 6.2.0

AjPHist: Histogram data management

Functions to manage the data values associated with a histogram object

Functions:

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

ajHistDataCopy Copy data from data array to histogram for one set.

Function ajHistDataAdd

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

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

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

From EMBOSS 6.2.0

Function ajHistDataCopy

Copy data from data array to histogram for one set.

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

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

From EMBOSS 6.2.0

ajHistogramClose	Closes the histograms window.
ajHistogramSetMark	Set the histogram mark internal value

Constructors	Constructors
Destructors	Destructors
Display	General use
modifiers	Modifiers
Histogram data management	Modifiers

ajHistNew	Create a histogram Object. Which can hold "numofsets" set of data of which all must have "numofpoints" data points in them.
ajHistNewG	Create a histogram Object which has the histogram data and graph data storage capacity.

ajHistSetMono	Set patterns instead of colours for printing to B/W printers etc.
ajHistSetRlabelC	Store Y Axis Right Label for the histogram
ajHistSetTitleC	Copy Title for the histogram.
ajHistSetXlabelC	Store X axis label for the histogram
ajHistSetYlabelC	Store Y Axis Left Label for the histogram
ajHistSetmultiColour	Set colour for bars in histogram for index'th set.
ajHistSetmultiPattern	Set colour for bars in histogram for one set.
ajHistSetmultiTitleC	Store title for the index'th set.
ajHistSetmultiTitleS	Set ptr for title for index'th set..
ajHistSetmultiXlabelC	Store X axis title for the index'th set.
ajHistSetmultiXlabelS	Set ptr for X axis title for index'th set..
ajHistSetmultiYlabelC	Store Y axis title for the index'th set.
ajHistSetmultiYlabelS	Set ptr for Y axis title for index'th set..

ajHistDataAdd	Set internal pointer to data for a set of data points for one set.
ajHistDataCopy	Copy data from data array to histogram for one set.