Data

Get_3DObjectFeatureDataDbl, Get_3DObjectFeatureDataStr, Get_3DObjectFeatureName, Get_3DObjectFeaturesCount, Get_3DObjectFeatureValueDbl, Get_3DObjectFeatureValueStr, Get_3DObjectRecordsCount, Get_BinaryInRoiFeatureData, Get_BinaryInRoiFeatureStats, Get_BinaryInRoiFeatureStatsInLocation, Get_BinaryInRoiFeatureValue, Get_BinaryInRoiFeatureValueString, Get_FieldFeatureData, Get_FieldFeatureDataInBinary, Get_FieldFeatureName, Get_FieldFeatureStats, Get_FieldFeatureStatsInBinary, Get_FieldFeatureStatsInBinaryAndLocation, Get_FieldFeatureStatus, Get_FieldFeatureValue, Get_FieldFeatureValueInBinary, Get_FieldFeatureValueString, Get_Histo, Get_IFeatureData, Get_IFeatureSData, Get_IFeatureSValueString, Get_IFeatureValueString, Get_NumFeatures, Get_NumFields, Get_NumIFeatureRecords, Get_NumIFeatureSRecords, Get_NumObjects, Get_NumObjectsInBinary, Get_NumObjectsInBinaryAndRoi, Get_ObjectFeatureData, Get_ObjectFeatureDataInBinary, Get_ObjectFeatureDataInBinaryAndRoi, Get_ObjectFeatureName, Get_ObjectFeatureStats, Get_ObjectFeatureStatsInBinary, Get_ObjectFeatureStatsInBinaryAndRoi, Get_ObjectFeatureStatsInBinaryAndRoiAndLocation, Get_ObjectFeatureStatus, Get_ObjectFeatureValue, Get_ObjectFeatureValueInBinary, Get_ObjectFeatureValueInBinaryAndRoi, Get_ObjectFeatureValueString, Get_ObjectFeatureValueStringInBinaryAndRoi, Get_ROIFeatureData, Get_ROIFeatureStats, Get_ROIFeatureStatsInLocation, Get_ROIFeatureValue, Get_ROIFeatureValueString, Get_ROINumObjects, Get_TableFeatureData, ResetAutoMeasData

Get_3DObjectFeatureDataDbl

Description 

double Get_3DObjectFeatureDataDbl(
   char *FeatName,
   double *lpData
);

Returns values of the 3D feature as a double.

Parameters

char *FeatName

Name of the 3D measurement feature.

double *lpData

Address to the double array, filled on output.

Return Values

double

Value of the 3D feature.

Get_3DObjectFeatureDataStr

Description 

char Get_3DObjectFeatureDataStr(
   char *FeatName,
   char *Buffer
);

Returns values of the 3D feature as a string.

Address of the buffer is separated by \0 and ended by \0\0. E.g.: "aaa\0bbb\0ccc\0\0"

Parameters

char *FeatName

Name of the 3D measurement feature.

char *Buffer

Address of the buffer.

Return Values

char

Value of the 3D feature.

Get_3DObjectFeatureName

Description 

int Get_3DObjectFeatureName(
   int  Index,
   char *FeatName
);

Returns the name of the feature on the defined Index (order in which the 3D features are saved).

Parameters

int Index

Index number (zero-based).

char *FeatName

Name of the 3D measurement feature.

Return Values

int

Name of the feature on the defined Index.

Get_3DObjectFeatureValueDbl

Description 

double Get_3DObjectFeatureValueDbl(
   char *FeatName,
   int  3DObject
);

Returns one value of the 3D feature as a double.

Parameters

char *FeatName

Name of the 3D measurement feature.

int 3DObject

Index of the 3D object.

Return Values

double

One value of the 3D feature.

Get_3DObjectFeatureValueStr

Description 

char Get_3DObjectFeatureValueStr(
   char *FeatName,
   int  3DObject,
   char *Buffer
);

Returns one value of the 3D feature as a string.

Address of the buffer is separated by \0 and ended by \0\0. E.g.: "aaa\0bbb\0ccc\0\0"

Parameters

char *FeatName

Name of the 3D measurement feature.

int 3DObject

Index of the 3D object.

char *Buffer

Address of the buffer.

Return Values

char

One value of the 3D feature.

Get_3DObjectFeaturesCount

Description 

int Get_3DObjectFeaturesCount();

Returns the number of 3D features.

Return Values

int

Number of 3D features.

Get_3DObjectRecordsCount

Description 

int Get_3DObjectRecordsCount();

Returns the number of objects.

Return Values

int

Number of objects.

Get_BinaryInRoiFeatureData

Description 

 Get_BinaryInRoiFeatureData(
   char *FieldFeatName,
   double *lpData,
   int  Field,
   int  ROI
);

