_EDF_CreateEDFFocusedNewDoc, _EDF_CreateFocusedImageDef, _EDF_EditBackground, _EDF_EditFocusedArea, _EDF_OpenSequence, _EDF_RealTimeEDF, _EDF_RealTimeEDFManually, _EDF_ZMapSetting, EDF_3DFocusAtOnce, EDF_3DFocusAtOnceParams, EDF_AlignSequence, EDF_CreateAnaglyph, EDF_CreateEDFFocusedNewDoc, EDF_CreateFocusedImage, EDF_CreateFocusedImageDef, EDF_DefineImages, EDF_ExportZMapToFile, EDF_GetFocusedZPos, EDF_MeasureZProfile, EDF_NewEDFFocusedDoc, EDF_RealTimeEDF, EDF_ShowAnaglyph, EDF_ShowSurfaceView, EDF_ShowZMapImage, EDF_ZMapSettingToggle

EDF_3DFocusAtOnce

Description 

 EDF_3DFocusAtOnce(
   char *FileSpec,
   int  UseAutoFitting
);

This function will go through the whole process of creating the focused image. At first, it opens the image sequence from given directory, then (if you want) applies Auto fitting, and, finally, creates the focused image. You will see the work progress on the screen. To select the method for focusing, use function EDF_3DFocusAtOnceParams .

Parameters

char *FileSpec

Path and file mask (including extension) of images forming the sequence. For example, this is correct FileSpec: C:\Images\EDF\Crystal\*.jp2

int UseAutoFitting

Use auto fitting algorithm or not. Skipping the Auto fitting can save the time and avoid some mistakes in case that the source sequence is already aligned.

0	Skip Auto fitting
1	Use Auto fitting

Return Values

The function returns TRUE if successful otherwise it returns FALSE.

EDF_3DFocusAtOnceParams

Description 

 EDF_3DFocusAtOnceParams(
   char *FileSpec,
   int  nAutoFittingMethod,
   int  nFocusingMethod,
   int  nFocusingParam1,
   int  nFocusingParam2
);

This function will go through the whole process of creating the focused image. At first, it opens the image sequence from given directory, then (if you want) applies Auto fitting, and, finally, creates the focused image. You will see the work progress on the screen.

Parameters

char *FileSpec

Path and file mask (including extension) of images forming the sequence. For example, this is correct FileSpec: C:\Images\EDF\Crystal\*.jp2

int nAutoFittingMethod

Method for automatic sequence alignment.

0	Skip automatic sequence alignment
1	Use default method for automatic sequence alignment

int nFocusingMethod

Method for creating focused image.

0	Local
1	Fluorescence
2	Smooth
3	Maximum intensity

int nFocusingParam1

This parameter applies only for Smooth focusing method and corresponds to its “level” parameter.

0	Standard
1	High
2	Very high

int nFocusingParam2

This parameter applies only for Smooth focusing method and corresponds to its “blending” parameter.

0	No blending
2	Low
4	Medium
8	High

EDF_AlignSequence

This function runs the Applications > EDF > Align Sequence command.

Description 

 EDF_AlignSequence();

This function automatically aligns all images of the current image sequence. This action is crucial to apply before the focused image is created.

EDF_CreateAnaglyph

Description 

 EDF_CreateAnaglyph(
   int  EDF_AnaglGrayScale,
   int  SeqFirstIsLowest,
   int  Descend,
   int  LeftColor,
   int  ZEnhance
);

Creates the anaglyph image of the current z-stack using the given parameters.

Parameters

int EDF_AnaglGrayScale

0	Creates a color anaglyph.
1	Creates a grayscale anaglyph.

int SeqFirstIsLowest

Real position of the first image in the z-stack.

0	The first image is on top.
1	The first image is the lowest.

int Descend

Defines the stereovision impression, which you will experience using special red-green glasses.

0	The anaglyph will rise from the screen.
1	The anaglyph will descend into the screen.

int LeftColor

Color of the left glass of your glasses. This option is crucial to get the right 3D impression.

int ZEnhance

Enhances the depth feeling.

0	Low height.
1	Standard height.
2	Enhanced height.

EDF_CreateEDFFocusedNewDoc

Interactive command to this function: Applications > EDF > Create Focused Document

Description 

 EDF_CreateEDFFocusedNewDoc(
   int  EDF_ZMapMethod
);

Creates a new EDF focused document for all time phases from the current ND2 file containing a Z-dimension.

Parameters

int EDF_ZMapMethod

Specifies the Z-Map method

0	Balanced
1	Correlation - this method is not documented and should not be used
2	Legacy
3	None

EDF_CreateFocusedImage

Description 

 EDF_CreateFocusedImage(
   int  EDF_NDProcessAll
);

This function creates a focused image using the focusing method passed as its parameter.

Parameters

int EDF_NDProcessAll

When performed on ND2 document, this parameter tells whether to process just the current or all Z stacks included in the file.

0	Process just the current Z stack.
1	Process the whole ND2 document.

EDF_CreateFocusedImageDef

Interactive command to this function: Applications > EDF > Create Focused Image

Description 

 EDF_CreateFocusedImageDef(
   int  OpenToNewWindow,
   int  EDF_NDProcessAll,
   int  EDF_ZMapMethod
);

Creates the focused image using the default (last used) focusing method.

Parameters

int OpenToNewWindow

Open image in a new window.

0	behaves according to what is set in Edit > Options > General > Open new ND views to new window
1	behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

int EDF_NDProcessAll

When performed on ND2 document, this parameter tells whether to process just the current or all Z stacks included in the file.

0	Process just the current Z stack.
1	Process the whole ND2 document.

int EDF_ZMapMethod

Specifies the Z-Map method

