Filters
Filter values by
Dataset context
  • Images
  • Features
| Customize Help
| Save Settings

MclassInquireEntry


Function Map
Syntax
Description
Parameters
- DatasetContextClassId
- EntryIndex
Table: For specifying the index of an entry
- EntryKey
Table: For specifying the unique key of an entry
- RegionIndex
Table: For specifying which region to inquire
- InquireType
- UserVarPtr
Parameter Associations
Table: For an entry in a dataset context (images or features)
Table: For an entry or a region of an entry in a dataset context (images or features)
+ combination: For inquiring the required array size (number of elements) to store the returned values
+ combination: For inquiring the default value of an inquire type
+ combination: For inquiring the size of a string
+ combination: For inquiring whether an inquire type is supported
+ combination: For casting the requested information to the required data type
Return value
Compilation information
Synopsis
Inquire about an entry in a dataset context.
Syntax
MIL_INT MclassInquireEntry(
MIL_ID DatasetContextClassId, //in
MIL_INT64 EntryIndex, //in
MIL_UUID EntryKey, //in
MIL_INT64 RegionIndex, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function allows you to inquire about an entry in a dataset context using its index or key. You can typically control these settings, using MclassControlEntry().

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
DatasetContextClassId

Specifies the identifier of the dataset about which to inquire settings. These contexts are allocated using MclassAlloc() with M_DATASET_IMAGES or M_DATASET_FEATURES.

EntryIndex

Specifies the index of the entry about which to inquire.

When you specify an index with EntryIndex, you must set the EntryKey parameter to M_DEFAULT_KEY.

Note that both EntryIndex and EntryKey cannot be set to M_DEFAULT simultaneously.

function map For specifying the index of an entry
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies that the index of an entry is not required.
Click to summarize Value >= 0

Specifies the index of an entry.
EntryKey

Specifies the key (MIL_UUID) of the entry about which to inquire.

When you specify an entry key with EntryKey, you must set the EntryIndex parameter to M_DEFAULT.

Note that both EntryIndex and EntryKey cannot be set to M_DEFAULT simultaneously.

function map For specifying the unique key of an entry
Click to summarizeValue Description
Click to summarize M_DEFAULT_KEY

Specifies that the unique key of an entry is not required.
Click to summarize Value

Specifies the unique key of an entry.
RegionIndex

Specifies which region in an entry to inquire. For an images dataset, there is always at least one region in the dataset, at index 0. For a features dataset, use M_DEFAULT.

function map For specifying which region to inquire
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies that the function call refers to the entry, and not to a specific region within the entry.
Click to summarize

Specifies the region to inquire, using its index.

Refers to a specific region within the entry. Note that there is always at least one region in an entry.

This value only applies to an images dataset context.

(summarize)
Parameters

Set this parameter to the following:
0 <= Value < M_NUMBER_OF_REGIONS

Specifies the index.
InquireType

Specifies the type of inquire.

See the Parameter associations section for possible values that can be specified.

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64
  • MIL_UUID

Specifies the address in which to write the requested information.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

To inquire about an entry in a dataset, the InquireType parameter can be set to the following values. In this case, set the DatasetContextClassId parameter to the identifier of either an images dataset context or a features dataset context, unless otherwise specified, and set the RegionIndex parameter to M_DEFAULT.

function map For an entry in a dataset context (images or features)
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_AUGMENTATION_SOURCE +

Inquires whether an entry is an augmented entry, according to the index. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_NOT_AUGMENTED

Specifies that the entry is not an augmented entry.
Click to summarize M_UNKNOWN

Specifies that the entry is augmented, however, the original data is not known.
Click to summarize Value >= 0

Specifies that the entry is augmented, and that it originates from (was performed with) the specified entry index. INFO
Click to summarize M_AUGMENTATION_SOURCE_KEY +

Inquires whether an entry is an augmented entry, according to the defined key (UUID). SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_UUID
Click to summarize M_NULL_KEY

Specifies that the entry is not an augmented entry.
Click to summarize M_UNKNOWN_KEY

Specifies that the entry is augmented, and that the entry key (UUID) from which it was augmented is not known.
Click to summarize MIL_UUID Value

Specifies that the entry is augmented, and that it originates from (was performed with) the specified key. INFO
Click to summarize M_ENTRY_KEY +

Inquires the unique identifier for an entry.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_UUID
Click to summarize M_ENTRY_USER_STRING +

Inquires the user string that holds meta information. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize MIL_TEXT("String") 1

Specifies a string containing meta information. INFO
Click to summarize M_ENTRY_WEIGHT +

Inquires the weight that indicates the importance of the feature entry.

This value only applies to a features dataset context. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 1.0.
Click to summarize Value >= 0.0

Specifies the weight, as a double.
Click to summarize M_FILE_PATH +

Inquires the file path, such that M_ROOT_PATH + M_FILE_PATH gives a valid path. If M_ROOT_PATH is empty, M_FILE_PATH should be an absolute path, otherwise it should be a relative path to M_ROOT_PATH.

This value only applies to an images dataset context. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize MIL_TEXT("///DATASET///") 1

Specifies the path where the dataset is saved after calling MclassSave(). INFO
Click to summarize MIL_TEXT("FilePath") 1

Specifies the file path.
Click to summarize M_FILE_PATH_ABS +

Inquires the absolute path of the image (for an entry), which is the concatenation of M_ROOT_PATH + M_FILE_PATH (only for M_DATASET_IMAGES).

This value only applies to an images dataset context.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize M_DEFAULT

Specifies the default file path.
Click to summarize MIL_TEXT("FilePath") 1

Specifies the file path.
Click to summarize M_NUMBER_OF_REGIONS +

Inquires the number of regions in this entry.

This value only applies to an images dataset context.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value > 0

Specifies the number of regions, as an integer.
Click to summarize M_RAW_DATA +

Inquires an array of feature values (set of features).

This value only applies to a features dataset context. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_NULL

Specifies no values.
Click to summarize M_USER_CONFIDENCE +

Inquires how confident you are in the entry's ground truth (M_CLASS_INDEX_GROUND_TRUTH).

This value only applies to an images dataset context. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_DEFAULT

Specifies the default value; the default value is 0.0.
Click to summarize Value

Specifies the user confidence.

1 If the value was passed in a variable, it won't be returned enclosed in MIL_TEXT().

To inquire about a region in an entry or to inquire about an entry, the InquireType parameter can be set to the following values. In this case, set the DatasetContextClassId parameter to the identifier of any dataset context, unless otherwise specified. For an images dataset context, set the RegionIndex parameter to M_REGION_INDEX() with an index of 0, and for a features dataset context, set the RegionIndex parameter to M_DEFAULT.

function map For an entry or a region of an entry in a dataset context (images or features)
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_AUTHOR_NAME +

Inquires the author's name. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Click to summarize MIL_TEXT("Name") 1

Specifies the author's name.
Click to summarize M_CLASS_INDEX_GROUND_TRUTH +

Inquires the index of the class definition that represents the entry's ground truth.

If there is no ground truth index, M_CLASS_INDEX_GROUND_TRUTH returns nothing to UserVarPtr. To inquire if there is any ground truth index set, use M_CLASS_INDEX_GROUND_TRUTH + M_NB_ELEMENTS. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value >= 0

Specifies the class definition index (ground truth), as an integer. INFO
Click to summarize M_CLASS_INDEX_PREDICTED +

Inquires the prediction class definition indices.

If there are no indices, M_CLASS_INDEX_PREDICTED returns nothing to UserVarPtr. To inquire if there are any indices to retrieve, use M_CLASS_INDEX_PREDICTED + M_NB_ELEMENTS.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_DEFAULT

Specifies the default.
Click to summarize Value >= 0

Specifies the prediction class definition index, as an integer.
Click to summarize M_PREDICTED_CLASS_SCORES +

Inquires the prediction's class scores. There is a score for each class.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_NULL

Specifies no score.
Click to summarize Value >= 0.0

Specifies the score.
Click to summarize M_REGION_TYPE +

Inquires the type of the region.

This value only applies to an images dataset context.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_WHOLE_IMAGE.
Click to summarize M_WHOLE_IMAGE

Specifies that the region type of the entry is set to the whole image.

1 If the value was passed in a variable, it won't be returned enclosed in MIL_TEXT().

Combination value for M_CLASS_INDEX_GROUND_TRUTH; M_CLASS_INDEX_PREDICTED; M_PREDICTED_CLASS_SCORES; M_RAW_DATA.

You can add the following value to the above-mentioned values to determine the required array size (number of elements) to store the returned values.

function map For inquiring the required array size (number of elements) to store the returned values
Click to summarizeInquireType combination value Description
UserVarPtr
- Possible values returned
Click to summarize M_NB_ELEMENTS

Retrieves the required array size (number of elements) to store the returned values.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Combination value for M_AUGMENTATION_SOURCE; M_AUGMENTATION_SOURCE_KEY; M_REGION_TYPE; M_USER_CONFIDENCE.

You can add the following value to the above-mentioned values to determine the default value of an inquire type, regardless of the current value of the inquire type.

function map For inquiring the default value of an inquire type
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_DEFAULT

Inquires the default value of the specified inquire type.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Combination value for M_AUTHOR_NAME; M_ENTRY_USER_STRING; M_FILE_PATH; M_FILE_PATH_ABS.

You can add the following value to the above-mentioned values to get the size of a string.

function map For inquiring the size of a string
Click to summarizeInquireType combination value Description
UserVarPtr
- Possible values returned
Click to summarize M_STRING_SIZE +

Inquires the number of characters in the string. This number accounts for every character, including the terminating null character.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Combination value for the values listed in For an entry in a dataset context (images or features); the values listed in For an entry or a region of an entry in a dataset context (images or features).

You can add the following value to the above-mentioned values to determine whether an inquire type is supported.

function map For inquiring whether an inquire type is supported
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_SUPPORTED

Inquires whether the specified inquire type is supported for the dataset entry.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_NULL

Specifies that the inquire type is not supported.
Click to summarize Value != 0

Specifies that the inquire type is supported.
Combination values for M_AUGMENTATION_SOURCE; M_CLASS_INDEX_GROUND_TRUTH; M_CLASS_INDEX_PREDICTED; M_ENTRY_KEY; M_NUMBER_OF_REGIONS; M_RAW_DATA; M_REGION_TYPE; M_STRING_SIZE; M_USER_CONFIDENCE.

You can add one of the following values to the above-mentioned values to cast the requested results to the required data type.

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

function map For casting the requested information to the required data type
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested results to a MIL_DOUBLE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]  |  address of a MIL_DOUBLE MORE
Click to summarize M_TYPE_MIL_ID