This function fills the array of the double values with the featname values (from binary layer in ROI) in the specified field in the Automated measurement.

Parameters

char *FieldFeatName

Name of the measurement feature.

double *lpData

Address to the double array, filled on output.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

Get_BinaryInRoiFeatureStats

Description 

 Get_BinaryInRoiFeatureStats(
   char *FeatName,
   int  Field,
   int  ROI,
   char *Binary,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal
);

This function retrieves basic statistical values from the binary layer in ROI of the specific feature from the specified field type. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

char *Binary

Name of the binary layer.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

Get_BinaryInRoiFeatureStatsInLocation

Description 

 Get_BinaryInRoiFeatureStatsInLocation(
   char *FeatName,
   int  AutoMeasDataLocation,
   int  Field,
   int  ROI,
   char *Binary,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal
);

Retrieves basic statistical values from the binary layer in ROI of the specific feature from the specified field type and location. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int AutoMeasDataLocation

Location of the Automated Measurement Results data.

0

all data (default value)

1

current

2

stored

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

char *Binary

Name of the binary layer.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

Get_BinaryInRoiFeatureValue

Description 

 Get_BinaryInRoiFeatureValue(
   char *FieldFeatName,
   int  Field,
   int  ROI,
   char *Binary
);

This function returns feature value of the binary layer in ROI in the specified field in the Automated measurement. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

char *Binary

Name of the binary layer.

Get_BinaryInRoiFeatureValueString

Description 

 Get_BinaryInRoiFeatureValueString(
   char *Result,
   char *FieldFeatName,
   int  Field,
   int  ROI,
   char *Binary
);

This function returns the feature value of the binary layer in ROI in the specified field in the Automated measurement. The feature must have the string type. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *Result

Address to the char array, filled on output.

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

char *Binary

Name of the binary layer.

Get_FieldFeatureData

Description 

int Get_FieldFeatureData(
   char *FeatName,
   double *lpdata
);

This function fills the array of the double values with values of the featname from all fields.

Parameters

char *FeatName

Name of the measurement feature.

double *lpdata

Address to the double array, filled on output.

Return Values

int

This function returns number of all measured fields.

See Also 
Get_FieldFeatureStats, Get_FieldFeatureValue, Get_FieldFeatureStatus

Get_FieldFeatureDataInBinary

Description 

int Get_FieldFeatureDataInBinary(
   char *FieldFeatName,
   char *Binary,
   double *lpData
);

Fills the array of the double values with values of featname from all fields measured in the Automated measurement. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FieldFeatName

Name of the measurement feature.

char *Binary

Name of the binary layer.

double *lpData

Address to the double array, filled on output.

Return Values

int

Returns the number of measured field data within the selected binary layer, i.e. number of records filled into LpData parameter.

See Also 
Get_FieldFeatureData, Get_FieldFeatureStatsInBinary, Get_FieldFeatureValueInBinary

Get_FieldFeatureName

Description 

INT Get_FieldFeatureName(
   int  Index,
   char *FeatName
);

This function retrieves the name of the field feature according to the zero based index. The function fills the featname on output.

Parameters

int Index

Index number (zero-based).

char *FeatName

Name of the measurement feature.

Return Values

INT

This function returns TRUE (1) if featname is valid feature. If featname is invalid, function returns -1.

See Also 
Get_NumFeatures, Get_FieldFeatureStatus, Get_FieldFeatureValue, Get_FieldFeatureData, Get_FieldFeatureStats

Get_FieldFeatureStats

Description 

LONG Get_FieldFeatureStats(
   char *FeatName,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal
);

This function retrieves the basic statistical values of the specific feature.

Parameters

char *FeatName

Name of the measurement feature.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

Return Values

LONG

The function returns the number of fields from which the statistics were calculated.

See Also 
Get_FieldFeatureData

Get_FieldFeatureStatsInBinary

Description 

int Get_FieldFeatureStatsInBinary(
   char *FieldFeatName,
   char *Binary,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal
);

Retrieves the basic statistical values of the specific feature from all fields measured in Automated measurement. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FieldFeatName

Name of the measurement feature.

char *Binary

Name of the binary layer.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

Return Values

int

The function returns the number of fields from which the statistics were calculated.

See Also 
Get_FieldFeatureStats, Get_FieldFeatureDataInBinary

Get_FieldFeatureStatsInBinaryAndLocation

Description 

 Get_FieldFeatureStatsInBinaryAndLocation(
   char *FieldFeatName,
   int  AutoMeasDataLocation,
   char *Binary,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal
);

Retrieves the basic statistical values of the specific feature in the binary layer and from a specified location. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FieldFeatName

Name of the measurement feature.

int AutoMeasDataLocation

Location of the Automated Measurement Results data.

0

all data (default value)

1

current

2

stored

char *Binary

Name of the binary layer.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

Get_FieldFeatureStatus

