Channels

_BlindUnmixing, _ChangeChannelColor, _ChangeChannelDescription, _ChannelProperties, _CustomChannelProperties, _ManageStoredSpectra, _MergeImagePlanes, _ReorderChannels, _UnMix, _UnMixND, BlindUnmixing, ChangeChannelColor, ChangeChannelDescription, ExtractComponents, ExtractSelectedComponents, ExtractSelectedComponentsAsFloat, GetChannelName, GetChannelPropertiesEx, GetViewComponents, KeepSelectedChannels, MergeImagePlanes, PasteIntoChannel, PasteIntoSelectedChannel, ProcessBlue, ProcessGreen, ProcessRed, ProcessRGB, ProcessViewComponent, RemoveChannel, ReorderChannels, SetChannelProperties, SetChannelPropertiesEx, SetSelectedChannelsAsCustom, SpectralImageRepresentation, ToggleChannelInColor, ToggleSpectralImageRepresentation, UnMix, UnMixND, VAASImageRepresentation, ViewAllComponents, ViewBlue, ViewChannel, ViewChannelInColor, ViewComponents, ViewComponentText, ViewCustomChannel, ViewGreen, ViewHDR, ViewRed, ViewRGB, XViewComponent

BlindUnmixing

Interactive command to this function: Image > Blind Unmixing

Description 

 BlindUnmixing(
   int  Components,
   double  BkgIntensity
);

This function performs the blind unmixing image modification.

Parameters

int Components

Number of components.

double BkgIntensity

Define value of background in the image.

See Also 
_BlindUnmixing

ChangeChannelColor

Description 

 ChangeChannelColor(
   int  Channel,
   int  Color
);

This function sets a new color to the selected channel.

Set the Color parameter as an RGB color - 32bit integer (hexadecimal form: 0xffRRGGBB) or 0 for transparent.

Parameters

int Channel

Index number of the channel.

int Color

The RGB color as a 32bit integer. Use the RGB function to get the value.

See Also 
_ChangeChannelColor, ChangeChannelDescription, _ChangeChannelDescription, _ChannelProperties

ChangeChannelDescription

Description 

 ChangeChannelDescription(
   int  Channel,
   char *Name
);

This function sets a new name of a channel of the current image.

Parameters

int Channel

Index number of the channel.

char *Name

Name of the image channel.

See Also 
_ChangeChannelDescription, ChangeChannelColor, _ChangeChannelColor, _ChannelProperties

ExtractComponents

Description 

 ExtractComponents(
   char *ComponentNames
);

This function extracts selected one or more channels of the current document and creates a new document out of them.

Parameters

char *ComponentNames

The name of the channel to be extracted.

ExtractSelectedComponents

This function runs the Extract Selected Channels command.

Description 

 ExtractSelectedComponents();

This function creates a new image document by copying the currently selected components (channels). Components which were not selected are cropped.

ExtractSelectedComponentsAsFloat

Description 

 ExtractSelectedComponentsAsFloat();

This function extracts all currently selected image components (channels) to a new - floating point - image. Intensity values within floating point images are not restricted to a certain bit depth. Using this function makes sense for example when the Ratio View is enabled.

GetChannelName

Description 

 GetChannelName(
   int  Channel,
   char *LpChannelName,
   int  ChannelNameMaxLength
);

The function retrieves a name of a color channel from current document.

Parameters

int Channel

Index number of the channel.

char *LpChannelName

Valid string for storing the channel name.

int ChannelNameMaxLength

Maximal length of LpChannelName string in characters.

GetChannelPropertiesEx

Description 

 GetChannelPropertiesEx(
   int  Channel,
   int  Meaning,
   double *LpDoubleValue,
   char *StringValue
);

The function retrieves properties of the specified channel.

Parameters

int Channel

Index number of the channel.

int Meaning

A channel feature to be modified.

0

Emission wavelength (keeping the current bandwidth).

1

Emission bandwidth.

2

Excitation wavelength (keeping the current bandwidth).

3

Excitation bandwidth.

4

Channel name

double *LpDoubleValue

The wavelength/bandwidth value.

char *StringValue

The channel name. When [Meaning] is set to 0, 1, 2, or 3, this parameter is ignored.

GetViewComponents

Description 

 GetViewComponents(
   char *ViewComponents
);

This function retrieves which image channels are currently displayed.

Parameters

char *ViewComponents

Which components are displayed (selected) and which are not. Standard RGB color image all channels visible would return “111”.

