File containing SIDX acquire usage for reference. More...

#include "SIDXConstants.h"

Functions
	SIDXAcquireAbort (integer SIDXacquire, integer status)
	Interrupt and terminate image Acquire. More...

	SIDXAcquireArchiveIsWriting (integer SIDXacquire, integer writing, integer status)
	Determine if issued writing to file operations are being completed. More...

	SIDXAcquireArchiveOpenNew (integer SIDXacquire, string path, string data_type, integer overwrite, integer SIDXarchive, integer status)
	Create an file as an image archive. More...

	SIDXAcquireArchiveWrite (integer SIDXacquire, integer image_index, integer image_count, integer status)
	Archive the specified images. More...

	SIDXAcquireClose (integer SIDXacquire, integer status)
	Close the Acquire. More...

	SIDXAcquireGetBufferCount (integer SIDXacquire, integer count, integer status)
	Obtain the image buffer count used, that is, the number of images that can be stored in the image buffer. More...

	SIDXAcquireGetGapInterval (integer SIDXacquire, double interval, integer status)
	Obtain the minimum time interval from the end of an exposure to the start of the next exposure. More...

	SIDXAcquireGetImageInterval (integer SIDXacquire, double interval, integer status)
	Obtain the time interval between successive images. More...

	SIDXAcquireGetPollingInterval (integer SIDXacquire, double interval, integer status)
	Obtain the maximum interval between successive calls to the Acquire 'GetStatus' call during image Acquire. More...

	SIDXAcquireGetReadoutInterval (integer SIDXacquire, double interval, integer status)
	Obtain the readout interval of an exposed image in seconds. More...

	SIDXAcquireGetStatus (integer SIDXacquire, integer acquiring, integer status)
	Update the Acquire status. More...

	SIDXAcquireImageGetCount (integer SIDXacquire, integer count, integer status)
	Obtain the total number of acquired images since last call to Acquire Start. More...

	SIDXAcquireImageGetDescription (integer SIDXacquire, integer image_index, double start_time, double exposure_duration, integer status)
	Obtains the exposure duration and start time for a specified image. More...

	SIDXAcquireRead (integer SIDXacquire, integer image_count, string image_data, integer status)
	Read images starting from the current read position. More...

	SIDXAcquireReadGetPosition (integer SIDXacquire, integer position, integer status)
	Obtain the current read position. More...

	SIDXAcquireReadoutExists (integer SIDXacquire, integer available, integer status)
	Determine whether readout interval information is available. More...

	SIDXAcquireReadReplace (integer SIDXacquire, integer image_count, wave image_wave, integer start_layer, integer status)
	This function reads 'image_count' images acquired images, starting from the current read position, writing them into the 'image_wave', starting at 'start_layer'. More...

	SIDXAcquireReadSetPosition (integer SIDXacquire, integer image_index, integer status)
	Set the read position to the specific image. More...

	SIDXAcquireSpacingGetSize (integer SIDXacquire, integer size, integer status)
	Obtain the size of an image. More...

	SIDXAcquireStart (integer SIDXacquire, integer status)
	Start Acquire. More...

	SIDXAcquireStop (integer SIDXacquire, integer status)
	Stop Acquire. More...

	SIDXAcquireGetLastError (integer SIDXacquire, string message)
	The function translates the error code into a text string. More...

	SIDXGeometryChannelGetDepth (integer SIDXacquire, integer depth, integer status)
	Obtain the pixel depth of one channel from the image data. More...

	SIDXGeometryImageGetSize (integer SIDXacquire, integer size, integer status)
	Obtain the data size of an image. More...

	SIDXGeometryImageGetType (integer SIDXacquire, integer type, integer status)
	Obtain the image type of the source image. More...

	SIDXGeometryPixelGetCount (integer SIDXacquire, integer x, integer y, integer status)
	Obtain the x and y pixel count for images. More...

	SIDXGeometryPixelSpacingGet (integer SIDXacquire, double x, double y, integer status)
	Obtain the pixel size in x and y. More...