Description 

int Get_FieldFeatureStatus(
   char *FieldFeatName
);

This function returns TRUE (1) if the featname parameter is currently selected for field measurements.

Parameters

char *FieldFeatName

Name of the measurement feature.

Return Values

int

This function returns TRUE (1) if featname is currently selected for field measurements, if not selected, function returns FALSE (0).

See Also 
Get_FieldFeatureData

Get_FieldFeatureValue

Description 

double Get_FieldFeatureValue(
   char *FieldFeatName,
   int  Field
);

This function returns the value of the featname parameter of the specified field.

Parameters

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

Return Values

double

This function returns the value of feature featname for the specified field number field.

// Get_FieldFeatureValue example - shows how to retrieve field measurement data.
int       xs,ys,width,height,qw;
char      caption[256],buf[256];
dword     key,keys[10]; 
char      *str;
double    area_fraction;
key=0;
keys[0] = VK_RETURN;
strcpy(caption,"API Example - Get_FieldFeatureValue function");
Int_CreateTextWindow(caption,0,RGB(0,0,128),RGB_WHITE,100);
SetCommandText("Working...");
Wait(2);
Get_Size(SIZE_PICWND,&xs,&ys,&width,&height);
qw=Int_Question("LIM API Example","Resetting field measurement definition.\nDo you want to continue?","&Yes","&No","","",1,0);
if(qw==2) goto end;
ResetFieldFeatures();
SelectFieldFeature("AreaFraction");
str = "This example macro measures\nAreaFraction of binary image and\noutputs the result on the screen.");
WaitText(0, str);
qw=Int_Question("LIM API Example", "Please, define a binary image","It is already created.","I will create it now.","","",1,0);
if(qw==BUTTON_2)
   {
   strcpy(caption,"   application API Example - Create a Binary Image.\tPress Enter when ready.   ");
   Int_CreateTextWindow(caption,4,RGB(0,0,128),RGB_WHITE,100);
   while(key != keys[0])
   key=Int_GetEvents(keys,1);
   strcpy(caption,"API Example - Field measurement");
   Int_CreateTextWindow(caption,0,RGB(0,0,128),RGB_WHITE,100);
   }
MeasFrame(10,10,width-10,height-10);
MeasureField();
area_fraction = Get_FieldFeatureValue("AreaFraction",0);
sprintf(buf, "AreaFraction = %.2f", "area_fraction");
WaitText(0, buf);
end:
Int_CloseTextWindow();

See Also 
Get_NumFeatures, Get_FieldFeatureName, Get_FieldFeatureData, Get_FieldFeatureStats

Get_FieldFeatureValueInBinary

Description 

double Get_FieldFeatureValueInBinary(
   char *FieldFeatName,
   int  Field,
   char *Binary
);

Returns the value of the featname parameter of the specified field within the specified binary layer. Please use Get_FieldFeatureValueString if you wish to return the value of the string feature (filename, etc). Enter NULL (0) or an empty string into the Binary parameter to get the value of the first measured binary layer.

Parameters

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

Return Values

double

This function returns the value of feature featname for the specified field number field.

See Also 
Get_FieldFeatureValue, Get_FieldFeatureValueString, Get_FieldFeatureDataInBinary

Get_FieldFeatureValueString

Description 

int Get_FieldFeatureValueString(
   char *Result,
   char *FieldFeatName,
   int  Field,
   char *Binary
);

Returns the value of feature featname of the specified field within the specified binary layer. The feature must have the string type. Enter NULL (0) or an empty string into the Binary parameter to get the value of the first measured binary layer.

Parameters

char *Result

Address to the char array, filled on output.

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

Return Values

int

Returns 0 when successful.

See Also 
Get_FieldFeatureValueInBinary, Get_FieldFeatureValue

Get_Histo

Description 

int Get_Histo(
   lpword  histo,
   int  num_of_histo,
   double *data,
   dword  num_of_data,
   double *bins,
   int  num_of_bins
);

This function enables you to sample the whole range of the data by user-defined class width.

Parameters

lpword histo

Array of histogram data to be filled.

int num_of_histo

Size of histo array.

num_of_bins >1 and bins != NULL

The data are sampled exactly according to the bins.

num_of_bins == 1 and bins[0]>0

The data are sampled that bin width == bins[0]

num_of_bins <0 and bins != NULL

The data are sampled to create num_of_bins classes.

num_of_bins == 0

The data are sampled to create 15 classes.

double *data

Raw data from which the histogram will be calculated.

dword num_of_data

Size of data array.

double *bins

Array of user-defined class width.

int num_of_bins

Size of bins array.

Return Values

int

This function returns number of bins.

