_BinLayerOperation, _BinLayerSetColor, BinLayerClipboardCopy, BinLayerClipboardPaste, BinLayerCopy, BinLayerDelete, BinLayerDuplicate, BinLayerFillFramesND, BinLayerGetNameFromID, BinLayerGetNameFromIndex, BinLayerMerge, BinLayerMergeND, BinLayerSelect, BinLayerSetColor, BinLayerSetColorEx, BinLayerSetComponent, BinLayerStore, BinLayerSynchronizeBinariesWithChannels, GetGrayImageFromBinLayer, ProcessBinLayer

BinLayerClipboardCopy

This function runs the Copy Binary Layers command.

Description 

 BinLayerClipboardCopy(
   char *BinLayerNameSrc
);

This function copies binary layers into the clipboard. The layers can be pasted into different documents.

Parameters

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

Note

If you have layers with duplicate names use #id for source layer names instead.

See Also 
BinLayerCopy, BinLayerClipboardPaste

BinLayerClipboardPaste

This function runs the Paste Binary Layers command.

Description 

 BinLayerClipboardPaste(
   char *BinLayerNameDst
);

This function pastes binary layers from clipboard into the current document. Clipboard must contain some binary layer.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

See Also 
BinLayerCopy, CopyBinary, PasteBinary

BinLayerCopy

Description 

 BinLayerCopy(
   char *BinLayerNameDst,
   char *BinLayerNameSrc
);

This function copies contents of one binary layer into another binary layer.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

Note

If you have layers with duplicate names use #id for source layer names instead.

See Also 
BinLayerClipboardCopy, BinLayerClipboardPaste, CopyBinary, PasteBinary

BinLayerDelete

This function runs the Delete All Layers command.

Description 

 BinLayerDelete(
   char *BinLayerNameDst
);

This function deletes the specified binary layers.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

Note

If you have layers with duplicate names use #id for layer names instead. If all layer shall be deleted, use “*” as the parameter.

See Also 
BinLayerDuplicate, BinLayerMerge, BinLayerSelect, BinLayerSetComponent, BinLayerStore

BinLayerDuplicate

Description 

 BinLayerDuplicate(
   char *BinLayerNameDst,
   char *BinLayerNameSrc
);

This function duplicates the binary layers.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

See Also 
BinLayerDelete, BinLayerMerge, BinLayerSelect, BinLayerSetComponent, BinLayerStore

BinLayerFillFramesND

Description 

 BinLayerFillFramesND(
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop,
   int  NDDimension
);

This function fills frames which miss binary layer with the binary layer of their neighbors. If all dimensions are used, the function looks for neighbors containing a binary layer in the following order: Z, MP, T.

Parameters

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

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

BinLayerGetNameFromID

Description 

 BinLayerGetNameFromID(
   unsigned int  BinLayerID,
   char *BinLayerNameDst,
   int  BufferLength
);

Gets a binary layer name from its unique identifier (ID). IDs of the binary layers appear in tooltips of the Binary Layers control.

Parameters

unsigned int BinLayerID

Binary layer unique identifier.

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

int BufferLength

Maximum length of BinLayerNameDst buffer.

See Also 
BinLayerGetNameFromIndex

BinLayerGetNameFromIndex

Description 

 BinLayerGetNameFromIndex(
   int  Index,
   char *BinLayerNameDst,
   int  BufferLength
);

Gets a binary layer name from its index. Index starts from 0 and corresponds to the binary layers order in the Binary Layers control.

Parameters

int Index

Index number (zero-based).

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

int BufferLength

Maximum length of BinLayerNameDst buffer.

See Also 
BinLayerGetNameFromID

BinLayerMerge

Description 

 BinLayerMerge(
   char *BinLayerNameDst,
   char *BinLayerNameSrc,
   int  BinLayerOp
);

This function merges all source layers into a new destination layer. A parameter defines how the layers are merged. At least two source layers are necessary.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

int BinLayerOp

Integer number specifying the operation between the layers. Default operation is Union.

1	union (OR)
2	intersection (AND)
3	subtraction of the second layer from the first layer
4	subtraction of the first layer from the second layer
5	non-equivalence
6	equivalence
7	copy the first layer to the second layer

Note

If you have layers with duplicate names use #id for source layer names instead.

See Also 
BinLayerDelete, BinLayerDuplicate, BinLayerSelect, BinLayerSetComponent, BinLayerStore

BinLayerMergeND

Description 

 BinLayerMergeND(
   char *BinLayerNameDst,
   char *BinLayerNameSrc,
   int  BinLayerOp,
   int  NDTLoop,
   int  NDMPLoop,
   int  NDZLoop
);

This function merges all source layers of an ND document into a new destination layer. A parameter defines how the layers are merged.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