0	Balanced
1	Correlation - this method is not documented and should not be used
2	Legacy
3	None

EDF_DefineImages

Description 

 EDF_DefineImages(
   char *FileSpec
);

This function opens the image sequence from given directory.

Parameters

char *FileSpec

Path and file mask (including extension) of images forming the sequence. For example, this is correct FileSpec: C:\Images\EDF\Crystal\*.jp2

EDF_ExportZMapToFile

Description 

 EDF_ExportZMapToFile(
   char *Filename
);

This function exports the EDF Z map to the specified text file as a matrix of comma-separated values.

Parameters

char *Filename

The path and the name of the file.

EDF_GetFocusedZPos

Description 

 EDF_GetFocusedZPos(
   int  PosX,
   int  PosY
);

Returns the index of the z-slice that was used as the source image for a pixel at an [x,y] position of the focused image.

Parameters

int PosX

X coordinate in [px].

int PosY

Y coordinate in [px].

EDF_MeasureZProfile

This function runs the Measure > EDF Z-Profile command.

Description 

 EDF_MeasureZProfile();

This function displays the EDF Z Profile control window and the profile line inside the image.

EDF_NewEDFFocusedDoc

Description 

 EDF_NewEDFFocusedDoc();

Creates a new EDF focused document from the Z-frames of the current ND2 document.

EDF_RealTimeEDF

Interactive command to this function: Applications > EDF > Real Time EDF

Description 

 EDF_RealTimeEDF(
   double  ZSeriesBottom,
   double  ZSeriesTop,
   int  ZSeriesSteps,
   int  UseAutoFitting
);

Captures the stack of images and directly creates the focused image from them. The source images are not stored, only the focused image. You need to have any z drive connected to the system. The stack is captured around the current position.

Parameters

double ZSeriesBottom

relative position of the first (bottom) image. Must be negative value.

double ZSeriesTop

relative position of the last (top) image. Must be positive value.

int ZSeriesSteps

Number of steps, i.e. number of source images for creating focused image

int UseAutoFitting

Perform aligning on the source images. This should be used only when really necessary

0, FALSE	Do not align
1, TRUE	Align source images.

EDF_ShowAnaglyph

This function runs the Applications > EDF > Show Anaglyph command.

Description 

 EDF_ShowAnaglyph(
   int  iNewWindow
);

Activates the view with the anaglyph image of the current z-stack. If such window is not found, this function attempts to create it. Focused image of the current z-stack has to be created prior to calling this function.

Parameters

int iNewWindow

Opens the 3D View in a new window.

0	Behaves according to what is set in Edit > Options > General > Open new ND views to new window
1	Behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

EDF_ShowSurfaceView

This function runs the Applications > EDF > Show Surface View command.

Description 

 EDF_ShowSurfaceView(
   int  iNewWindow
);

Activates the view with the 3D surface view of the current z-stack. Focused image for the current z-stack has to be created prior calling this function.

Parameters

int iNewWindow

Opens the 3D View in a new window.

0	Behaves according to what is set in Edit > Options > General > Open new ND views to new window
1	Behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

EDF_ShowZMapImage

This function runs the Applications > EDF > Show Z-Map Image command.

Description 

 EDF_ShowZMapImage();

This function creates and displays an EDF Z map view of an ND document.

EDF_ZMapSettingToggle

Description 

 EDF_ZMapSettingToggle();

Toggles the EDF Z-Map Settings.

See Also

• EDF_CreateEDFFocusedNewDoc

_EDF_CreateEDFFocusedNewDoc

This function runs the Applications > EDF > Create Focused Document command.

Description 

 _EDF_CreateEDFFocusedNewDoc();

Opens the Z-Map Setting - choose whether to create a Z-Map (Balanced, Correlation or Original) and choose the coordinates for the Z-Profile (Zero Based or Real Coordinates). If the Z-map calculation is not necessary for your task, select None in the drop-down menu to speed up the EDF image acquisition. Then click OK to create a new EDF focused document from the Z-frames of the current ND2 document.

_EDF_CreateFocusedImageDef

This function runs the Applications > EDF > Create Focused Image command.

Description 

 _EDF_CreateFocusedImageDef(
   int  OpenToNewWindow
);

Creates the focused image of the current z-stack using the default (last used) parameters. If the ND document has more than one z-stack, this function shows the dialog window and lets user to select whether to create focused images for all z-stacks.

Parameters

int OpenToNewWindow

Open image in a new window.

0	behaves according to what is set in Edit > Options > General > Open new ND views to new window
1	behaves contrary to what is set in Edit > Options > General > Open new ND views to new window

_EDF_EditBackground

This function runs the Applications > EDF > Edit Background command.

Description 

 _EDF_EditBackground();

_EDF_EditFocusedArea

This function runs the Applications > EDF > Edit Area in Focused Image command.

Description 

 _EDF_EditFocusedArea();

This function selects an area in the focused image, browses through the z stacks in this area and selects a more appropriate frame to replace the one existing in the focused image.

_EDF_OpenSequence

This function runs the Applications > EDF > Open File Sequence command.

Description 

 _EDF_OpenSequence();

Return Values

The function returns TRUE if successful otherwise FALSE.

_EDF_RealTimeEDF

This function runs the Applications > EDF > Real Time EDF command.

Description 

 _EDF_RealTimeEDF();

Displays the dialog window.

_EDF_RealTimeEDFManually

This function runs the Applications > EDF > Real Time EDF Manually command.

Description 

 _EDF_RealTimeEDFManually();

This function displays a dialog window for Manual Real Time EDF.

_EDF_ZMapSetting

Description 

 _EDF_ZMapSetting();

Opens the Z-Map Settings dialog window.

See Also

• EDF_CreateEDFFocusedNewDoc