// Get_Histo example - creates size distribution of artificially created image.
char      caption[256],user[256];
int       qw,num_bins, width, height, i, j, radius;
dword     num; 
double    data[10000],addit;
dword     histo[200],index,tmp; 
double    mean,stdev,minval,maxval,dhisto[200],bins[200];
strcpy(caption,"API Example - Get_Histo function");
Int_CreateTextWindow(caption,0,RGB(0,0,128),RGB_WHITE,100);
SetCommandText("Working...");
Wait(2);
qw=Int_Question("LIM API Example","Resetting object measurement definition.\nDo you want to continue?","&Yes","&No","","",1,0);
if(qw==2) goto end;
ResetObjectFeatures();
SelectObjectFeature("Area");
Int_CreateTextWindow("Wait a moment, please.\tCreating Artificial Binary Image.",5,RGB(0,0,128),RGB_WHITE,70);
ClearBinary();
InvertBinary();
Get_Size(SIZE_PICWND,NULL,NULL,&width,&height);
InsertLines(32,0,4,MODE_SUB,0);
InsertLines(53,1,4,MODE_SUB,0);
InsertLines(74,2,4,MODE_SUB,0);
InsertLines(95,3,4,MODE_SUB,0);
radius = 100;
for(i=100; i<width; i=i+100)
   {
   for(j=100; j<height; j=j+100)
  {
  InsertCircle(i,j,radius,0,MODE_SUB,0);
  radius=radius+3;
  }
  }
ErodeBinary(1,5);
CleanBinary(2,4);
MeasFrame(10, 60, width-60, height-10);
Restrictions("Area",0,1,0.00000,1.00000e30);
Int_CreateTextWindow("Wait a moment, please.\tMeasuring Object Areas.",5,RGB(0,0,128),RGB_WHITE,70);
ScanObjects();
num=Get_NumObjects(FIELD_TOTAL,0);
if(num>10000)
   {
   Int_Query("API Example - Get_Histo function","There are measured too many objects.","OK");
   goto end;
   }
Int_CreateTextWindow("Wait a moment, please.\tProcessing Measured Data.",5,RGB(0,0,128),RGB_WHITE,70);
Get_ObjectFeatureData("Area",data,FIELD_TOTAL,0);
qw=Int_Question("API Example - Get_Histo Function","How many bins should contain the histogram?","5","10","20","40",BUTTON_3,0);
if(qw==BUTTON_1)
   num_bins=5;
if(qw==BUTTON_2)
   num_bins=10;
if(qw==BUTTON_3)
   num_bins=20;
if(qw==BUTTON_4)
   num_bins=40;
Get_Histo(histo,num_bins,data,num,bins,-num_bins);
Get_ObjectFeatureStats("Area",FIELD_TOTAL,&mean,&stdev,&minval,&maxval,0);
addit=maxval/num_bins;
for(index=0;index<num_bins;index=index+1)
   dhisto[index]=histo[index];
Int_GSCreateWindow("API Example",6,0,0,width-20,400);
Int_GSHistoData(dhisto,NULL,NULL,NULL,num_bins,0);
Int_GSHistoBins(bins+1,num_bins);
Int_GSLegend("Frequency",NULL,NULL,NULL);
Int_GSTitles("Area","", "Area distribution");
sprintf(user,"Mean: %.3f","mean");
Int_GSUserText(user);
Int_GSShow(GS_HISTO);
end:
Int_CloseTextWindow();

See Also 
Get_FieldFeatureName, Get_ObjectFeatureName

Get_IFeatureData

Description 

 Get_IFeatureData(
   int  FeatureConst,
   double *DoubleBuffer,
   int  ClassNumber
);

This function gets the specified feature data from a chosen class. This function is deprecated. See the Get_IFeatureSData function.

Parameters

int FeatureConst

Select a feature

0, IMF_COUNTS

Counts feature data

1, IMF_NUMBERS

Numbers feature data

2, IMF_LENGTH

Length feature data

3, IMF_ANGLE

Angle feature data

4, IMF_RADIUS

Radius feature data

5, IMF_DIAMETER

Diameter feature data

6, IMF_AXISA

Axis A feature data

7, IMF_AXISB

Axis B feature data

8, IMF_AREA

Area feature data

9, IMF_EQDIA

Eq. diameter feature data

10, IMF_MINFERET

Min. feret feature data

11, IMF_MAXFERET

Max. feret feature data

12, IMF_RED

Mean red feature data

13, IMF_GREEN

Mean green feature data

14, IMF_BLUE

Mean blue feature data

15, IMF_MEANGRAY

Mean gray feature data

16, IMF_MINGRAY

Min. gray feature data

17, IMF_MAXGRAY

Max. gray feature data

20, IMF_LUMINANCE

Luminance feature data

21, IMF_MEANBRIGHT

Mean brightness feature data

22, IMF_MINBRIGHT

Min. brightness feature data

23, IMF_MAXBRIGHT

Max. brightness feature data