Detailed Description

File containing SIDX acquire usage for reference.

Function Documentation

SIDXAcquireAbort	(	integer	SIDXacquire,
		integer	status
	)

Interrupt and terminate image Acquire.

Parameters

SIDXacquire	A handle value that references the open acquire context.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireArchiveIsWriting	(	integer	SIDXacquire,
		integer	writing,
		integer	status
	)

Determine if issued writing to file operations are being completed.

If an error occurs while archiving, all further write operations will report an error.

Parameters

SIDXacquire	A handle value that references the open acquire context.
writing	A variable to receive an boolean value, true if writing images, false if not.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireArchiveOpenNew	(	integer	SIDXacquire,
		string	path,
		string	data_type,
		integer	overwrite,
		integer	SIDXarchive,
		integer	status
	)

Create an file as an image archive.

If the file already exists and the 'overwrite' parameter is set to 'true', the existing file will be destroyed. If the file already exists and the 'overwrite' parameter is set to 'false', SIDX returns an error.

Parameters

SIDXacquire	A handle value that references the open acquire context.
path	A text string specifying the path to the archive file to create.
data_type	A text string specifying the type of archive data file to write. This value must be the text string "TIFF".
overwrite	A boolean value, true if SIDX should overwrite the existing file, false if it should not.
SIDXarchive	A variable to receive a handle value to use to access the image archive.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireArchiveWrite	(	integer	SIDXacquire,
		integer	image_index,
		integer	image_count,
		integer	status
	)

Archive the specified images.

This operation is valid only if an archive is open. The operation is asynchronous, it will return before the images have been archived. All images to be archived must exist.

Parameters

SIDXacquire	A handle value that references the open acquire context.
image_index	An integer value specifying the starting image number to archive.
image_count	An integer value specifying the number of images to archive.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireClose	(	integer	SIDXacquire,
		integer	status
	)

Close the Acquire.

After this call, the Acquire is no longer valid and camera settings can be changed.

Parameters

SIDXacquire	A handle value that references the open acquire context.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireGetBufferCount	(	integer	SIDXacquire,
		integer	count,
		integer	status
	)

Obtain the image buffer count used, that is, the number of images that can be stored in the image buffer.

This value may differ from the setting.

Parameters

SIDXacquire	A handle value that references the open acquire context.
count	A variable to receive an integer value representing the image buffer count, as a number of images.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireGetGapInterval	(	integer	SIDXacquire,
		double	interval,
		integer	status
	)

Obtain the minimum time interval from the end of an exposure to the start of the next exposure.

Parameters

SIDXacquire	A handle value that references the open acquire context.
interval	A variable to receive a real (floating-point) value specifying the minimum time interval gap between the end of one exposure and the start of the next, in seconds.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireGetImageInterval	(	integer	SIDXacquire,
		double	interval,
		integer	status
	)

Obtain the time interval between successive images.

This value is an estimate based on the camera settings. For cameras in modes with controlled timing, this value may be accurate. For example, if the camera supports fixed-rate image streaming with overlapped image integration and readout, this value may be the actual interval between successive images. For external trigger modes, the reported interval is the minimum time from the start of one image exposure to the start of the next. The actual interval is determined by the external trigger. The image interval is constant during Acquire, it does not change.

Parameters

SIDXacquire	A handle value that references the open acquire context.
interval	A variable to receive a real (floating-point) value specifying the image interval in seconds.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireGetLastError	(	integer	SIDXacquire,
		string	message
	)

The function translates the error code into a text string.

Parameters

SIDXacquire	A handle value that references the open acquire context.
message	A text string to receive the text associated with the last error occurred.

SIDXAcquireGetPollingInterval	(	integer	SIDXacquire,
		double	interval,
		integer	status
	)

