BackgroundProbe

_BackProbeProperties, _DrawBackProbe, _SetBackOffsetLive, _SubtractBackgroundUsingConstant, _SubtractBackgroundUsingProbe, BackProbeKeepUpdate, BackProbeReset, SetBackOffset, ShowBackProbe, SubtractBackgroundUsingConstant, SubtractBackgroundUsingConstantND, SubtractBackgroundUsingProbe, SubtractBackgroundUsingProbeND, SubtractBackgroundUsingReference, ToggleBackProbe

BackProbeKeepUpdate

This function runs the Keep Updating Background Offset command.

Description

 BackProbeKeepUpdate(
   bool  BackProbeKeepUpdate
);

Sets the option if the background offset should be kept updated using the values retrieved from the background ROIs on the current image.

Parameters

bool BackProbeKeepUpdate

Turn keeping background offset updated on or off.

1, TRUE	Keep updated
0, FALSE	Do not keep updated

See Also
SetBackOffset, BackProbeReset

BackProbeReset

This function runs the Reset Background Offset to Zero command.

Description

 BackProbeReset();

Resets the offset calculated by the background probe and switches the background probe off.

SetBackOffset

This function runs the Fix Background Offset command.

Description

 SetBackOffset();

Fixes the background offset to the current value and stops updating it by values retrieved from background ROIs.

See Also
BackProbeKeepUpdate, BackProbeReset

ShowBackProbe

Description

 ShowBackProbe(
   bool  ShowBackProbe
);

This function displays/hides the background probe in the current document window.

Parameters

bool ShowBackProbe

Displays/hides the background probe.

0	Hide the background probe.
1	Display the background probe.

SubtractBackgroundUsingConstant

Interactive command to this function: Image > Background > Subtract Background Using Constant

Description

 SubtractBackgroundUsingConstant(
   int *BackgroundConstArray
);

This function subtracts specified value(s) from the image.

Parameters

int *BackgroundConstArray

Pointer to the array of integers which specifies constants for each component of the image.

// suppose we have a multichannel image with 2 brightfiled channels.
int pconst[6];
pconst[0] = 50;
pconst[1] = 50;
pconst[2] = 50;
pconst[3] = 100;
pconst[4] = 5;
pconst[5] = 30; 
SubtractBackgroundUsingConstant(pconst); // We subtract 50 from the first brightfield channel, 
                                        // 100 from the blue component of the second brightfield channel, 
                                        // 5 from the green component of the second brightfield channel,
                                        // 30 from the red component of the second brightfield channel.

Note

Array indices correspond to component numbers, not channel numbers. For RGB images, component 0 correspond to blue channel, 1 to green and 2 to red. Brightfield channels have 3 components (RGB).

SubtractBackgroundUsingConstantND

Description

 SubtractBackgroundUsingConstantND(
   int *BackgroundConstArray,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

This function subtracts specified value(s) from the image.

Parameters

int *BackgroundConstArray

Pointer to the array of integers which specifies constants for each component of the image.

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

// suppose we have a multichannel image with 2 brightfiled channels.
int pconst[6];
pconst[0] = 50;
pconst[1] = 50;
pconst[2] = 50;
pconst[3] = 100;
pconst[4] = 5;
pconst[5] = 30; 
SubtractBackgroundUsingConstantND(pconst, 1, 1, 1); // We subtract 50 from the first brightfield channel, 
                                        // 100 from the blue component of the second brightfield channel, 
                                        // 5 from the green component of the second brightfield channel,
                                        // 30 from the red component of the second brightfield channel.

Note

Array indices correspond to component numbers, not channel numbers. For RGB images, component 0 correspond to blue channel, 1 to green and 2 to red. Brightfield channels have 3 components (RGB).

SubtractBackgroundUsingProbe

Interactive command to this function: Image > Background > Subtract Background Using Background ROI

Description

 SubtractBackgroundUsingProbe(
   int  SubtractiveOffset
);

This function subtracts the average value defined by background probe from the whole image. It operates channel by channel and even when the probe is not turned ON.

Parameters

int SubtractiveOffset

Value of subtraction offset.

SubtractBackgroundUsingProbeND

Description

 SubtractBackgroundUsingProbeND(
   int  SubtractiveOffset,
   bool  ProbeEveryFrame,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

This function subtracts the average value defined by background probe from the whole ND2 document. It operates channel by channel and even when the probe is not turned ON.

Parameters

int SubtractiveOffset

Value of subtraction offset.

bool ProbeEveryFrame

Determines the source data for the background probe.

0, FALSE	Uses only the probe data of the current frame.
1, TRUE	Retrieves the probe data for each frame separately.

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

SubtractBackgroundUsingReference

This function runs the Image > Background > Subtract Background Using Reference command.

Description

 SubtractBackgroundUsingReference();

This function subtracts pixel values of the reference image from the current image. If there is no reference image, no action is performed.

ToggleBackProbe

This function runs the View > Layers > Background ROI command.

Description

 ToggleBackProbe();

This function displays/hides the background probe.

_BackProbeProperties

This function runs the ROI Properties command.

Description

 _BackProbeProperties();

This function displays the Background Probe Properties dialog window. Line color and line width can be set via that window.

_DrawBackProbe

This function runs the Draw Background ROI command.

Description

 _DrawBackProbe(
   int  ProbeObjectType
);

This function switches the application to a mode of drawing the background probe.

Parameters

int ProbeObjectType

The parameter selects the shape of the probe.

0	Draw Rectangular Background ROI.
1	Draw Elliptic Background ROI.
2	Draw Polygonal Background ROI.
3	Draw Bezier Background ROI.

_SetBackOffsetLive

Description

 _SetBackOffsetLive();

Enables you to fix the background offset on the live image. This functions shows the window displaying the values calculated in the background ROIs from the current live image. Press OK to fix the background offset.

_SubtractBackgroundUsingConstant

This function runs the Image > Background > Subtract Background Using Constant command.

Description

 _SubtractBackgroundUsingConstant();

This function displays the Subtract Background Using Constant dialog window. A value to be subtracted can be defined for each channel of the image.

_SubtractBackgroundUsingProbe

This function runs the Image > Background > Subtract Background Using Background ROI command.

Description

 _SubtractBackgroundUsingProbe();

This function equals the SubtractBackgroundUsingProbe function except when performed on ND2 document you will be prompt to select whether to process the current image, selected dimension, or the whole ND document. And, a possibility to choose the source data for the background probe is offered (current image or every image one by one).