24, IMF_INTBRIGHT

Integral brightness feature data

25, IMF_MEANDENS

Mean density feature data

26, IMF_MINDENS

Min. density feature data

27, IMF_MAXDENS

Max. density feature data

28, IMF_INTDENS

Integral density feature data

29, IMF_PERIMETER

Perimeter feature data

35, IMF_EXCIT

Excitation feature data

36, IMF_WAVELEN

Wavelength feature data

39, IMF_INTGRAY

Sum intensity feature data

40, IMF_LENGTHXY

Length XY feature data

41, IMF_LENGTHXYZ

Length XYZ feature data

44, IMF_HEIGHT

Height (3D) feature data

45, IMF_NDT

Time position data

46, IMF_NDZ

Z position data

47, IMF_NDM

Multipoint feature data

49, IMF_TIME

Time feature data

50, IMF_VELOCITY

Velocity feature data

51, IMFEAT_SHAPEFACTOR

Shape factor feature data

52, IMFEAT_ROUGHNESS

Roughness feature data

double *DoubleBuffer

The resulting output buffer is a field.

int ClassNumber

This parameter is being ignored, its presence ensures backward compatibility.

See Also 
Get_IFeatureSData

Get_IFeatureSData

Description 

 Get_IFeatureSData(
   char *FeatName,
   double *DoubleBuffer,
   int  ClassNumber
);

This function gets the specified feature data from a chosen class.

Parameters

char *FeatName

Name of the measurement feature.

double *DoubleBuffer

The resulting output buffer is a field.

int ClassNumber

This parameter is being ignored, its presence ensures backward compatibility.

Note

This function replaces the older Get_IFeatureData function which was based on constants instead of GUI names of the measurement features.

Get_IFeatureSValueString

Description 

 Get_IFeatureSValueString(
   char *Result,
   int  FeatName,
   int  Record
);

This function gets the specified string feature data from Manual measurement.

Parameters

char *Result

Address to the char array, filled on output.

int FeatName

Name of the measurement feature.

int Record

Number of the record.

See Also 
Get_NumIFeatureSRecords, Get_IFeatureSData

Get_IFeatureValueString

Description 

 Get_IFeatureValueString(
   char *Result,
   int  FeatureConst,
   int  Record
);

This function gets the specified string feature data from Manual measurement.

Parameters

char *Result

Address to the char array, filled on output.

int FeatureConst

Select feature.

42, IMF_SOURCE

Source feature data

43, IMF_CHANNEL

Channel feature data

48, IMF_COMMENT

Data comment

int Record

Number of the record.

Note

This function is deprecated

See Also 
Get_IFeatureSValueString

Get_NumFeatures

Description 

INT Get_NumFeatures(
   int  Meas
);

This function returns number of all features for object or field measurement.

Parameters

int Meas

Measurement type

1, MEAS_FIELD

Field measurement

0, MEAS_OBJECT

Object measurement

Return Values

INT

This function returns number of all features for object or field measurement.

// Get_NumFeatures example 
char buf[255];
int d1,d2;
d1 = Get_NumFeatures(MEAS_OBJECT);
d2 = Get_NumFeatures(MEAS_FIELD);
sprintf(buf,"There are %i object features and %i field features.\n\n\n","d1,d2");
WaitText(0,buf);

See Also 
Get_ObjectFeatureName, Get_FieldFeatureName, Get_ObjectFeatureStatus, Get_FieldFeatureStatus

Get_NumFields

Description 

int Get_NumFields(
   int  Meas
);

This function returns number number of measured fields in object or field measurement.

Parameters

int Meas

Measurement type

1, MEAS_FIELD

Field measurement

0, MEAS_OBJECT

Object measurement

Return Values

int

This function returns the number of fields

// Get_NumFields example - shows how to get the number of already measured fields.
long       number1, number2;
char       buf[256];
number1=Get_NumFields(MEAS_OBJECT,0);
number2=Get_NumFields(MEAS_FIELD,0);
sprintf(buf,"There are %i measured fields-object measurement.\nThere are %i measured fields-fieldmeasurement.","number1, number2");
WaitText(0,buf);

See Also 
Get_ObjectFeatureStats, Get_FieldFeatureStats, Get_ObjectFeatureData, Get_NumObjects, Get_FieldFeatureData

Get_NumIFeatureRecords

Description 

int Get_NumIFeatureRecords(
   int  FeatureConst
);

Returns number of records available for the specified feature in the Manual measurement.

Parameters

int FeatureConst

Select feature. Please see Get_IFeatureData or Get_IFeatureValueString for the list of available features.

Return Values

int

Number of records available for the specified feature.

Note

This function is deprecated.

See Also 
Get_NumIFeatureSRecords

Get_NumIFeatureSRecords

Description 

int Get_NumIFeatureSRecords(
   char *FeatName
);