Obtain the maximum interval between successive calls to the Acquire 'GetStatus' call during image Acquire.

For example, if the maximum service interval is 250ms, during Acquire, the Acquire 'GetStatus' operation must be called at least once every 250ms.

Parameters

SIDXacquire	A handle value that references the open acquire context.
interval	A variable to receive a real (floating-point) value representing the maximum service interval, in seconds.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireGetReadoutInterval	(	integer	SIDXacquire,
		double	interval,
		integer	status
	)

Obtain the readout interval of an exposed image in seconds.

Parameters

SIDXacquire	A handle value that references the open acquire context.
interval	A variable to receive a real (floating-point) value specifying the readout interval in seconds.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireGetStatus	(	integer	SIDXacquire,
		integer	acquiring,
		integer	status
	)

Update the Acquire status.

This is a polling operation. The operation must be called at least once within the service interval. For example, if the Acquire service interval is 500ms, this operation must be called at least once every 500ms. The function returns true or false to indicate that the camera is actually acquiring. If an error occurs, than the boolean value is undefined.

Parameters

SIDXacquire	A handle value that references the open acquire context.
acquiring	A variable to receive a boolean value, true if the camera is acquiring, false if not.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireImageGetCount	(	integer	SIDXacquire,
		integer	count,
		integer	status
	)

Obtain the total number of acquired images since last call to Acquire Start.

Parameters

SIDXacquire	A handle value that references the open acquire context.
count	A variable to receive an integer count containing the total number of images acquired since Acquire started.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireImageGetDescription	(	integer	SIDXacquire,
		integer	image_index,
		double	start_time,
		double	exposure_duration,
		integer	status
	)

Obtains the exposure duration and start time for a specified image.

If the camera does not provide a start time, SIDX will provide the software time of the received image. The exposure duration is constant throughout an acquisition, except in the case that the exposure duration is set by an external trigger signal. In that case, the camera may provide the actual exposure duration separately for each image and SIDX will return a value of zero (0). If the camera does not provide the exposure duration, SIDX will return the exposure duration that was set. If the camera does provide the exposure duration, SIDX will return the value from the camera.

Parameters

SIDXacquire	A handle value that references the open acquire context.
image_index	An integer value specifying the image for which to return time.
start_time	A variable to receive a real (floating-point) value specifying the start time.
exposure_duration	A variable to receive a real (floating-point) value specifying the exposure duration.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireRead	(	integer	SIDXacquire,
		integer	image_count,
		string	image_data,
		integer	status
	)

Read images starting from the current read position.

The number of images read is the same as the image_count, otherwise SIDX will report an error.

Parameters

SIDXacquire	A handle value that references the open acquire context.
image_count	An integer value specifying the number of images to read.
image_data	The wave name as text string for saving the image data.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireReadGetPosition	(	integer	SIDXacquire,
		integer	position,
		integer	status
	)

Obtain the current read position.

The read position is an integer image index. The first image is at position zero.

Parameters

SIDXacquire	A handle value that references the open acquire context.
position	A variable to receive an integer value representing the read position.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireReadoutExists	(	integer	SIDXacquire,
		integer	available,
		integer	status
	)

Determine whether readout interval information is available.

Parameters

SIDXacquire	A handle value that references the open acquire context.
available	A variable to receive a boolean value, true if the readout interval is available, false if the readout interval is not available.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireReadReplace	(	integer	SIDXacquire,
		integer	image_count,
		wave	image_wave,
		integer	start_layer,
		integer	status
	)

This function reads 'image_count' images acquired images, starting from the current read position, writing them into the 'image_wave', starting at 'start_layer'.

For example, if 'image_count' is 3 and 'start_layer' is 10, then the images are read into 'image_wave' layers 10, 11, and 12. When the function returns, the current read position is advanced by 'image_count'.