KeepSelectedChannels

This function runs the Keep Only Selected Channels command.

Description 

 KeepSelectedChannels();

Takes the current image and deletes all channels except the selected one.

MergeImagePlanes

Interactive command to this function: File > Merge Channels

Description 

 MergeImagePlanes(
   char *RedCompImage,
   char *GreenCompImage,
   char *BlueCompImage,
   char *BrightFieldImage
);

This function combines the color components from different images.

Parameters

char *RedCompImage

Image of this name will be added to the red component of the resulting image.

char *GreenCompImage

Image of this name will be added to the green component of the resulting image.

char *BlueCompImage

Image of this name will be added to the blue component of the resulting image.

char *BrightFieldImage

Name of the image that will be added to the bright field.

Note

This function is called from the File > Merge Channels command. The interactive equivalent is the _MergeImagePlanes function.

See Also 
_MergeImagePlanes

PasteIntoChannel

Description 

 PasteIntoChannel(
   int  Component
);

This function inserts a previously copied channel into the selected channel of the current image. The channel of the specified index must exist.

Parameters

int Component

Component (channel) index.

PasteIntoSelectedChannel

This function runs the Edit > Paste > Paste into Channel command.

Description 

 PasteIntoSelectedChannel();

This function inserts a previously copied channel(s) content into the currently selected channel. If no channel is selected, no action is performed.

See Also 
PasteIntoChannel

ProcessBlue

Description 

 ProcessBlue();

This function sets up the flag that enables processing only on the blue component of an image.

See Also 
ProcessRed, ProcessGreen, ProcessRGB

ProcessGreen

Description 

 ProcessGreen();

This function sets up the flag that enables processing only on the green component of an image.

See Also 
ProcessRed, ProcessBlue, ProcessRGB

ProcessRGB

Description 

 ProcessRGB();

This function sets up the flag that enables processing on all components (Red, Green, Blue) of an image.

See Also 
ProcessRed, ProcessGreen, ProcessBlue

ProcessRed

Description 

 ProcessRed();

This function sets up the flag that enables processing only on the red component of an image.

See Also 
ProcessGreen, ProcessBlue, ProcessRGB

ProcessViewComponent

Description 

 ProcessViewComponent(
   int  ProcessComponent,
   int  XViewComponent
);

This function can be used to process and view the specified color component of an image.

Parameters

int ProcessComponent

Selection of color components.

1

The first component (Blue in RGB image, binary 1)

2

The second component (Green in RGB image, binary 10)

4

The third component (Red in RGB image, binary 100)

7

The first three components (All RGB, binary 111)

Note

The “Brightfield” channel consists of 3 components.

int XViewComponent

Selection of color components.

1

The first component (Blue in RGB image, binary 1)

2

The second component (Green in RGB image, binary 10)

4

The third component (Red in RGB image, binary 100)

7

The first three components (All RGB, binary 111)

Note

The “Brightfield” channel consists of 3 components.

See Also 
ProcessRed, ProcessGreen, ProcessBlue, ProcessRGB, XViewComponent, ViewComponentText

RemoveChannel

This function runs the Remove channel command.

Description 

 RemoveChannel(
   int  Component
);

This function removes the specified channel (component) from the current image.

Parameters

int Component

Component (channel) index.

ReorderChannels

Interactive command to this function: Reorder Channels

Description 

 ReorderChannels(
   char *ComponentNames
);

This function can be used to change the order of the channels in the currently selected image.

Parameters

char *ComponentNames

Names of the channels in the desired order separated by a comma or a semicolon.

SetChannelProperties

Description 

 SetChannelProperties(
   int  Channel,
   char *Name,
   int  Modality,
   int  Wavelength,
   int  Color,
   bool  ColorFromWavelength
);

This function sets the channel name, modality, wavelength and color of the specified channel (component).

Parameters

int Channel

Index number of the channel.

char *Name

Name of the image channel.

int Modality

Can be one of the predefined values:

0

Widefield Fluorescence

1

Brightfield

2

Laser Scanning Confocal

3

Spinning Disk Confocal

4

Swept Field Confocal

5

Multiphoton fluorescence

int Wavelength

Wavelength [nm].

int Color

The RGB color as a 32bit integer. Use the RGB function to get the value.

0

Transparent

bool ColorFromWavelength

Sets whether to determine the channel color from the [Wavelength] parameter. This parameter overrides the [Color] parameter setting.

0