Returns number of records available for the specified feature in the Manual measurement.

Parameters

char *FeatName

Name of the measurement feature.

Return Values

int

Number of records available for the specified feature.

Note

This function replaces the older Get_NumIFeatureSRecords function which was based on constants instead of GUI names.

See Also 
Get_IFeatureValueString, Get_IFeatureData

Get_NumObjects

Description 

LONG Get_NumObjects(
   int  Field,
   int  classval
);

This function returns the number of objects for the specific field (or for all fields) and for the specific class. The function is designed for object measurement.

Parameters

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int classval

Class number.

0

All classes.

1..12

The specified class.

Return Values

LONG

This function returns the number of objects for the specific field (or for all fields) and for the specific class classval.

See Also 
Get_ObjectFeatureValue, Get_Histo, Get_ObjectFeatureData, Get_NumFields, Get_FieldFeatureData

Get_NumObjectsInBinary

Description 

int Get_NumObjectsInBinary(
   int  Field,
   char *Binary,
   int  Class
);

Returns the number of objects for the specific field (or for all fields), specific binary layer and for the specific class. The function is designed for object automated measurement. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int Class

Class number.

0

All classes

1..12

The specified class

Return Values

int

This function returns the number of objects for the specific field (or for all fields) and for the specific class classval

See Also 
Get_NumObjects, Get_NumFields, Get_ObjectFeatureDataInBinary

Get_NumObjectsInBinaryAndRoi

Description 

 Get_NumObjectsInBinaryAndRoi(
   int  Field,
   char *Binary,
   int  RoiId,
   int  Class
);

Returns the number of objects for the specific field (or for all fields), specific binary layer and ROI and for the specific class. The function is designed for object automated measurement. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int RoiId

ROI ID.

int Class

Class number.

0

All classes

1..12

The specified class

Get_ObjectFeatureData

Description 

 Get_ObjectFeatureData(
   char *FeatName,
   double *lpData,
   int  Field,
   int  classval
);

This function fills the array of the double values with the featname values from objects that belong to the field and have classval class stamp.

Parameters

char *FeatName

Name of the measurement feature.

double *lpData

Address to the double array, filled on output.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int classval

Class number.

0

All classes.

1..12

The specified class.

Return Values

The function returns the number of objects that are filled in lpdata.

See Also 
Get_ObjectFeatureValue, Get_Histo, Get_NumObjects, Get_NumFields, Get_ObjectFeatureStats

Get_ObjectFeatureDataInBinary

Description 

int Get_ObjectFeatureDataInBinary(
   char *FeatName,
   double *lpData,
   int  Field,
   char *Binary,
   int  Class
);

Fills the array of the double values with the featname values from objects that belong to the field within the specified binary layer and have classval class stamp. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

double *lpData

Address to the double array, filled on output.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int Class

Class number.

0

All classes

1..12

The specified class

Return Values

int

The function returns the number of objects that are filled in lpdata

See Also 
Get_ObjectFeatureData, Get_NumObjectsInBinary, Get_ObjectFeatureValueInBinary, Get_ObjectFeatureValueString

Get_ObjectFeatureDataInBinaryAndRoi

Description 

 Get_ObjectFeatureDataInBinaryAndRoi(
   char *FeatName,
   int *lpdata,
   int  Field,
   char *Binary,
   int  RoiId,
   int  Class,
   char *SortFeatName,
   int *SortAscending
);

Fills the array of the double values with the FeatName values from objects in the binary layer and ROI. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int *lpdata

Address of the table with fixed string definition. The table is array of ints with indexes.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int RoiId

ROI ID.

int Class

Class number.

0

All classes

1..12

The specified class

char *SortFeatName

Name of the object feature by which the list is sorted.

int *SortAscending

Pointer to variable (of type int) into which the sorting order (ascending/descending) should be stored.

0

Sort descending.

1

Sort ascending.

Get_ObjectFeatureName

Description 

int Get_ObjectFeatureName(
   int  Index,
   char *FeatName
);

This function retrieves the name of the object feature according to the zero based index. Index parameter is the index to the array of all object features. The function fills featname on output.

Parameters

int Index

Index number (zero-based).

char *FeatName

Name of the measurement feature.

Return Values

int

The function returns TRUE (1) if featname is valid feature. If featname is invalid, function returns -1.

See Also 
Get_ObjectFeatureValue, Get_ObjectFeatureStatus, Get_ObjectFeatureData, Get_NumFeatures, Get_ObjectFeatureStats

Get_ObjectFeatureStats

Description 

 Get_ObjectFeatureStats(
   char *FeatName,
   int  Field,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal,
   int  classval
);

This function retrieves the basic statistical values of the specific feature from the specified field type and specified class.

Parameters

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

int classval

Class number.

0

All classes.

1..12

The specified class.

