Histogram

Histogram_FieldDataEx, Histogram_ObjectDataEx, HistogramAutoMeas_RotateAxisYCaption, HistogramAutoMeas_SetAutoBinWidth, HistogramAutoMeas_SetAutoMax, HistogramAutoMeas_SetAutoMin, HistogramAutoMeas_SetAxisXCaption, HistogramAutoMeas_SetAxisYCaption, HistogramAutoMeas_SetEqBins, HistogramAutoMeas_SetEquidistant, HistogramAutoMeas_SetNonEqBins, HistogramAutoMeas_SetTopCaption, HistogramAutoMeas_ShowAxisXCaption, HistogramAutoMeas_ShowAxisYCaption, HistogramAutoMeas_ShowTopCaption, HistogramManMeas_RotateAxisYCaption, HistogramManMeas_SetAutoBinWidth, HistogramManMeas_SetAutoMax, HistogramManMeas_SetAutoMin, HistogramManMeas_SetAxisXCaption, HistogramManMeas_SetAxisYCaption, HistogramManMeas_SetEqBins, HistogramManMeas_SetEquidistant, HistogramManMeas_SetNonEqBins, HistogramManMeas_SetTopCaption, HistogramManMeas_ShowAxisXCaption, HistogramManMeas_ShowAxisYCaption, HistogramManMeas_ShowTopCaption

HistogramAutoMeas_RotateAxisYCaption

Description 

int HistogramAutoMeas_RotateAxisYCaption(
   int  RotateCaption
);

The function rotates caption of axis Y in the automated measurement histogram.

Parameters

int RotateCaption

Rotates the caption.

0

caption is horizontal

1

caption is vertical (rotated)

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramAutoMeas_SetAxisYCaption, HistogramAutoMeas_ShowAxisYCaption

HistogramAutoMeas_SetAutoBinWidth

Description 

int HistogramAutoMeas_SetAutoBinWidth(
   int  SetAutoBin
);

This function switches on/off automatic width of bins calculating in the automated measurement histogram.

Parameters

int SetAutoBin

0

Not calculated automatically.

non-zero

Calculated automatically.

Return Values

int

Informs if the function was successful.

0

the function was successful

1

the function failed

See Also 
HistogramAutoMeas_SetAutoMax, HistogramAutoMeas_SetAutoMin, HistogramAutoMeas_SetEqBins, HistogramAutoMeas_SetNonEqBins

HistogramAutoMeas_SetAutoMax

Description 

int HistogramAutoMeas_SetAutoMax(
   int  SetAutoBin
);

This function switches on/off automatic maximum bin calculating in the automated measurement histogram.

Parameters

int SetAutoBin

0

Not calculated automatically.

non-zero

Calculated automatically.

Return Values

int

Informs if the function was successful.

0

the function was successful

1

the function failed

See Also 
HistogramAutoMeas_SetAutoBinWidth, HistogramAutoMeas_SetAutoMin, HistogramAutoMeas_SetEqBins, HistogramAutoMeas_SetNonEqBins

HistogramAutoMeas_SetAutoMin

Description 

int HistogramAutoMeas_SetAutoMin(
   int  SetAutoBin
);

This function switches on/off automatic minimum bin calculating in the automated measurement histogram.

Parameters

int SetAutoBin

0

Not calculated automatically.

non-zero

Calculated automatically.

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramAutoMeas_SetAutoBinWidth, HistogramAutoMeas_SetAutoMax, HistogramAutoMeas_SetEqBins, HistogramAutoMeas_SetNonEqBins

HistogramAutoMeas_SetAxisXCaption

Description 

int HistogramAutoMeas_SetAxisXCaption(
   char *Caption
);

This function sets the caption of axis X in the automated measurement histogram.

Parameters

char *Caption

Text displayed in the caption.

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

HistogramAutoMeas_SetAxisXCaption("Any caption..");

See Also 
HistogramAutoMeas_ShowAxisXCaption, HistogramAutoMeas_SetAxisYCaption

HistogramAutoMeas_SetAxisYCaption

Description 

