Open

_ImageOpen, _OpenLargeImageProgVsSplit, _OpenLargeImageSplit, _ReopenProgressiveAsDownsampled, EnableDetectSequence, ImageOpen, OpenDocument, OpenDocument2, OpenDocument2_SetParams_Downsample, OpenDocument2_SetParams_Exp, OpenDocumentSerie, OpenDownsampledLargeImage, OpenDownsampledLargeImageEx, OpenLargeImage, SnippingTool

_ReopenProgressiveAsDownsampled

Description 

 _ReopenProgressiveAsDownsampled();

This function calls the OpenDownsampledLargeImageEx function. When an image is opened in the Progressive mode, you can zoom on a detail and if the zoom is smaller than 50%, you can use the context menu command to open it downsampled. The image opens in the same zoom and on the same position in the memory.

EnableDetectSequence

Description 

 EnableDetectSequence(
   int  Enabled
);

This function sets the behavior for detecting sequences when opening images via the Image Open dialog.

1 enables detecting sequences.

Parameters

int Enabled

0

Disabled.

1

Enabled.

ImageOpen

This function runs the File > Recent Files command.

Interactive command to this function: File > Open

Description 

 ImageOpen(
   char *Image
);

This function opens the selected image file to the application screen.

Parameters

char *Image

Complete path to the image.

See Also 
_ImageOpen

OpenDocument

Description 

 OpenDocument(
   char *Image,
   int  SaveModified
);

This function opens the document and displays the specified image on the screen.

Note

It is recommended to use OpenDocument2 function instead.

Parameters

char *Image

Complete path to the image.

int SaveModified

Specifies whether to save an opened document when it has been modified.

0, QUERYSAVE_ASK

Asks whether to save changes or not.

Ask before overwriting.

1, QUERYSAVE_YES

Changes are saved automatically.

Overwrite existing file.

2, QUERYSAVE_NO

Changes are not saved. Always discard the image.

Do not save (handled in macro).

SAVE_DIFFDIR

Save into different folder.

QUERYSAVE_CANCEL

Cancels the operation.

See Also 
OpenLargeImage, ImageOpen, SaveCurrentDocument

OpenDocument2

Description 

 OpenDocument2(
   char *Image,
   int  SeriesType,
   int  DocOpenType
);

This function opens the document and displays the specified image on the screen.

Parameters

char *Image

Complete path to the image.

int SeriesType

Specified which series is opened.

int DocOpenType

Specifies how the large image is opened.

0

Shows an additional dialog.

1

Opens as progressive.

2

Opens as downsampled.

OpenDocument2_SetParams_Downsample

Description 

 OpenDocument2_SetParams_Downsample(
   double  PicViewZoom,
   double  RelativePositionX,
   double  RelativePositionY
);

Sets the parameters before calling the OpenDocument2 function with parameter int DocOpenType equals to 2.

Parameters

double PicViewZoom

Absolute zoom of the view in percent.

double RelativePositionX

Relative position in X, i.e. values from 0.0 to 1.0. Centering is therefore 0.5.

double RelativePositionY

Relative position in Y, i.e. values from 0.0 to 1.0. Centering is therefore 0.5.

OpenDocument2_SetParams_Exp

Description 

 OpenDocument2_SetParams_Exp(
   int  ND_ExperimentType,
   double  SequenceStep
);

Sets the parameters before calling the OpenDocument2 function.

Parameters

int ND_ExperimentType

Type of the experiment loop or its position (depends on the ND_ExperimentByType parameter). If the ND_ExperimentByType is set to 1, the values from the table below will be used. If it is 0, just define the placing of the dimension within the whole experiment.

1

Time loop - us this value if the experiment contains just one time phase. Otherwise it returns 0.

2

XY Multipoint loop

4

Z Stack loop

6

Lambda (multichannel) loop

8

NE Time loop (NE = Non-Equidistant) - use this value if the experiment consists of more than one time phase.

double SequenceStep

Step between the frames. Units depend on the previous parameter: Time [ms], Z-step [microns]. The parameter is irrelevant for the XY multipoint type of document.

OpenDocumentSerie

Description 

 OpenDocumentSerie(
   char *Image,
   int  DocumentSerie,
   int  SaveModified
);

Opens a selected series (OME-TIFF) of the document.

Parameters

char *Image

Complete path to the image.

int DocumentSerie

Specified which series is opened.

int SaveModified

Specifies whether to save an opened document when it has been modified.

0, QUERYSAVE_ASK

Asks whether to save changes or not.

Ask before overwriting.

1, QUERYSAVE_YES