Return Values

The function returns the number of objects from which the statistics were calculated.

See Also 
Get_Histo, Get_NumObjects, Get_NumFields, Get_ObjectFeatureData

Get_ObjectFeatureStatsInBinary

Description 

int Get_ObjectFeatureStatsInBinary(
   char *FeatName,
   int  Field,
   char *Binary,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal,
   int  Class
);

Retrieves the basic statistical values of the specific feature from the specified field type within the specified binary layer and specified class. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

int Class

Class number.

0

All classes

1..12

The specified class

Return Values

int

The function returns the number of objects from which the statistics were calculated

See Also 
Get_ObjectFeatureStats, Get_NumObjectsInBinary, Get_ObjectFeatureDataInBinary

Get_ObjectFeatureStatsInBinaryAndRoi

Description 

 Get_ObjectFeatureStatsInBinaryAndRoi(
   char *FeatName,
   int  Field,
   char *Binary,
   int  ROI,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal,
   int  Class
);

Retrieves the basic statistical values of the specific feature from the specified ROI and binary layer. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

int Class

Class number.

0

All classes

1..12

The specified class

Get_ObjectFeatureStatsInBinaryAndRoiAndLocation

Description 

 Get_ObjectFeatureStatsInBinaryAndRoiAndLocation(
   char *FeatName,
   int  AutoMeasDataLocation,
   int  Field,
   char *Binary,
   int  ROI,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal,
   int  Class
);

Retrieves the basic statistical values of the specific feature from the specified ROI and binary layer and location. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int AutoMeasDataLocation

Location of the Automated Measurement Results data.

0

all data (default value)

1

current

2

stored

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

int Class

Class number.

0

All classes

1..12

The specified class

Get_ObjectFeatureStatus

Description 

INT Get_ObjectFeatureStatus(
   char *FeatName
);

This function returns TRUE (1) if the featname parameter is currently selected for object measurements.

Parameters

char *FeatName

Name of the measurement feature.

Return Values

INT

This function returns TRUE (1) if featname is currently selected for object measurements, if not selected, function returns FALSE (0). If featname is invalid, function return -1.

See Also 
Get_NumFeatures, Get_ObjectFeatureData, Get_ObjectFeatureValue, Get_ObjectFeatureName

Get_ObjectFeatureValue

Description 

 Get_ObjectFeatureValue(
   char *FeatName,
   int  Field,
   int  object,
   int  Class
);

This function returns the feature value of the object in the specified field.

Parameters

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int object

0..(number of objects -1)

The feature value of the specified object is counted.

int Class

Class number.

0

All classes

1..12

The specified class

Return Values

The feature value of the object in the specific field is returned.

Get_ObjectFeatureValueInBinary

Description 

double Get_ObjectFeatureValueInBinary(
   char *FeatName,
   int  Field,
   char *Binary,
   int  Object,
   int  Class
);

Returns the feature value of the object in the specified field within the specified binary layer. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int Object

object type

0..(number of objects - 1)

The feature value of the specified object is counted

int Class

Class number.

0

All classes

1..12

The specified class

Return Values

double

This function returns the value of feature featname for the specified object.

See Also 
Get_ObjectFeatureValue, Get_ObjectFeatureDataInBinary, Get_NumObjectsInBinary

Get_ObjectFeatureValueInBinaryAndRoi

Description 

 Get_ObjectFeatureValueInBinaryAndRoi(
   char *FeatName,
   int  Field,
   char *Binary,
   int  RoiId,
   int  Object,
   int  Class,
   char *SortFeatName,
   int *SortAscending
);

Returns the feature value of the object in the specified field within the specified binary layer and ROI. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int RoiId

ROI ID.

int Object

object type

0..(number of objects - 1)

The feature value of the specified object is counted

int Class

Class number.

0

All classes

1..12

The specified class

char *SortFeatName

Name of the object feature by which the list is sorted.

int *SortAscending

Pointer to variable (of type int) into which the sorting order (ascending/descending) should be stored.

0

Sort descending.

1

Sort ascending.

Get_ObjectFeatureValueString

Description 

int Get_ObjectFeatureValueString(
   char *Result,
   char *FeatName,
   int  Field,
   char *Binary,
   int  Object,
   int  Class
);

Returns the feature value of the object in the specified field within the specified binary layer. The feature must have the string type. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *Result

Address to the char array, filled on output.

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int Object

object type

0..(number of objects - 1)

The feature value of the specified object is counted

int Class

Class number.

0

All classes

1..12

The specified class

Return Values

int

Returns 0 when successful.

See Also 
Get_ObjectFeatureValue, Get_ObjectFeatureValueInBinary, Get_ObjectFeatureDataInBinary, Get_NumObjectsInBinary

Get_ObjectFeatureValueStringInBinaryAndRoi

