General

_BatchAnalysis, _BatchSPT, _CreateNewRecipe, _EditExistingAnalysis, _Load_Settings, _NewGeneralAnalysis, _OpenExistingAnalysis, _OpenExistingRecipe, _RunApplication, _RunApplicationConventional, _ShowAnalysisRunResults, _ShowAnalysisRunResultsGraph, _ShowAnalysisRunResultsReport, _ShowAnalysisRunResultsTable, _ShowAnalysisSumResults, _ShowAnalysisSumResultsGraph, _ShowAnalysisSumResultsReport, _ShowAnalysisSumResultsTable, _ShowUserManager, BatchAnalysis, Beep, Convert_ms_To_Time, Enable_Special_Actions, EnableContextMenu, Load_Settings, RemoveInputMessages, RunApplicationConventional, Save_Configuration, Save_Settings, SetReferenceTime

BatchAnalysis

Description

 BatchAnalysis(
   char *RecipeName,
   char *BatchAnalysisDir,
   int  BatchAnalysisIncludeSubdirs
);

Runs the Batch Analysis.

Parameters

char *RecipeName

Name of the analysis recipe stored in the database.

char *BatchAnalysisDir

Path to the directory where images to be batch-processed are stored.

int BatchAnalysisIncludeSubdirs

0	Process only the top-level files.
1	Process all files including subdirectories.

Beep

Description

 Beep();

This function plays a sound corresponding to a given system alert level. The function has no menu equivalent.

Convert_ms_To_Time

Description

 Convert_ms_To_Time(
   int *ms,
   int *sec,
   int *min,
   int *hour,
   int  time
);

This function converts the time from millisecond-value to the sequence of ms, sec and hour values.

Parameters

int *ms

milliseconds

int *sec

seconds

int *min

minutes

int *hour

Hours.

int time

input time

See Also
Get_UserTime

EnableContextMenu

Description

 EnableContextMenu(
   int  EnableMenu
);

This function enables/disables context menu in the picture window.

Parameters

int EnableMenu

Enables or disables the context menu.

0	Disables the menu.
1	Enables the menu.

Return Values

The function returns TRUE.

Enable_Special_Actions

Description

 Enable_Special_Actions(
   int  Enabled
);

This function enables/disables special mouse actions such as caption, status bar left double-click or toolbar right double-click.

Parameters

int Enabled

0	Disabled.
1	Enabled.

See Also
EnableButtons

Load_Settings

Description

 Load_Settings(
   char *Filename
);

This function loads settings from the specified BIN file which was previously created by the Save_Settings function.

Parameters

char *Filename

The path and the name of the file.

See Also
_Load_Settings

RemoveInputMessages

Description

 RemoveInputMessages();

This function removes the keyboard and mouse input messages from the application queue.

RunApplicationConventional

