Adjust

_AdjustColorsRGB, _ApplyOneShotHDR, _ChangeSaturation, _ColorToGray, _ComplementColor, _ComponentContrast, _Contrast, _DetectModality, _IntensityTransformation, _TripleQuadInterleave, _WhiteBalance, AdjustColorsRGB, ApplyOneShotHDR, AutoContrastEx, AutoContrastExND, AutoWhiteEx, AutoWhiteExND, ChangeSaturation, ColorToGray, ColorToGrayND, ColorToGrayVSL, ComplementColor, ComponentContrast, ComponentContrastMCh, Contrast, ConvertTo8bitRGB, DetectModalityBatch, GLPDetails, IntensityTransformation, TripleQuadInterleave, WhiteBalance

AdjustColorsRGB

Description 

 AdjustColorsRGB(
   int  CDest,
   int  CSour,
   double  redR,
   double  redG,
   double  redB,
   double  greenR,
   double  greenG,
   double  greenB,
   double  blueR,
   double  blueG,
   double  blueB,
   int  merge,
   int  NDDimension
);

This function transforms originally red, green and blue colors in current picture to colors specified by color components. Color component value must be greater or equal 0 and lower than 256.

Parameters

int CDest

destination - unused parameter

int CSour

source - unused parameter

double redR

New red component of originally red color

double redG

New green component of originally red color

double redB

New blue component of originally red color

double greenR

New red component of originally green color.

double greenG

New green component of originally green color.

double greenB

New blue component of originally green color.

double blueR

New red component of originally blue color

double blueG

New green component of originally blue color

double blueB

New blue component of originally blue color

int merge

Color merging method

0

Result color component is maximum of new color components

1

Result color component is average of new color components

2

Result color component is weighted average of new color components

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

See Also 
_AdjustColorsRGB

ApplyOneShotHDR

Interactive command to this function: Applications > HDR > Apply One-Shot HDR to Current Image

Description 

 ApplyOneShotHDR(
   int  NDDimension
);

Applies the One Shot HDR function used for enhancing the dynamic range on the selected dimensions of the currently opened image.

Parameters

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

AutoContrastEx

Description 

int AutoContrastEx();

This function performs the auto exposure operation on the captured image.

Return Values

int

This function returns true.

See Also 
AutoWhiteEx

AutoContrastExND

Description 

 AutoContrastExND();

This function performs the auto exposure operation on the captured ND image.

AutoWhiteEx

Description 

int AutoWhiteEx();

This function performs auto white operation on captured image. The function balances and adjusts red, green and blue components to get the white. Color gains are affected.

Return Values

int

This function returns true.

See Also 
AutoContrastEx

AutoWhiteExND

Description 

 AutoWhiteExND();

This function performs auto white operation on captured ND image. The function balances and adjusts red, green and blue components to get the white. Color gains are affected.

ChangeSaturation

Interactive command to this function: Image > Adjust Image > Change Saturation

Description 

 ChangeSaturation(
   int  Saturation,
   int  NDDimension
);

This function changes saturation of color image.

Parameters

int Saturation

Degree of saturation enhancement / suppression. Values ranging from -100 to 100%.

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

Note

This transformation is used for color image enhancement has the similar effect like changing saturation on TV.

ColorToGray

This function runs the Image > Convert > Convert to Gray command.

Description 

 ColorToGray();

This function transforms the current color image to a gray image.

Note

The resulting intensities are defined for every pixel as an average of red, green and blue component values.

See Also 
Extract, _ColorToGray, ColorToGrayND

ColorToGrayND

Description 

 ColorToGrayND();

This function transforms the current color image to a gray image. When it is performed on ND document you will be prompt to select whether to process the current image, selected dimension, or the whole ND document.

Note

The resulting intensities are defined for every pixel as an average of red, green and blue component values.

See Also 
Extract, _ColorToGray, ColorToGray

ColorToGrayVSL

Description 

 ColorToGrayVSL();

This function transforms the current color image to a gray image. The function operates on large VSL images which do not fit into memory.

See Also 
ColorToGray

ComplementColor

Interactive command to this function: Image > Adjust Image > Complement Colors

Description 

 ComplementColor(
   int  NDDimension
);

This function transforms color image to complementary colors.

Parameters

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

See Also 
ViewComponents

ComponentContrast