Description 

 Get_ObjectFeatureValueStringInBinaryAndRoi(
   char *Result,
   char *FeatName,
   int  Field,
   char *Binary,
   int  ROI,
   int  Object,
   int  Class,
   char *SortFeatName,
   int *SortAscending
);

Returns the feature value of the object in the specified field within the specified binary layer and ROI. The feature must have the string type. Enter NULL (0) or an empty string into the Binary parameter to get all values regardless of the source binary layer.

Parameters

char *Result

Address to the char array, filled on output.

char *FeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

char *Binary

Name of the binary layer.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

int Object

object type

0..(number of objects - 1)

The feature value of the specified object is counted

int Class

Class number.

0

All classes

1..12

The specified class

char *SortFeatName

Name of the object feature by which the list is sorted.

int *SortAscending

Pointer to variable (of type int) into which the sorting order (ascending/descending) should be stored.

0

Sort descending.

1

Sort ascending.

Get_ROIFeatureData

Description 

int Get_ROIFeatureData(
   char *FieldFeatName,
   double *lpData,
   int  Field
);

Fills the array of the double values with the featname values from ROIs that belong to the field in Automated measurement.

Parameters

char *FieldFeatName

Name of the measurement feature.

double *lpData

Address to the double array, filled on output.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

Return Values

int

The function returns the number of objects that are filled in lpdata.

See Also 
Get_ObjectFeatureData, Get_ROINumObjects, Get_ROIFeatureValue, Get_ROIFeatureStats

Get_ROIFeatureStats

Description 

int Get_ROIFeatureStats(
   char *FieldFeatName,
   int  Field,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal
);

Retrieves the basic statistical values of the specified measurement feature from the specified field.

Parameters

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

Return Values

int

The function returns the number of ROIs from which the statistics were calculated.

See Also 
Get_ObjectFeatureStats, Get_ROIFeatureData, Get_ROINumObjects, Get_ROIFeatureValue

Get_ROIFeatureStatsInLocation

Description 

 Get_ROIFeatureStatsInLocation(
   char *FieldFeatName,
   int  AutoMeasDataLocation,
   int  Field,
   double *LpMean,
   double *LpStDev,
   double *LpMinVal,
   double *LpMaxVal
);

Retrieves the basic statistical values of the specified measurement feature from the specified field and location.

Parameters

char *FieldFeatName

Name of the measurement feature.

int AutoMeasDataLocation

Location of the Automated Measurement Results data.

0

all data (default value)

1

current

2

stored

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

double *LpMean

Pointer to the mean value, filled on output. Macro is responsible for buffer allocation.

double *LpStDev

Pointer to the standard deviation value.

double *LpMinVal

Pointer to the minimum value of the specified feature.

double *LpMaxVal

Pointer to the maximum value, filled on the output. Macro is responsible for buffer allocation.

Get_ROIFeatureValue

Description 

double Get_ROIFeatureValue(
   char *FieldFeatName,
   int  Field,
   int  ROI
);

Returns the feature value of the ROI in the specified field in Automated measurement.

Parameters

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

Return Values

double

This function returns the value of feature featname for the specified ROI.

See Also 
Get_ROINumObjects, Get_ROIFeatureValueString

Get_ROIFeatureValueString

Description 

int Get_ROIFeatureValueString(
   char *Result,
   char *FieldFeatName,
   int  Field,
   int  ROI
);

Returns the feature value of the ROI in the specified field in Automated measurement. The feature must have the string type.

Parameters

char *Result

Address to the char array, filled on output.

char *FieldFeatName

Name of the measurement feature.

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

int ROI

Number of the ROI displayed in the image or:

0,-1

All ROIs

-2

The currently selected ROIs

Return Values

int

Returns 0 when successful.

See Also 
Get_ROIFeatureValue

Get_ROINumObjects

Description 

int Get_ROINumObjects(
   int  Field
);

This function returns the number of ROIs for the specific field (or for all fields). It is designed for object automated measurement.

Parameters

int Field

Specifies the field.

0

The first field.

1

The second field, etc.

-1, FIELD_TOTAL

All fields.

-2, FIELD_LAST

The last field.

Return Values

int

The function returns the number of ROIs.

See Also 
Get_NumFields, Get_ROIFeatureValue

Get_TableFeatureData

Description 

 Get_TableFeatureData(
   char *FeatName,
   char *ColumnName,
   double *lpData
);

This function returns specified feature data from the Statistics table of the Automated Measurement Results panel.

Parameters

char *FeatName

Name of the measurement feature.

char *ColumnName

Buffer with the column name.

double *lpData

Address to the double array, filled on output.

ResetAutoMeasData

Description 

 ResetAutoMeasData();

This function removes all results of the automated measurement of an image from the Automated Measurement Results control window.

Copyright 1991-2024 Laboratory Imaging s.r.o.