int HistogramAutoMeas_SetAxisYCaption(
   char *Caption
);

This function sets the caption of axis Y in the automated measurement histogram.

Parameters

char *Caption

Text displayed in the caption.

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

HistogramAutoMeas_SetAxisYCaption("Any caption..");

See Also 
HistogramAutoMeas_RotateAxisYCaption, HistogramAutoMeas_ShowAxisYCaption, HistogramAutoMeas_SetAxisXCaption

HistogramAutoMeas_SetEqBins

Description 

int HistogramAutoMeas_SetEqBins(
   double  BinMin,
   double  BinMax,
   double  BinWidth
);

This function sets minimum bin, maximum bin and bin width in the automated measurement histogram.

Parameters

double BinMin

The minimum bin of the histogram.

double BinMax

The maximum bin of the histogram.

double BinWidth

The bin width of the histogram.

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

HistogramAutoMeas_SetEqBins(0,20, 2);

Note

After executing this command will the histogram have 10 bins of width 2, starting at 0 and ending at 20.

See Also 
HistogramAutoMeas_SetAutoMax, HistogramAutoMeas_SetAutoMin, HistogramAutoMeas_SetAutoBinWidth, HistogramAutoMeas_SetNonEqBins, HistogramAutoMeas_SetEquidistant

HistogramAutoMeas_SetEquidistant

Description 

int HistogramAutoMeas_SetEquidistant(
   int  Equidistant
);

This function set the automated measurement histogram display mode to equidistant or non-equidistant.

Parameters

int Equidistant

Define the display mode of the histogram.

0

set histogram to non-equidistant display mode

1

set histogram to equidistant display mode

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramAutoMeas_SetNonEqBins, HistogramAutoMeas_SetEqBins

HistogramAutoMeas_SetNonEqBins

Description 

int HistogramAutoMeas_SetNonEqBins(
   double *LpBins,
   int  BinsNum
);

This function sets non-equidistant bins in the automated measurement histogram.

Parameters

double *LpBins

Pointer to the double array containing non-equidistant bins.

int BinsNum

Number of elements of the double array LpBins

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

int main()
{
        double MyNonEqBins[4];
        MyNonEqBins[0]=0;
        MyNonEqBins[1]=2;
        MyNonEqBins[2]=5;
        MyNonEqBins[3]=10;
        HistogramAutoMeas_SetEquidistant(0);
        HistogramAutoMeas_SetNonEqBins(MyNonEqBins, 4);
}

Note

After executing this command will the histogram have three bins: 1. [0-2] 2. [2-5] 3. [5-10]

See Also 
HistogramAutoMeas_SetEquidistant, HistogramAutoMeas_SetEqBins, HistogramAutoMeas_SetAutoMax, HistogramAutoMeas_SetAutoMin, HistogramAutoMeas_SetAutoBinWidth

HistogramAutoMeas_SetTopCaption

Description 

int HistogramAutoMeas_SetTopCaption(
   char *Caption
);

This function sets the top caption of the automated measurement histogram.

Parameters

char *Caption

Text displayed in the caption.

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

HistogramAutoMeas_SetTopCaption("Any caption..");

See Also 
HistogramAutoMeas_ShowTopCaption

HistogramAutoMeas_ShowAxisXCaption

Description 

int HistogramAutoMeas_ShowAxisXCaption(
   int  ShowCaption
);

This function displays the caption of axis X in the automated measurement histogram.

Parameters

int ShowCaption

Defines if the caption should be hidden or displayed.

0

sets the caption hidden

1

displays the caption

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramAutoMeas_SetAxisXCaption, HistogramAutoMeas_ShowAxisYCaption

HistogramAutoMeas_ShowAxisYCaption

Description 

int HistogramAutoMeas_ShowAxisYCaption(
   int  ShowCaption
);

This function displays the caption of axis Y in the automated measurement histogram.

Parameters

int ShowCaption

Defines if the caption should be hidden or displayed.

0

sets the caption hidden

1

displays the caption

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramAutoMeas_RotateAxisYCaption, HistogramAutoMeas_SetAxisYCaption, HistogramAutoMeas_ShowAxisXCaption