Description

 RunApplicationConventional(
   char *ApplicationName,
   char *RecipeName,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

Displays the window of one of the Bio Analysis module conventional applications.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

char *RecipeName

Name of the analysis recipe stored in the database.

int NDTLoop

0	apply to the current loop only
1	apply to the whole Time dimension

int NDMPLoop

Apply to Multi Point dimension.

0	apply to the current loop only
1	apply to the whole Multi Point dimension

int NDZLoop

Apply to Z dimension

0	apply to the current loop only
1	apply to the whole Z Series dimension

Save_Configuration

Description

 Save_Configuration();

This function saves the current application configuration.

Note

You can invoke this function by selecting the application system menu > Save Configuration command or directly via shortcut Shift+Alt+F4.

Save_Settings

Description

 Save_Settings(
   char *Filename,
   int  Mask
);

This function saves the selected type of settings to an external *.bin file.

Parameters

char *Filename

The path and the name of the file.

int Mask

Specify which settings should be included in the file.

1	General Settings
2	ControlsToolbar
4	Kernels
8	GUI Layouts
16	NDSequence
32	MultipointSet
64	ND Setup
128	Objectives
256	Optical Configurations
512	Pixel Classifier
1024	SystemInfo
2048	Threshold
4096	Custom Filter Data
8192	Devices
16384	UserManager
32768	Cameras
65536	User Kernels
131072	ZStack
262144	Cameras

SetReferenceTime

Description

 SetReferenceTime();

This function sets the reference time to the current time.

_ShowUserManager

Description

 _ShowUserManager();

This function displays the Edit > General Options > User Rights dialog window. User groups and their rights can be edited there.

_BatchAnalysis

Description

 _BatchAnalysis();

Opens the Batch Analysis dialog window.

_BatchSPT

Description

 _BatchSPT();

Opens the Batch Single Particle Analysis window.

_CreateNewRecipe

Description

 _CreateNewRecipe(
   char *ApplicationName
);

Opens the specified analysis so that a new recipe can be created.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

_EditExistingAnalysis

Description

 _EditExistingAnalysis(
   char *ApplicationName,
   char *Name
);

Opens the selected analysis window for editing.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

char *Name

Name of the analysis defined by the user.

_Load_Settings

Description

 _Load_Settings();

This function loads the settings from an external *.bin file. The *.bin files are produced by the Save_Settings function.

See Also
Save_Settings

_NewGeneralAnalysis

Description

 _NewGeneralAnalysis(
   char *ApplicationName
);

Opens the analysis specified in the ApplicationName parameter.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

_OpenExistingAnalysis

Description

 _OpenExistingAnalysis(
   char *ApplicationName,
   char *Name
);

Opens the analysis based on the following parameters.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

char *Name

Name of the analysis defined by the user.

_OpenExistingRecipe

Description

 _OpenExistingRecipe(
   char *ApplicationName,
   char *Name
);

Opens an existing analysis recipe of the given name.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

char *Name

Name.

_RunApplication

Description

 _RunApplication(
   char *ApplicationName
);

Displays the window of one of the Bio Analysis module conventional applications. A Timelapse-only ND2 file must be opened in order for the function to work.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

_RunApplicationConventional

Description

 _RunApplicationConventional(
   char *ApplicationName
);

Displays the window of one of the Bio Analysis module conventional applications. A Timelapse-only ND2 file must be opened in order for the function to work.

Parameters

char *ApplicationName

Application ID

LimCellCountVer1	Cell Count
CellMotilityVer1	Cell Motility
LimCellProliferationVer1	Cell Proliferation
LimGeneralAnalysisRgbVer1	General analysis RGB
LimDOLVer1	Live or Dead on DIC
LimWoundHealingVer1	Wound Healing
NULL	Searches among all analyses only by its Name.

See Also
_RunApplication

_ShowAnalysisRunResults

Description

 _ShowAnalysisRunResults(
   int64  DbKey,
   char *Title
);

Displays the analysis results in a summary table. Title parameter is the address of the buffer that receives a title.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

_ShowAnalysisSumResults

Description

 _ShowAnalysisSumResults(
   int64  DbKey,
   char *Title
);

More analysis results are shown in a summary table. Title parameter is the address of the buffer that receives a title.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

_ShowAnalysisRunResultsGraph

Description

 _ShowAnalysisRunResultsGraph(
   int64  DbKey,
   char *Title
);

Displays the results graph of the specified analysis run.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

_ShowAnalysisRunResultsReport

Description

 _ShowAnalysisRunResultsReport(
   int64  DbKey,
   char *Title
);

Displays the results report of the specified analysis run.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

_ShowAnalysisRunResultsTable

Description

 _ShowAnalysisRunResultsTable(
   int64  DbKey,
   char *Title
);

Displays the results table of the specified analysis run.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

_ShowAnalysisSumResultsGraph

Description

 _ShowAnalysisSumResultsGraph(
   int64  DbKey,
   char *Title
);

Displays the summary results graph of the specified job run.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

_ShowAnalysisSumResultsReport

Description

 _ShowAnalysisSumResultsReport(
   int64  DbKey,
   char *Title
);

Displays the summary results report of the specified job run.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

_ShowAnalysisSumResultsTable

Description

 _ShowAnalysisSumResultsTable(
   int64  DbKey,
   char *Title
);

Displays the summary results table of the specified job run.

Parameters

int64 DbKey

This parameter is not documented.

char *Title

Title name.

General🔗

Note

General