Channel color is defined by the Color parameter.

1

Channel color is determined from the Wavelength.

SetChannelPropertiesEx

Description 

 SetChannelPropertiesEx(
   int  Channel,
   int  Meaning,
   double  DoubleValue,
   char *StringValue,
   int  UpdateGUI
);

This function can adjust some channel properties of the captured ND2 document. The document must contain the multi-channel dimension.

Parameters

int Channel

Index number of the channel.

int Meaning

A channel feature to be modified.

0

Emission wavelength (keeping the current bandwidth).

1

Emission bandwidth.

2

Excitation wavelength (keeping the current bandwidth).

3

Excitation bandwidth.

4

Channel name

double DoubleValue

The wavelength/bandwidth value. When [Meaning] is set to 4 (Channel name), this parameter is ignored.

char *StringValue

The channel name. When [Meaning] is set to 0, 1, 2, or 3, this parameter is ignored.

int UpdateGUI

Update GUI at the end of this function? Supposing this function will be called multiple times, it is recommended to set this parameter to 1 only at the last call. All GUI components will be updated.

0

Do not update GUI

1

Update GUI

See Also 
SetChannelProperties

SetSelectedChannelsAsCustom

This function runs the Set selected channels as Custom command.

Description 

 SetSelectedChannelsAsCustom();

All channels currently selected for viewing will be set to the Custom tab. The previous settings of the Custom channel will be overwritten.

SpectralImageRepresentation

Description 

 SpectralImageRepresentation(
   int  SpectralRepresentation
);

This function can be used to convert multichannel images into spectral images. The function enables/disables the Treat as spectral checkbox in the spectral display settings.

Parameters

int SpectralRepresentation

Spectral representation of an image.

0

Image will be considered as normal multichannel image.

1

Image will be considered as spectral image.

ToggleChannelInColor

Description 

 ToggleChannelInColor();

This function sets the channels to be displayed gray/colored.

ToggleSpectralImageRepresentation

This function runs the Image > Treat as spectral command.

Description 

 ToggleSpectralImageRepresentation();

This function turns the Treat as spectral mode on/off.

Note

Spectral images which are saved in a format that does not contain the spectral metadata can be treated as spectral using this mode.

UnMix

Interactive command to this function: Image > Spectral Unmixing Setting

Description 

 UnMix(
   char *Filename
);

This function performs spectral decomposition of the current image with the specified setting.

The specified XML file contains description of all individual spectral components that will be used for decomposition. If the file name is not specified, spectral unmixing will be performed with the last settings used.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

See Also 
UnMixND, _UnMix, _UnMixND

UnMixND

Interactive command to this function: Image > Unmixing with Last Settings