HistogramAutoMeas_ShowTopCaption

Description 

int HistogramAutoMeas_ShowTopCaption(
   int  ShowCaption
);

This function displays/hides the top caption of the automated measurement histogram.

Parameters

int ShowCaption

Defines if the caption should be hidden or displayed.

0

sets the caption hidden

1

displays the caption

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

See Also 
HistogramAutoMeas_SetTopCaption

HistogramManMeas_RotateAxisYCaption

Description 

int HistogramManMeas_RotateAxisYCaption(
   int  RotateCaption
);

This function rotates caption of axis Y in the manual measurement histogram.

Parameters

int RotateCaption

Rotates the caption.

0

caption is horizontal

1

caption is vertical (rotated)

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramManMeas_SetAxisYCaption, HistogramManMeas_ShowAxisYCaption

HistogramManMeas_SetAutoBinWidth

Description 

int HistogramManMeas_SetAutoBinWidth(
   int  SetAutoBin
);

This function switches on/off automatic width of bins calculating in the manual measurement histogram.

Parameters

int SetAutoBin

0

Not calculated automatically.

non-zero

Calculated automatically.

Return Values

int

Informs if the function was successful.

0

the function was successful

1

the function failed

See Also 
HistogramManMeas_SetAutoMax, HistogramManMeas_SetAutoMin, HistogramManMeas_SetEqBins, HistogramManMeas_SetNonEqBins

HistogramManMeas_SetAutoMax

Description 

int HistogramManMeas_SetAutoMax(
   int  SetAutoBin
);

This function switches on/off automatic maximum bin calculating in the manual measurement histogram.

Parameters

int SetAutoBin

0

Not calculated automatically.

non-zero

Calculated automatically.

Return Values

int

Informs if the function was successful.

0

the function was successful

1

the function failed

See Also 
HistogramManMeas_SetAutoBinWidth, HistogramManMeas_SetAutoMin, HistogramManMeas_SetEqBins, HistogramManMeas_SetNonEqBins

HistogramManMeas_SetAutoMin

Description 

int HistogramManMeas_SetAutoMin(
   int  SetAutoBin
);

This function switches on/off automatic minimum bin calculating in the manual measurement histogram.

Parameters

int SetAutoBin

0

Not calculated automatically.

non-zero

Calculated automatically.

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramManMeas_SetAutoBinWidth, HistogramManMeas_SetAutoMax, HistogramManMeas_SetEqBins, HistogramManMeas_SetNonEqBins

HistogramManMeas_SetAxisXCaption

Description 

int HistogramManMeas_SetAxisXCaption(
   char *Caption
);

This function sets the caption of axis X in the manual measurement histogram.

Parameters

char *Caption

Text displayed in the caption.

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

HistogramManMeas_SetAxisXCaption("Any caption..");

See Also 
HistogramManMeas_ShowAxisXCaption, HistogramManMeas_SetAxisYCaption

HistogramManMeas_SetAxisYCaption

Description 

int HistogramManMeas_SetAxisYCaption(
   char *Caption
);

This function sets the caption of axis Y in the manual measurement histogram.

Parameters

char *Caption

Text displayed in the caption.

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

HistogramAutoMeas_SetAxisYCaption("Any caption..");

See Also 
HistogramManMeas_RotateAxisYCaption, HistogramManMeas_ShowAxisYCaption, HistogramManMeas_SetAxisXCaption

HistogramManMeas_SetEqBins

Description 

int HistogramManMeas_SetEqBins(
   double  BinMin,
   double  BinMax,
   double  BinWidth
);

This function sets minimum bin, maximum bin and bin width in the manual measurement histogram.

Parameters

double BinMin

The minimum bin of the histogram.

double BinMax

The maximum bin of the histogram.

double BinWidth

The bin width of the histogram.

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

HistogramManMeas_SetEqBins(0,20, 2);

Note

After executing this command will the histogram have 10 bins of width 2, starting at 0 and ending at 20.

