General

_BatchAnalysis, _BatchGeneralAnalysis, _BatchSPT, _CreateNewRecipe, _EditExistingAnalysis, _Load_Settings, _NewGeneralAnalysis, _OpenExistingAnalysis, _OpenExistingRecipe, _RunApplication, _RunApplicationConventional, _RunGeneralAnalysis, _RunGeneralAnalysis3, _RunGeneralAnalysisInWizard, _RunGeneralAnalysisRGBInWizard, _ShowAnalysisRunResults, _ShowAnalysisRunResultsGraph, _ShowAnalysisRunResultsReport, _ShowAnalysisRunResultsTable, _ShowAnalysisSumResults, _ShowAnalysisSumResultsGraph, _ShowAnalysisSumResultsReport, _ShowAnalysisSumResultsTable, _ShowUserManager, _SMTPConfig, BatchAnalysis, Beep, Convert_ms_To_Time, Enable_Special_Actions, EnableContextMenu, Load_Settings, RemoveInputMessages, RunApplicationConventional, RunGeneralAnalysis, RunGeneralAnalysisDB, Save_Configuration, Save_Settings, SetReferenceTime, SMSSend, SMTPConfig, SMTPSendEmail

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

RunGeneralAnalysis

Interactive command to this function: Image > General Analysis

Description 

 RunGeneralAnalysis(
   char *RecipeName,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

Executes the general analysis.

Parameters

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

RunGeneralAnalysisDB

Description 

 RunGeneralAnalysisDB(
   char *RecipeName,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

Runs the specified General Analysis 2 recipe.

Parameters

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

SMSSend

Description 

 SMSSend(
   char *PhoneNumber,
   char *Country,
   char *Carrier,
   char *Message
);

Sends Short Message Service (SMS) notifications.

Parameters

char *PhoneNumber

Recipient's phone number.

char *Country

Country where you want to use the SMS notification.

char *Carrier

Select the local mobile operator of the entered phone number.

char *Message

Type in your message. (Message body - the actual text of the message.)

SMTPConfig

Interactive command to this function: HCA/JOBS > Presets > Email Setup

Description 

 SMTPConfig(
   char *SMTPServerName,
   int  SMTPPort,
   int  SMTPUseDefalutSecurityType,
   int  SMTPSecurityType,
   char *SMTPLogin,
   char *SMTPPassword,
   char *SMTPSenderMail,
   char *SMTPSenderName
);

This function specifies server/mail settings which are used when the SMTPSendEmail function is called.

Parameters

char *SMTPServerName

SMTP server name. e.g. “smtp.mydomainname.com” or “mail.mydomainname.com”

int SMTPPort

Port number

int SMTPUseDefalutSecurityType

Set security type based on the port number?

0

Use security type specified by the SMTPSecurityType parameter.

1

The SMTPSecurityType parameter is ignored. The security type is recognized according to SMTPPort (465:USE_SSL, 587:USE_TLS, 25 or any other:NO_SECURITY)

int SMTPSecurityType

Security protocol to be used for connection to the mailserver. Different protocols usually use different port numbers.

0

No encryption

1

TLS

2

SSL

char *SMTPLogin

If the SMTP server requires authentication, fill in the appropriate user account name e.g. “firstname.surname”.

char *SMTPPassword

If the SMTP server requires authentication, fill in the password for the SMTPLogin account

char *SMTPSenderMail

Email address which will be displayed in the “from” field (and also used as the reply-to address)

char *SMTPSenderName

“Alias” of the sender email - usually a human-readable equivalent of the email address. E.g. “Peter Smith” for an address such as ps001@company.com

See Also 
SMTPSendEmail

SMTPSendEmail

Description 

 SMTPSendEmail(
   char *RecipientName,
   char *Subject,
   char *Message
);

This function sends an e-mail to the specified recipient. SMTP server must be configured correctly using the SMTPConfig or _SMTPConfig functions.

Parameters

char *RecipientName

Email address of the recipient

char *Subject

Message subject

char *Message

Type in your message. (Message body - the actual text of the message.)

See Also 
SMTPConfig, _SMTPConfig

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.

_BatchGeneralAnalysis

Description 

 _BatchGeneralAnalysis();

Opens the Batch General Analysis 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

This function runs the Image > New GA3 recipe command.

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.

_RunGeneralAnalysis

This function runs the Image > General Analysis command.

Description 

 _RunGeneralAnalysis(
   char *ApplicationName
);

This function displays a pop-up window containing General Analysis settings.

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.

_RunGeneralAnalysis3

This function runs the Image > Most Recent GA3 recipe command.

Description 

 _RunGeneralAnalysis3();

Opens the General Analysis 3 dialog window.

_RunGeneralAnalysisInWizard

Description 

 _RunGeneralAnalysisInWizard();

Opens the General Analysis window.

_RunGeneralAnalysisRGBInWizard

Description 

 _RunGeneralAnalysisRGBInWizard();

Opens the General Analysis RGB in the wizard mode. This is the same as if the analysis is edited, placed into wizard, closed and then executed from Analysis Explorer using the Run Wizard on current document button.

_SMTPConfig

This function runs the HCA/JOBS > Presets > Email Setup command.

Description 

 _SMTPConfig();

Displays a GUI window where SMTP settings can be configured.

_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.

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