Description 

 UnMixND(
   char *Filename,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

This function performs spectral decomposition of the current N-dimensional image with the specified setting.

The specified XML file contains description of all individual spectral components that will be used for decomposition. If the file name is not specified, spectral unmixing will be performed with the last settings used.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

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

VAASImageRepresentation

Description 

 VAASImageRepresentation(
   int  VAASRepresentation
);

This function can be used to convert an image into a VAAS image.

Parameters

int VAASRepresentation

0

Image will be considered as normal non VAAS image.

1

Image will be considered as VAAS image.

ViewAllComponents

This function runs the View > View/Process Component > RGB/All command.

Description 

 ViewAllComponents();

This function switches the view of the current image so that all color components are displayed.

ViewBlue

Description 

 ViewBlue();

This function displays the blue component of an image.

See Also 
ViewRed, ViewGreen, ViewRGB

ViewChannel

Description 

 ViewChannel(
   int  ViewChannel
);

This function displays one channel of an image.

Parameters

int ViewChannel

Index of a channel that will be displayed. 0 means all channels, 1...first channel etc. Number of channels can be retrieved by the Get_ImageInfo function.

ViewChannelInColor

This function runs the View Channel in Color command.

Description 

 ViewChannelInColor(
   int  ChannelInColor
);

A single channel of an image can be observed as gray or colored. This function toggles between these two ways. The setting is applied to the current document only.

Parameters

int ChannelInColor

Channel color.

0

Displays the single channel as gray.

1

Displays the single channel in color.

ViewComponentText

Description 

 ViewComponentText(
   char  ViewComponentText
);

This function activates the image component(s) whose name(s) is taken for the parameter.

Parameters

char ViewComponentText

Input the name of the image components to be displayed e.g.“DAPI” or “DAPI, FITC”.

ViewComponents

This function runs the View > View/Process Component > [Component Name] command.

Description 

 ViewComponents(
   char *ViewComponents
);

This function displays the given image components.

Parameters

char *ViewComponents

A string representing components to be viewed. Each character represents one component. E.g.:

011

RGB: display red+green.

Multichannel: display the second and the third channel.

See Also 
XViewComponent

ViewCustomChannel

Description 

 ViewCustomChannel();

This function displays the Custom channel (tab) of the current multichannel image.

ViewGreen

Description 

 ViewGreen();

This function displays the green component of an image.

See Also 
ViewRed, ViewBlue, ViewRGB

ViewHDR

Description 

 ViewHDR();

This function shall be used when an HDR multi-exposure image is opened. If for example a single channel (exposure frame) has been selected and modified, this function re-calculates and displays the whole HDR image.

ViewRGB

Description 

 ViewRGB();

This function displays all components (Red, Green, Blue) of an image.

See Also 
ViewRed, ViewBlue, ViewGreen

ViewRed

Description 

 ViewRed();

This function displays the red component of an image.

See Also 
ViewBlue, ViewGreen, ViewRGB

XViewComponent

Description 

 XViewComponent(
   int  XViewComponent
);

This function displays the given image components.

Parameters

int XViewComponent

Selection of color components.

1

The first component (Blue in RGB image, binary 1)

2

The second component (Green in RGB image, binary 10)

4

The third component (Red in RGB image, binary 100)

7

The first three components (All RGB, binary 111)

Note

The “Brightfield” channel consists of 3 components.

Note

This function is used for backward compatibility and it is limited to 32 components. For images with more than 32 components use ViewComponents function instead.

See Also 
ViewComponents, ViewComponentText

_BlindUnmixing

This function runs the Image > Blind Unmixing command.

Description 

 _BlindUnmixing();

This function displays the Blind Unmixing window.

See Also 
BlindUnmixing

_ChangeChannelColor

Description 

 _ChangeChannelColor(
   int  Channel
);

This function shows a dialog where the color of a specified channel can be changed.

Parameters

int Channel

Index number of the channel.

See Also 
ChangeChannelColor, ChangeChannelDescription, _ChangeChannelDescription, _ChannelProperties

_ChangeChannelDescription

Description 

 _ChangeChannelDescription(
   int  Channel
);

This function shows the dialog where a description text of a specified channel can be changed.

Parameters

int Channel

Index number of the channel.

See Also 
ChangeChannelDescription, ChangeChannelColor, _ChangeChannelColor, _ChannelProperties

_ChannelProperties

This function runs the Properties command.

Description 

 _ChannelProperties(
   int  Channel
);

This function shows a dialog where the properties (name, modality, wavelength and color) of a specified channel can be changed.

Parameters

int Channel

Index number of the channel.

See Also 
ChangeChannelColor, _ChangeChannelColor, ChangeChannelDescription, _ChangeChannelDescription

_CustomChannelProperties

This function runs the Properties command.

Description 

 _CustomChannelProperties();

This function displays a Custom dialog window where the included channels can be selected and the custom channel properties can be adjusted.

_ManageStoredSpectra

This function runs the Image > Manage Stored Spectra command.

Description 

 _ManageStoredSpectra();

_MergeImagePlanes

This function runs the File > Merge Channels command.

Description 

 _MergeImagePlanes();

Opens the Merge Channels dialog window used for merging images with the same scene into one image.

_ReorderChannels

This function runs the Reorder Channels command.

Description 

 _ReorderChannels();

Opens the Reorder Channels dialog window enabling to change the order of the channels in the currently selected image.

_UnMix

This function runs the Image > Spectral Unmixing Setting command.

Description 

 _UnMix();

This function performs spectral decomposition of the current image. The function displays the Spectral Unmixing Setting window.

See Also 
_UnMixND, UnMix, UnMixND

_UnMixND

This function runs the Image > Unmixing with Last Settings command.

Description 

 _UnMixND(
   char *Filename
);

This function has the same functionality as the UnMix function, but furthermore – if applied on ND document – it enables the user to select dimension on which the unmixing will be performed interactively.

The specified XML file contains description of all individual spectral components that will be used for decomposition. If the file name is not specified, spectral unmixing will be performed with the last settings used.

Parameters

char *Filename

Full path to the XML file. E.g. “C:\backup\backup1.xml”

See Also 
UnMix, UnMixND, _UnMix

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