Changes are saved automatically.

Overwrite existing file.

2, QUERYSAVE_NO

Changes are not saved. Always discard the image.

Do not save (handled in macro).

SAVE_DIFFDIR

Save into different folder.

QUERYSAVE_CANCEL

Cancels the operation.

OpenDownsampledLargeImage

Description 

 OpenDownsampledLargeImage(
   char *Image,
   int  SaveModified
);

Opens a large image (which does not fit in the memory) as a downsampled (reduced) image in multiplies of 2 so that it fits into the memory. This function automatically saves the downsampled data to the original file (w/2xh/2, w/4xh/4, w/8xh/8, ...) therefore enlarges the file by one third. The downsampled image works as a normal image enabling any standard operations. This function is an alternative to the Progressive mode where the image is in its full size but not all operations are possible.

Parameters

char *Image

Complete path to the image.

int SaveModified

Specifies whether to save an opened document when it has been modified.

0, QUERYSAVE_ASK

Asks whether to save changes or not.

Ask before overwriting.

1, QUERYSAVE_YES

Changes are saved automatically.

Overwrite existing file.

2, QUERYSAVE_NO

Changes are not saved. Always discard the image.

Do not save (handled in macro).

SAVE_DIFFDIR

Save into different folder.

QUERYSAVE_CANCEL

Cancels the operation.

OpenDownsampledLargeImageEx

Description 

 OpenDownsampledLargeImageEx(
   char *Image,
   double  PicViewZoom,
   int  PicViewDocuX,
   int  PicViewDocuY,
   int  SaveModified
);

This function is the same as OpenDownsampledLargeImage and in addition it allows to set the target enlargement (e.g. 20%) and to set a point you want to have in the middle of the view.

Parameters

char *Image

Complete path to the image.

double PicViewZoom

Absolute zoom of the view in percent.

int PicViewDocuX

X coordinate of the zoom centre. A zoom centre is a point that will keep its position on the screen during zooming. The coordinates correspond to picture dimensions (in pixels). [0, 0] corresponds to the top-left corner of the picture.

int PicViewDocuY

Y coordinate of the zoom centre. A zoom centre is a point that will keep its position on the screen during zooming. The coordinates correspond to picture dimensions (in pixels). [0, 0] corresponds to the top-left corner of the picture.

int SaveModified

Specifies whether to save an opened document when it has been modified.

0, QUERYSAVE_ASK

Asks whether to save changes or not.

Ask before overwriting.

1, QUERYSAVE_YES

Changes are saved automatically.

Overwrite existing file.

2, QUERYSAVE_NO

Changes are not saved. Always discard the image.

Do not save (handled in macro).

SAVE_DIFFDIR

Save into different folder.

QUERYSAVE_CANCEL

Cancels the operation.

OpenLargeImage

Description 

 OpenLargeImage(
   char *Image,
   int  SaveModified
);

This function opens any image and assigns the SaveModified parameter to it. This parameter saves the modified image (0 = not saving, 1 = saving).

Parameters

char *Image

Complete path to the image.

int SaveModified

Specifies whether to save an opened document when it has been modified.

0, QUERYSAVE_ASK

Asks whether to save changes or not.

Ask before overwriting.

1, QUERYSAVE_YES

Changes are saved automatically.

Overwrite existing file.

2, QUERYSAVE_NO

Changes are not saved. Always discard the image.

Do not save (handled in macro).

SAVE_DIFFDIR

Save into different folder.

QUERYSAVE_CANCEL

Cancels the operation.

See Also 
OpenDocument, ImageOpen, SaveCurrentDocument

SnippingTool

This function runs the Edit > Snipping Tool command.

Description 

 SnippingTool();

This function executes the snipping tool enabling to make screenshots within NIS-Elements. After execution a red rectangular is displayed, dynamically changing with the mouse cursor position. Select the desired area for the capture and click the primary mouse button to copy the selection to clipboard. Then you can paste it into a new document.

_ImageOpen

This function runs the File > Open command.

Description 

 _ImageOpen();

This function displays the Open Image dialog box.

See Also 
ImageOpen

_OpenLargeImageProgVsSplit

Description 

 _OpenLargeImageProgVsSplit(
   char *Image
);

Loads the specified large image either progressively or opens the Split Image dialog window where the image can be split.

Parameters

char *Image

Complete path to the image.

_OpenLargeImageSplit

Description 

 _OpenLargeImageSplit(
   char *Image
);

Opens the specified large image in the Split Image dialog where the image can be split.

Parameters

char *Image

Complete path to the image.

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