int BinLayerOp

Integer number specifying the operation between the layers. Default operation is Union.

1	union (OR)
2	intersection (AND)
3	subtraction of the second layer from the first layer
4	subtraction of the first layer from the second layer
5	non-equivalence
6	equivalence
7	copy the first layer to the second layer

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

BinLayerSelect

Description 

 BinLayerSelect(
   char *BinLayerNameDst
);

This function selects the specified binary layers. Remaining layers are deselected.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

Note

If you have layers with duplicate names use #id for layer names instead.

See Also 
BinLayerDelete, BinLayerDuplicate, BinLayerMerge, BinLayerSetComponent, BinLayerStore

BinLayerSetColor

This function runs the Binary for channel command.

Description 

 BinLayerSetColor(
   char *BinLayerNameDst,
   dword  BinLayerColor,
   int  BinLayerColorMode
);

This function changes the color of any existing binary layer.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

dword BinLayerColor

Color value.

int BinLayerColorMode

This parameter defines type of color mapping of image channels.

0	True Color
1	Custom Color
2	Gray Scale

BinLayerSetColorEx

Description 

 BinLayerSetColorEx(
   char *BinLayerNameDst,
   dword  BinLayerColor,
   int  BinLayerColorMode,
   int  CreateUndo
);

This function changes the color of any existing binary layer and enables the user to undo this process in the Undo History.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

dword BinLayerColor

Color value.

int BinLayerColorMode

This parameter defines type of color mapping of image channels.

0	True Color
1	Custom Color
2	Gray Scale

int CreateUndo

Created an undo option under Edit > Undo History.

0	disabled
1	enabled

BinLayerSetComponent

Description 

 BinLayerSetComponent(
   char *BinLayerNameDst,
   char *BinLayerComponent
);

This function attaches or detaches a binary layer to a channel. When the layer is attached to a channel, it takes its color and synchronizes its visibility.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

char *BinLayerComponent

Name of the component.

Note

If you have layers with duplicate names use #id for layer names instead.

See Also 
BinLayerDelete, BinLayerDuplicate, BinLayerMerge, BinLayerSelect, BinLayerStore

BinLayerStore

Description 

 BinLayerStore(
   char *BinLayerNameDst,
   char *BinLayerNameSrc
);

Moves the binary layers from the working set into the stored binary layer set.

Parameters

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

Note

If you have layers with duplicate names use #id for layer names instead.

See Also 
BinLayerDelete, BinLayerDuplicate, BinLayerMerge, BinLayerSelect, BinLayerSetComponent

BinLayerSynchronizeBinariesWithChannels

Description 

 BinLayerSynchronizeBinariesWithChannels(
   int  BinLayerSynchronize
);

When selecting a channel, this function automatically selects a binary layer attached to the appropriate channel and deselects all binary layers attached to other channels.

Parameters

int BinLayerSynchronize

Synchronize binary layers with channels.

0	Synchronizing OFF.
1	Synchronizing ON.

GetGrayImageFromBinLayer

Description 

 GetGrayImageFromBinLayer(
   char *BinLayerNameSrc,
   int  Component,
   int  Bin2GrayCStyle
);

This function replaces areas under the selected binary layer with a solid color. A copy of the current image will be created with the selected component (channel) modified.

Parameters

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

int Component

Component (channel) index.

int Bin2GrayCStyle

Resulting fill color of each area.

0	maximum
1	average

ProcessBinLayer

Description 

 ProcessBinLayer(
   char *ProcessingBinLayerName
);

Processes the selected binary layer.

Parameters

char *ProcessingBinLayerName

Name of the binary layer.

_BinLayerOperation

Description 

 _BinLayerOperation(
   char *BinLayerNameSrc,
   char *BinLayerNameDst,
   int  BinLayerOp
);

This function opens the Binary Operation dialog window.

Parameters

char *BinLayerNameSrc

Name of the source binary layer(s).

Note

Some functions accept a list of binary layers. These functions expect a coma-separated list of names. If the parameter is NULL or an empty string, selected (visible) layers are used instead.

char *BinLayerNameDst

Name of the destination binary layer(s) which will be created by the function.

Note

Some functions accept a list of binary layers. A coma-separated list of names is expected. If the list is in another format than expected or NULL, default names will be used.

int BinLayerOp

Integer number specifying the operation between the layers. Default operation is Union.

1	union (OR)
2	intersection (AND)
3	subtraction of the second layer from the first layer
4	subtraction of the first layer from the second layer
5	non-equivalence
6	equivalence
7	copy the first layer to the second layer

_BinLayerSetColor

Description 

 _BinLayerSetColor();

This function allows for changing the color of any existing binary layer.