See Also 
HistogramManMeas_SetAutoMax, HistogramManMeas_SetAutoMin, HistogramManMeas_SetAutoBinWidth, HistogramManMeas_SetNonEqBins, HistogramManMeas_SetEquidistant

HistogramManMeas_SetEquidistant

Description 

int HistogramManMeas_SetEquidistant(
   int  Equidistant
);

This function sets the automeasurement histogram display mode to equidistant or non-equidistant.

Parameters

int Equidistant

Define the display mode of the histogram.

0

set histogram to non-equidistant display mode

1

set histogram to equidistant display mode

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramAutoMeas_SetNonEqBins, HistogramAutoMeas_SetEqBins

HistogramManMeas_SetNonEqBins

Description 

int HistogramManMeas_SetNonEqBins(
   double *LpBins,
   int  BinsNum
);

This function sets non-equidistant bins in the manualmeasurement histogram.

Parameters

double *LpBins

Pointer to the double array containing non-equidistant bins.

int BinsNum

Number of elements of the double array LpBins

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

int main()
{
        double MyNonEqBins[4];
        MyNonEqBins[0]=0;
        MyNonEqBins[1]=2;
        MyNonEqBins[2]=5;
        MyNonEqBins[3]=10;
        HistogramManMeas_SetEquidistant(0);
        HistogramManMeas_SetNonEqBins(MyNonEqBins, 4);
}

Note

After executing this command will the histogram have three bins: 1. [0-2] 2. [2-5] 3. [5-10]

See Also 
HistogramManMeas_SetEquidistant, HistogramManMeas_SetEqBins, HistogramManMeas_SetAutoMax, HistogramManMeas_SetAutoMin, HistogramManMeas_SetAutoBinWidth

HistogramManMeas_SetTopCaption

Description 

int HistogramManMeas_SetTopCaption(
   char *Caption
);

This function sets the top caption of the manual measurement histogram.

Parameters

char *Caption

Text displayed in the caption.

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

HistogramManMeas_SetTopCaption("Any caption..");

See Also 
HistogramManMeas_ShowTopCaption

HistogramManMeas_ShowAxisXCaption

Description 

int HistogramManMeas_ShowAxisXCaption(
   int  ShowCaption
);

This function displays the caption of axis X in the manual measurement histogram.

Parameters

int ShowCaption

Defines if the caption should be hidden or displayed.

0

sets the caption hidden

1

displays the caption

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramManMeas_SetAxisXCaption, HistogramManMeas_ShowAxisYCaption

HistogramManMeas_ShowAxisYCaption

Description 

int HistogramManMeas_ShowAxisYCaption(
   int  ShowCaption
);

This function displays the caption of axis Y in the manual measurement histogram.

Parameters

int ShowCaption

Defines if the caption should be hidden or displayed.

0

sets the caption hidden

1

displays the caption

Return Values

int

Informs if the function was successful.

0

the function was successful

non-zero

the function failed

See Also 
HistogramManMeas_RotateAxisYCaption, HistogramManMeas_SetAxisYCaption, HistogramManMeas_ShowAxisXCaption

HistogramManMeas_ShowTopCaption

Description 

int HistogramManMeas_ShowTopCaption(
   int  ShowCaption
);

This function displays/hides the top caption of the manual measurement histogram.

Parameters

int ShowCaption

Defines if the caption should be hidden or displayed.

0

sets the caption hidden

1

displays the caption

Return Values

int

Informs if the function was successful

0

the function was successful

non-zero

the function failed

See Also 
HistogramManMeas_SetTopCaption

Histogram_FieldDataEx

Description 

 Histogram_FieldDataEx(
   char *FieldFeatName
);

This function displays a field feature histogram. The histogram in displayed in the Automated Measurement Results window.

Parameters

char *FieldFeatName

Name of the measurement feature.

Histogram_ObjectDataEx

Description 

 Histogram_ObjectDataEx(
   char *ObjectFeatName
);

This function displays an object feature histogram. The histogram in displayed in the Automated Measurement Results window.

Parameters

char *ObjectFeatName

Name of the feature.