MclassRestore

See also

Reference:

MclassPredict MclassPreprocess MclassSave MclassStream MclassTrain MsysAlloc

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux with restrictions

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

classprintedchar.cpp
classseafoodinspect.cpp
classsurfacesteel.cpp
mclass.cpp
mclass.cs
mclass.vb

Function Map

- FileName

Table:

For specifying the file name and path of the context to restore

- SysId

Table:

For specifying the system identifier

- ControlFlag

- ContextClassIdPtr

Return value

Compilation information

Synopsis

Restore a classification context (classifier, training, or dataset) from disk.

Syntax

MIL_ID MclassRestore(

MIL_CONST_TEXT_PTR FileName,	//in
MIL_ID SysId,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContextClassIdPtr	//out

)

Description

This function restores a classification context (classifier, training, or dataset) that was previously saved to a file, using MclassSave() or MclassStream().

This function restores all of the context's settings that were in effect when the context was saved. A restored context is not preprocessed; if the context requires preprocessing, you must call MclassPreprocess() before calling MclassTrain() or MclassPredict().

Note, it is possible to restore a pretrained CNN classifier context that Matrox has built and trained to address your specific requirements (as opposed to a predefined CNN classifier context that you have trained). For more information about having Matrox provide this service to you, contact customer support.

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

FileName

Specifies the name and path of the file from which to restore the classification context (classifier, training, or dataset). The function handles (internally) the opening and closing of the file. For easier use with other Matrox Imaging software products, classifier context and training context files should have an MCLASS extension. Dataset context files should have an MCLASSD extension.

Set this parameter to one of the values below:

For specifying the file name and path of the context to restore
Value	Description
M_INTERACTIVE	[This is only applicable to Windows] Opens a dialog box from which you can interactively specify the drive, directory, and name of the file.
MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the classification context file (for example, "C:\mydirectory\WePutTheArtInArtificialIntelligence.mclass"). Classifier context and training context files should have an MCLASS extension. Dataset context files should have an MCLASSD extension. To specify a context file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\WePutTheArtInArtificialIntelligence.mclass"). (summarize) Specifies the drive, directory, and name of the classification context file (for example, "C:\mydirectory\WePutTheArtInArtificialIntelligence.mclass"). (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

SysId

Specifies the identifier of the system on which to restore the classification context (classifier, training, or dataset) to disk.

Set this parameter to one of the values below:

For specifying the system identifier
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ContextClassIdPtr

Specifies the address of the variable in which to write the classification context identifier. Since this function also returns the context identifier, you can set this parameter to M_NULL. If this fails, M_NULL is written as the identifier.

Return value

The returned value is the classification context identifier. If this fails, M_NULL is returned.

Compilation information

Header	Include mil.h.
Library	Use mil.lib; milclass.lib.
DLL	Requires mil.dll; milclass.dll.