Casts the requested results to a MIL_ID.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]  |  address of a MIL_ID MORE
Click to summarize M_TYPE_MIL_INT

Casts the requested results to a MIL_INT.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]  |  address of a MIL_INT MORE
Click to summarize M_TYPE_MIL_INT32

Casts the requested results to a MIL_INT32.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]  |  address of a MIL_INT32 MORE
Click to summarize M_TYPE_MIL_INT64

Casts the requested results to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]  |  address of a MIL_INT64 MORE
Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information.
Compilation information
Header Include mil.h.
Library Use mil.lib; milclass.lib.
DLL Requires mil.dll; milclass.dll.
DEFAULT DEFAULT KEY DEFAULT NUMBER OF REGIONS AUGMENTATION SOURCE NOT AUGMENTED UNKNOWN AUGMENTATION SOURCE KEY NULL KEY UNKNOWN KEY ENTRY KEY ENTRY USER STRING ENTRY WEIGHT DEFAULT FILE PATH FILE PATH ABS DEFAULT NUMBER OF REGIONS RAW DATA NULL USER CONFIDENCE DEFAULT AUTHOR NAME CLASS INDEX GROUND TRUTH CLASS INDEX PREDICTED DEFAULT PREDICTED CLASS SCORES NULL REGION TYPE DEFAULT WHOLE IMAGE NB ELEMENTS DEFAULT STRING SIZE SUPPORTED NULL TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64