Description 

 ComponentContrast(
   int  RedLowValue,
   int  GreenLowValue,
   int  BlueLowValue,
   int  RedHighValue,
   int  GreenHighValue,
   int  BlueHighValue,
   double  RedGamma,
   double  GreenGamma,
   double  BlueGamma,
   int  NDDimension
);

This function enhances contrast of red, green and blue components of the current color image. An interactive equivalent is the _ComponentContrast function.

Parameters

int RedLowValue

The intensity of the red image component, which is set to minimum value (0).

int GreenLowValue

The intensity of the green image component, which is set to minimum value (0).

int BlueLowValue

The intensity of the blue image component, which is set to minimum value (0).

int RedHighValue

The intensity of the red image component, which is set to maximum value (255 for 8bit).

int GreenHighValue

The intensity of the green image component, which is set to maximum value (255 for 8bit).

int BlueHighValue

The intensity of the blue image component, which is set to maximum value (255 for 8bit).

double RedGamma

Gamma correction for the red component.

double GreenGamma

Gamma correction for the green component.

double BlueGamma

Gamma correction for the blue component.

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

Note

Component contrast changes intensities of the components the current color image. Transformation stretches the component intensity interval <XLow, XHigh> to the full intensity range <0, 255> (8bit). All values below XLow are set to zero and all values above XHigh are set to a maximum of 255 (8bit).

ComponentContrastMCh

Description 

 ComponentContrastMCh(
   int *MChLowArray,
   int *MChHighArray,
   double *MChGammaArray,
   int  NDDimension
);

This function defines the component contrast parameters each channel of the current multichannel document separately. An interactive equivalent is the _ComponentContrast function.

Parameters

int *MChLowArray

The array containing contrast low values. The array size should correspond to the number of channels.

int *MChHighArray

The array containing contrast high values. The array size should correspond to the number of channels.

double *MChGammaArray

The array containing contrast gamma values. The array size should correspond to the number of channels.

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

See Also 
ComponentContrast, _ComponentContrast, _ComponentContrast

Contrast

Interactive command to this function: Image > Contrast

Description 

 Contrast(
   int  ContrastType,
   int  LowValue,
   int  HighValue,
   int  OnIntensity,
   int  NDDimension
);

This function enhances contrast of current color (gray) image. Contrast(ContrastType, 0, 0) performs automatic enhancement. An interactive equivalent is the _Contrast function.

Parameters

int ContrastType

Contrast method:

0

Linear

1

Equalized

2

Logarithmic

3

Exponential

4

Gamma Correction

int LowValue

Low contrast value.

int HighValue

High contrast value.

int OnIntensity

Selects whether to perform the processing on the intensity component or on color channels (one by one).

0, FALSE

use channels

1, TRUE

use the intensity component

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

Note

Contrast changes intensities of the current color (gray) image. Hue and saturation values of color images are not affected. Intensities are rescaled according to selected scale iType. Linear, Logarithmic and Exponential transformations stretch the intensity interval <dLow, dHigh> to the full intensity range <0, 255> (8 bit). All values below dLow are set to zero and all values above dHigh are set to a maximum of 255 (8 bit). Equalize transforms the intensities so that the resulting intensity histogram becomes uniform. In this case dLow and dHigh represent the minimum and maximum intensities in the resulting image. Using Contrast in command mode, dLow=dHigh=0 implies automatic contrast enhancement.

See Also 
_Contrast, _Contrast

ConvertTo8bitRGB

This function runs the Edit > Convert to 8bit RGB command.

Description 

 ConvertTo8bitRGB();

This function converts the image to RGB (8 bit).

DetectModalityBatch

Description 

 DetectModalityBatch(
   char *MDB_Folder,
   int  MDB_Frame
);

This function is for internal purposes only.

Parameters

char *MDB_Folder

For internal purposes only.

int MDB_Frame

For internal purposes only.

GLPDetails

Description 

 GLPDetails(
   double  GLPDetailsAlpha,
   double  GLPDetailsSigmaDetails,
   double  GLPDetailsSigmaNoise,
   int  NDDimension
);

Runs the Ultra Details function on the current image.

Parameters

double GLPDetailsAlpha

Alpha parameter of Ultra Details.

double GLPDetailsSigmaDetails

Details parameter of Ultra Details.

double GLPDetailsSigmaNoise

Noise parameter of Ultra Details.

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

See Also 

IntensityTransformation

Interactive command to this function: Image > Adjust Image > Intensity Transformation

Description 

 IntensityTransformation(
   int  OperType,
   int  Intensity,
   int  FloatOutput,
   int  NDDimension
);