This function does not change the geometry of the 'image_wave'. The 'image_wave' must be an existing 3D wave, and the layers must have the same geometry as the acquired images. The specified 'image_wave' layers must exist, that is, the 'image_count' layers starting at 'start_layer'.

Parameters

SIDXacquire	A handle value that references the open acquire context.
image_count	An integer value specifying the number of images to read.
image_wave	The wave for saving the image data.
start_layer	The start layer index of image_wave for storing the incoming images.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireReadSetPosition	(	integer	SIDXacquire,
		integer	image_index,
		integer	status
	)

Set the read position to the specific image.

Parameters

SIDXacquire	A handle value that references the open acquire context.
image_index	An integer value specifying new read position, expressed as an image number. The image number is greater than or equal to zero.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireSpacingGetSize	(	integer	SIDXacquire,
		integer	size,
		integer	status
	)

Obtain the size of an image.

The size of an image is the amount of storage required for an image during acquisition, including padding. For example, if images during acquisition are padded to the next multiple of 512 bytes, this value will always be a multiple of 512

Parameters

SIDXacquire	A handle value that references the open acquire context.
size	A variable to receive an integer value representing the size of an image, measured in bytes.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireStart	(	integer	SIDXacquire,
		integer	status
	)

Start Acquire.

For a given open acquire context, the Acquire can start/stop an arbitrary number of times.

Parameters

SIDXacquire	A handle value that references the open acquire context.
status	Non-zero if the function failed, zero if it succeeded.

SIDXAcquireStop	(	integer	SIDXacquire,
		integer	status
	)

Stop Acquire.

This operation should be used only if Acquire has completed as expected, the operation should not be used to interrupt running image Acquire.

Parameters

SIDXacquire	A handle value that references the open acquire context.
status	Non-zero if the function failed, zero if it succeeded.

SIDXGeometryChannelGetDepth	(	integer	SIDXacquire,
		integer	depth,
		integer	status
	)

Obtain the pixel depth of one channel from the image data.

For grayscale image, there is one channel. For RGB image, there are three channels which represent red, green and blue respectively.

Parameters

SIDXacquire	A handle value that references the open acquire context.
depth	A variable to receive an integer value representing the channel depth.
status	Non-zero if the function failed, zero if it succeeded.

SIDXGeometryImageGetSize	(	integer	SIDXacquire,
		integer	size,
		integer	status
	)

Obtain the data size of an image.

The data size of an image is the size of the data in an image, excluding any padding.

Parameters

SIDXacquire	A handle value that references the open acquire context.
size	A variable to receive an integer value representing the size of the data in an image, measured in bytes.
status	Non-zero if the function failed, zero if it succeeded.

SIDXGeometryImageGetType	(	integer	SIDXacquire,
		integer	type,
		integer	status
	)

Obtain the image type of the source image.

Parameters

SIDXacquire	A handle value that references the open acquire context.
type	A variable to receive a value describing the type of source image.
status	Non-zero if the function failed, zero if it succeeded.

SIDXGeometryPixelGetCount	(	integer	SIDXacquire,
		integer	x,
		integer	y,
		integer	status
	)

Obtain the x and y pixel count for images.

Parameters

SIDXacquire	A handle value that references the open acquire context.
x	A variable to receive an integer value representing the pixel count on the x axis.
y	A variable to receive an integer value representing the pixel count on the y axis.
status	Non-zero if the function failed, zero if it succeeded.

SIDXGeometryPixelSpacingGet	(	integer	SIDXacquire,
		double	x,
		double	y,
		integer	status
	)

Obtain the pixel size in x and y.

Parameters

SIDXacquire	A handle value that references the open acquire context.
x	A variable to receive a real (floating point) value representing the horizontal pixel spacing, measured in meters.
y	A variable to receive a real (floating point) value representing the vertical pixel spacing, measured in meters.
status	Non-zero if the function failed, zero if it succeeded.

Functions

Detailed Description

Function Documentation