_Create3DMovie, GetCurrentViewIndex, GetCurrentViewProjection, GetImageOriginalStatus, GetOpenedViewList, PictureMouseOperation, SyncLocus, Thumbnails, TranslateOriginalStatusToText

_Create3DMovie

Description 

 _Create3DMovie();

This function displays the Create 3D Movie dialog window. AVI movie of rotation of the current Volume View / Surface View of a Z sequence can be created via this window.

GetCurrentViewIndex

Description 

 GetCurrentViewIndex();

Returns the (zero-based) index of the currently opened view (or job) as listed in the Main Menu > Window. If no view is opened, the function returns -1.

GetCurrentViewProjection

Description 

 GetCurrentViewProjection(
   int *pPrimaryProjection,
   int *pSecondaryProjection,
   int *pMinMaxIP,
   int *pIPType
);

This function is used to find out what projection is used on the current view, whether Maximum/Minimum Intensity Projection is enabled and if so, on which axis. It can be used especially in Maximum/Minimum Intensity View, Slices View, and Tiled View.

Parameters

int *pPrimaryProjection

Serves as an output parameter, returns what the current primary projection is.

0	none (xy)
1	Z-Series
2	Time
3	Multipoint
4	Custom

int *pSecondaryProjection

Serves as an output parameter, returns what the current secondary projection is (Tiled View only).

0	none (xy)
1	Z-Series
2	Time
3	Multipoint
4	Custom

int *pMinMaxIP

Serves as an output parameter, returns whether Maximum/Minimum Intensity Projection is enabled.

0	none
1	Maximum
2	Minimum

int *pIPType

Serves as an output parameter, returns the axis in which Intensity Projection is set.

0	none
1	Z-Series
2	Time
3	Multipoint
4	Custom

GetImageOriginalStatus

Description 

int GetImageOriginalStatus(
   int  section
);

This function checks in the active document whether the required section is Original or Modified.

Parameters

int section

Section.

0	Image attributes - basic metadata such as date, etc.
1	Text description - fulltext field description containing e.g. which camera was used for acquisition.
2	Custom metadata - field with custom metadata.
3	Image - image itself.
4	Timestamps - timestamps of single frames.
5	Experiment - metadata of the experiment / ND Acquisition, e.g. number of time loops.
6	Acquisition details - advanced metadata, e.g. OC details like camera, objective, etc.

Return Values

int

0	Original
-1	Not present - the file does not contain a checksum for the section.
-2	Modified.
-8	Invalid parameter - macro called with a wrong argument (out of range 0-6, please see int section).
-9	File not found - Failed to access a file (e.g. when calling a macro when none is open).

GetOpenedViewList

Description 

 GetOpenedViewList(
   char *OpenedViewList,
   int *OpenedViewTypesList,
   int  MaxItems,
   int *MaxPath
);

This function writes the list of opened Views to the buffer OpenedViewList and fills TypesList with the type of each view. Each View name will have the length of MaxPath (name of nth view starts at offset n * MaxPath starting from n=0, eg. char* thirdViewName = OpenedViewList[2 * Maxpath];). If MaxItems is lower than the number of opened views, the function returns a minus number of documents and the list is not filled. If MaxPath is insufficient, the function fails, returns a minus number of documents and the MaxPath will be set to minus length of the first encountered view with a too long name.

Parameters

char *OpenedViewList

Buffer which will be filled with view names. The size of the buffer must be at least (MaxItem * MaxPath).

int *OpenedViewTypesList

List of types for each view. The list must be preallocated to at least MaxPath.

0	Main View
1	Volume View
2	Tiled View
3	Slices View
4	Surface View
5	Maximum Intensity Projection
6	Minimum Intensity Projection
7	EDF Focused View
8	Intensity Surface Plot
9	EDF Anaglyph View
10	Job Editor
11	Job Result
12	Unknown

int MaxItems

Capacity of the OpenedDocumentList (or OpenedViewList and TypesList) buffer.

int *MaxPath

Pointer to int which holds the size of each item in OpenedDocumentList.

Example:
int numViews = 0;
char views[24 * MAX_FILE_NAME]
int maxChars = MAX_FILE_NAME;
int types[24];

int i;
char* fileName;

numViews = GetOpenedViewList(views, types, 24, &maxChars);

if (numViews < 0)
{
if (maxChars < 0)
{
// function failed, we need to increase maxChars to at least (-maxChars)
maxChars = -maxChars;
numViews = GetOpenedViewList(views, types, 24, &maxChars);
}
else
{
// function failed, we need to allocate bigger buffer
// char views[48 * MAX_FILE_NAME];
// int types[48];
}
}
else
{
for (i = 0; i < numViews; ++i)
{
fileName = views + (i * MAX_FILE_NAME);
int fileType = types[i];
}
}

PictureMouseOperation

Description 

 PictureMouseOperation(
   int  MouseOp
);

This function turns switches between mouse operation modes (cursor types). Some operation modes are further divided to tools (e.g. manual measurement contains several measuring tools). Selection of these tools is not handled by this function, the most recently used tool is selected by default.

Parameters

int MouseOp

specifies mouse operation mode, either pointing tool or magnifier

0	pointing tool
1	magnifier glass
2	manual measurement
3	simple arrow insertion
4	deprecated
5	annotation tool
6	Mouse XY (for moving XY stage by dragging live image)
7	3D measurement tool
8	deprecated
9	binary toolbar
10	realtime tracking (following moving scene by XY stage)

SyncLocus

Description 

 SyncLocus();

Synchronizes the observed data area from the active view to other views of the current document.

Thumbnails

This function runs the View > Thumbnails menu command.

Description 

 Thumbnails();

This function displays all working images at reduced size.

TranslateOriginalStatusToText

Description 

 TranslateOriginalStatusToText(
   int  status
);

Translates the output from the above macro into text, e.g. for the use in reports.

Parameters

int status

Status.

0	Returns “Original”.
-1	Returns “No Data”.
-2	Returns “Modified”.
-8	Returns “Invalid Parameter”.
-9	Returns “Could not open file”.
other	Returns “Invalid Parameter”.