This function transforms intensities by arithmetics operations. An interactive equivalent is the _IntensityTransformation function.

Parameters

int OperType

Type of intensity transformation.

0

Addition.

1

Subtraction.

2

Minimum.

3

Maximum.

4

Assignment.

5

Multiplication.

6

Division.

int Intensity

Value for Intensity. For multiplication and division the values are considered to be in %.

int FloatOutput

Create the result as a floating point image?

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

See Also 
_IntensityTransformation, RGBTransformation, _RGBTransformation, _IntensityTransformation

TripleQuadInterleave

Description 

 TripleQuadInterleave(
   int  NDDimension
);

Converts the current image from “frame storage layout” (produced by triple/quad cameras) to “pixel storage layout” which is the format used by the software.

Parameters

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

WhiteBalance

Interactive command to this function: Image > Adjust Image > White Balance

Description 

 WhiteBalance(
   int  WhiteRed,
   int  WhiteGreen,
   int  WhiteBlue,
   int  BlackRed,
   int  BlackGreen,
   int  BlackBlue,
   int  BlackBalance,
   int  DynCorrection,
   double  Gamma,
   int  NDDimension
);

This function balances and adjusts red, green and blue components of the current color image.

Parameters

int WhiteRed

Value of the red component for definition of the white level.

int WhiteGreen

Value of the green component for definition of the white level.

int WhiteBlue

Value of the blue component for definition of the white level.

int BlackRed

Value of the red component for definition of the black level.

int BlackGreen

Value of the green component for definition of the black level.

int BlackBlue

Value of the blue component for definition of the black level.

int BlackBalance

Specify whether to use the black balance.

0

No

1

Yes

int DynCorrection

Specify whether to use the dynamic correction.

0

No

1

Yes

double Gamma

Gamma value.

<1

Image parts with low intensities are enhanced.

1

Default value.

>1

Image parts with high intensities are enhanced.

int NDDimension

Frame selection of the ND document.

0

Current frame

1

Time dimension

2

Multipoint dimension

4

Z dimension

15

All frames (the whole ND document).

16

Selection - the frames/dimensions selected by mouse within the ND control bar will be affected.

Note

Value combination is also possible (e.g.: M+T=3, Z+T=5, M+Z=6).

See Also 
_WhiteBalance, _WhiteBalance

_AdjustColorsRGB

Description 

 _AdjustColorsRGB();

This function shows a dialog window for transforming originally red, green and blue colors in the picture to new selected colors.

See Also 
AdjustColorsRGB

_ApplyOneShotHDR

This function runs the Applications > HDR > Apply One-Shot HDR to Current Image command.

Description 

 _ApplyOneShotHDR();

Opens the Apply One Shot HDR dialog window used for enhancing the dynamic range on the currently opened image.

See Also 
ApplyOneShotHDR

_ChangeSaturation

This function runs the Image > Adjust Image > Change Saturation command.

Description 

 _ChangeSaturation();

Opens a dialog window for changing saturation of the current image.

_ColorToGray

Description 

 _ColorToGray();

This function converts the current image into gray scale.

See Also 
_ConvertToRGB

_ComplementColor

This function runs the Image > Adjust Image > Complement Colors command.

Description 

 _ComplementColor();

This function equals the ComplementColor 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.

See Also 
ComplementColor

_ComponentContrast

Description 

 _ComponentContrast();

The function displays the Component Contrast dialog box.

See Also 
ComponentContrast, ComponentContrastMCh

_Contrast

This function runs the Image > Contrast command.

Description 

 _Contrast();

The function displays the Contrast Enhancement dialog box.

See Also 
Contrast

_DetectModality

Description 

 _DetectModality();

Shows the channel modality of the current image in the Modality dialog window.

_IntensityTransformation

This function runs the Image > Adjust Image > Intensity Transformation command.

Description 

 _IntensityTransformation();

The function displays the Image Intensity dialog box.

See Also 
IntensityTransformation, RGBTransformation, _RGBTransformation

_TripleQuadInterleave

Description 

 _TripleQuadInterleave();

Converts the current image from “frame storage layout” (produced by triple/quad cameras) to “pixel storage layout” which is the format used by the software.

_WhiteBalance

This function runs the Image > Adjust Image > White Balance command.

Description 

 _WhiteBalance();

This function displays the White Balance Adjustment dialog box.

See Also 
WhiteBalance

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