ADVACAM Wiki - Recent changes [en]

Binary core API

HudecekP — Wed, 06 May 2026 13:01:31 GMT

Parameter Get/Set functions (using text paramName)

← Older revision		Revision as of 15:01, 6 May 2026
(One intermediate revision by the same user not shown)
Line 2,788:		Line 2,788:
	\| Not = '''Metadata names''' obtaining: Save some frame to file and see the avalilable metadata to a .dsc file saved with the image. Some image formats do not store metadata externally. Use e.g. txt, pmf, bmf.		\| Not = '''Metadata names''' obtaining: Save some frame to file and see the avalilable metadata to a .dsc file saved with the image. Some image formats do not store metadata externally. Use e.g. txt, pmf, bmf.
	\| War =		\| War =
	\| Exa = char mdb[200]; // metadata buffer		\| Exa = char mdb[200]; // metadata buffer
	unsigned mdbs = 200; // metadata buffer size		unsigned mdbs = 200; // metadata buffer size
	char mdn[] = "Start time"; // metadata name		char mdn[] = "Start time"; // metadata name

Line 2,808:		Line 2,808:
	printf("pxcSetDeviceParameter %d", rc);		printf("pxcSetDeviceParameter %d", rc);
	</syntaxhighlight>		</syntaxhighlight>
	'''~~Warning~~: Most parameters are for testing purposes only and you will not need them in normal use.'''		'''Warnings:'''
			* Most parameters are for testing purposes only and you will '''not need them in normal use'''.
			* Some parameters '''has variations between revisions''' of devices, firmware versions and Pixet versions.

	{{ApiBinaryItem		{{ApiBinaryItem

Pixet SDK

HudecekP — Wed, 06 May 2026 12:37:34 GMT

Python API

← Older revision		Revision as of 14:37, 6 May 2026
(2 intermediate revisions by the same user not shown)
Line 63:		Line 63:
	* '''pxproc.dll''' or '''pxproc.so''' binary libraries for Windows or Linux		* '''pxproc.dll''' or '''pxproc.so''' binary libraries for Windows or Linux
	* '''pxproc.lib''' static linging file for easier using on Windows (compile time only)		* '''pxproc.lib''' static linging file for easier using on Windows (compile time only)
			'''Note:''' These files are currently '''on demand''', not included in default API package.<br>
	'''See [[Binary Clustering API]]'''		'''See [[Binary Clustering API]]'''
	<br>		<br>
Line 73:		Line 73:
	* '''pxproc.dll''' or '''pxproc.so''' binary libraries for Windows or Linux		* '''pxproc.dll''' or '''pxproc.so''' binary libraries for Windows or Linux
	* '''pxproc.lib''' static linging file for easier using on Windows (compile time only)		* '''pxproc.lib''' static linging file for easier using on Windows (compile time only)
			'''Note:''' These files are currently '''on demand''', not included in default API package.<br>
	'''See [[Binary Spectral Imaging API ]]'''		'''See [[Binary Spectral Imaging API ]]'''
	<br>		<br>
Line 85:		Line 85:
	<br>		<br>
	This API also using the '''pxcore''' and '''pxproc''' libraries.<br>		This API also using the '''pxcore''' and '''pxproc''' libraries.<br>
	<br>		'''Note:''' The '''pypxproc''' library are currently '''on demand''', not included in default API package.<br>

	'''See [[Python API]]'''<br>		'''See [[Python API]]'''<br>

Files and directories of the Pixet and SDK

HudecekP — Fri, 24 Apr 2026 15:02:42 GMT

[Plugins]

← Older revision		Revision as of 17:02, 24 April 2026
(3 intermediate revisions by the same user not shown)
Line 45:		Line 45:
	* Location of this directory '''not affected by''' the '''UseAppDataDir=''' in pixet.ini.		* Location of this directory '''not affected by''' the '''UseAppDataDir=''' in pixet.ini.
	* File '''names must be exact''', for example MiniPIX-D06-W0065.xml, AdvaPIX-C06-W0127-4.xml. It is the complete device name, where all spaces are replaced by minuses. If not exact, a load-factory like functions cannot find it.		* File '''names must be exact''', for example MiniPIX-D06-W0065.xml, AdvaPIX-C06-W0127-4.xml. It is the complete device name, where all spaces are replaced by minuses. If not exact, a load-factory like functions cannot find it.

			'''See:'''
			* [[#pixet.ini file]] - <nowiki>[Settings]</nowiki> section

	=== configs ===		=== configs ===
Line 57:		Line 60:

	'''Note:''' The default '''UseAppDataDir=''' in pixet.ini is '''enabled in Pixet''' installation, but '''disabled in API''' package.		'''Note:''' The default '''UseAppDataDir=''' in pixet.ini is '''enabled in Pixet''' installation, but '''disabled in API''' package.

			'''See:'''
			* [[#pixet.ini file]] - <nowiki>[Settings]</nowiki> section

	== logs ==		== logs ==
Line 73:		Line 79:

	'''Note:''' The default '''UseAppDataDir=''' in pixet.ini is '''enabled in Pixet''' installation, but '''disabled in API''' package.		'''Note:''' The default '''UseAppDataDir=''' in pixet.ini is '''enabled in Pixet''' installation, but '''disabled in API''' package.

			'''See:'''
			* [[#pixet.ini file]] - <nowiki>[Settings]</nowiki> section

	== hwlibs ==		== hwlibs ==
Line 78:		Line 87:
	'''Note:''' The default '''UseAppDataDir=''' in pixet.ini is '''enabled in Pixet''' installation, but '''disabled in API''' package.		'''Note:''' The default '''UseAppDataDir=''' in pixet.ini is '''enabled in Pixet''' installation, but '''disabled in API''' package.

	See [[#pixet.ini file]]		'''See:'''
			* [[#pixet.ini file]] - <nowiki>[Hwlibs]</nowiki> section

	== plugins ==		== plugins ==
	Default location of plugins to the Pixet program.<br>		Default location of plugins to the Pixet program.<br>
	Warning: Some plugins can be need for API too.		Warning: Some plugins can be need for API too.

			'''See:'''
			* [[#pixet.ini file]] - <nowiki>[Plugins]</nowiki> section

	== drivers ==		== drivers ==
Line 176:		Line 189:
	\| <syntaxhighlight line lang=ini highlight=10,11>		\| <syntaxhighlight line lang=ini highlight=10,11>
	[Hwlibs]		[Hwlibs]
	~~hwlib~~=hwlibs\minipix.dll		Hwlib=hwlibs\minipix.dll
	~~hwlib~~=hwlibs\widepix.dll		Hwlib=hwlibs\widepix.dll
	~~hwlib~~=hwlibs\zem.dll		Hwlib=hwlibs\zem.dll
	;~~hwlib~~=hwlibs\zest.dll		;Hwlib=hwlibs\zest.dll
	</syntaxhighlight>		</syntaxhighlight>
	\| <syntaxhighlight line lang=ini highlight=10,11>		\| <syntaxhighlight line lang=ini highlight=10,11>
	[Hwlibs]		[Hwlibs]
	~~hwlib~~=minipix.dll		Hwlib=minipix.dll
	~~hwlib~~=widepix.dll		Hwlib=widepix.dll
	~~hwlib~~=zem.dll		Hwlib=zem.dll
	;~~hwlib~~=zest.dll		;Hwlib=zest.dll
	</syntaxhighlight>		</syntaxhighlight>
	\|		\|
Line 206:		Line 219:

	User can disable some hwlibs using the ; symbol.<br><br>		User can disable some hwlibs using the ; symbol.<br><br>

			'''Warning:'''
			* The '''Hwlib=''' must be exactly Hwlib=, it '''case sensitive'''
			<br>

	'''List of HWLIB files:''' Windows / Linux		'''List of HWLIB files:''' Windows / Linux
	* '''Minipix''': minipix.dll / minipix.so		* '''Minipix''': minipix.dll / minipix.so
Line 220:		Line 238:
	: Accessing specific files like as '''HDF5''', '''TIFF'''		: Accessing specific files like as '''HDF5''', '''TIFF'''
	: These plugins are also needed when using an API.		: These plugins are also needed when using an API.

			'''Warning:'''
			* The Plugin= must be exactly Plugin=, it case sensitive

	=== <nowiki>[PixelmanPlugins]</nowiki> ===		=== <nowiki>[PixelmanPlugins]</nowiki> ===

Binary core API

HudecekP — Wed, 22 Apr 2026 13:09:34 GMT

Frame measuring and related functions list

← Older revision		Revision as of 15:09, 22 April 2026
(4 intermediate revisions by the same user not shown)
Line 3,673:		Line 3,673:
	int rc; // return codes		int rc; // return codes
	double frameTime = 2;		double frameTime = 2;
	unsigned buffrerFrames = 3;		unsigned buffrerFrames = 30;
	tMmfClbData usrData;		tMmfClbData usrData;
	usrData.di = deviceIndex;		usrData.di = deviceIndex;
Line 3,962:		Line 3,962:
	\|-		\|-
	\| '''DDDummyDataSpeed'''<br>Virtual data speed of dummy device \|\| (has no) \|\| 24831		\| '''DDDummyDataSpeed'''<br>Virtual data speed of dummy device \|\| (has no) \|\| 24831
			\|-
			\| '''BlockCount'''<br>Count of occupied blocks after measurement.<br>(zeroed at start and updated at the end of the measurement) \|\| (has no) \|\| (read)
			\|-
			\| '''trgTimeStamp'''<br>Store trigger events to data. If enabled, trigger events will stored to the data as pixel with Overflow=10. See [[File_types#T3PA_files_details\|T3PA files_details]]<br>Note: Testing feature, t3pa-like ASCII line used in all file formats, including binary. \|\| [bool]<br>default 0 \|\| [bool]<br>default 0
	\|-		\|-
	\| '''DataOverflowCheck'''<br>If an overflow occurs and the check is on, the measurement is immediately terminated with an error. If it is off, the overflow is displayed in the data and the measurement continues to the normal end. \|\| [bool]<br>default 0 \|\| (has no)		\| '''DataOverflowCheck'''<br>If an overflow occurs and the check is on, the measurement is immediately terminated with an error. If it is off, the overflow is displayed in the data and the measurement continues to the normal end. \|\| [bool]<br>default 0 \|\| (has no)
	\|-
	~~\| '''BlockCount'''<br>Count of occupied blocks after measurement.<br>(zeroed at start and updated at the end of the measurement) \|\| (has no) \|\| (read)~~
	\|}		\|}
	\|}		\|}

Files and directories of the Pixet and SDK

HudecekP — Tue, 21 Apr 2026 08:53:55 GMT

factory

← Older revision		Revision as of 10:53, 21 April 2026
Line 42:		Line 42:
	Hint: If you frequently do experiments with more instances of Pixet, API-using programs or scripts and have more devices, you can use single location of the factory directory for all.		Hint: If you frequently do experiments with more instances of Pixet, API-using programs or scripts and have more devices, you can use single location of the factory directory for all.

	'''~~Note~~:''' Location of this directory '''not affected by''' the '''UseAppDataDir=''' in pixet.ini.		'''Notes:'''
			* Location of this directory '''not affected by''' the '''UseAppDataDir=''' in pixet.ini.
			* File '''names must be exact''', for example MiniPIX-D06-W0065.xml, AdvaPIX-C06-W0127-4.xml. It is the complete device name, where all spaces are replaced by minuses. If not exact, a load-factory like functions cannot find it.

	=== configs ===		=== configs ===

Binary core API

HudecekP — Thu, 16 Apr 2026 15:29:20 GMT

Data-driven special settings

← Older revision		Revision as of 17:29, 16 April 2026
(7 intermediate revisions by the same user not shown)
Line 2,731:		Line 2,731:
	\| War =		\| War =
	\| Exa =		\| Exa =
			}}

			{{ApiBinaryItem
			\| Nam = pxcFindNoisyPixels
			\| HeSym = ===
			\| Sum = Finds noisy pixels
			:* Can optionally mask found pixelt in User mask (doMaskNoisyPixels)
			:* Can optionally save mask matrix to pointed array (noisyPixelsMatrix != NULL)
			\| DefH = PXCAPI int
			\| DefP = unsigned deviceIndex, double limitNoisy = 50, double limitSatur = 50, bool doMaskNoisyPixels = false, unsigned* noisyPixelsMatrix = nullptr, unsigned matrixSize = 65536
			\| deviceIndex – index of the device, starting from zero
			\| limitNoisy – limit [hits] to mask noisy pixels. It goes from 1 to max count value (currently only 1022), where 1 is the most strongest masking and max is the weakest.
			\| limitSatur – limit [%] to mask saturated pixels. The iToT is used, if the device has this feature. It goes from 0 to 100, where 0 is the most strongest masking and 100 is the weakest.
			\| doMaskNoisyPixels – check to mask noisy pixels within the process. Default is false alias do not mask.
			\| noisyPixelsMatrix – mask/positions of noisy pixels.
			\| matrixSize – size of the matrix.
			\|
			\|
			\| Ret = 0 if successful, otherwise the return value is a PXCERR_XXX code.
			\| Not = Currently '''Tpx3 only'''.
			\| War = Must be run only when the device is in environment WITHOUT radiation background.
			\| Exa =
	}}		}}

Line 3,913:		Line 3,935:
	== Data-driven special settings ==		== Data-driven special settings ==
	{\|		{\|
	\|-		\|- style="vertical-align:top;"
	\|		\| <br>
	The Pixet core has a circular buffer in memory to receiving new pixels.		The Pixet core has a circular buffer in memory to receiving new pixels.
	* Size of buffer is named '''buffer size'''.		* Size of whole buffer is named '''buffer size'''.
	* Buffer is divided to blocks with '''block size'''.		* Buffer is divided to blocks with '''block size'''.
	Received data is continuously stored to the buffer.		Received data is continuously stored to the buffer.
	* Every reaching next block, the callback New data occurs.		* Every reaching next block, the callback New data occurs or data saved to file.
	* At a low event rate, the callback is also called regularly, e.g. 500 ms on ~~Minipix~~.		* At a low event rate, the callback is also called regularly, e.g. 500 ms on MiniPIX, or more on AdvaPIX (1.7 s with defaults).
	* When the buffer runs out, the measurement ends with an error.		* When the buffer runs out, the measurement ends with an error.
	* If file saving is used, data is not accumulated in the buffer, callbacks do not occur, the buffer never runs out and measurement may by very long.		* If file saving is used, data is not accumulated in the buffer, callbacks do not occur, the buffer never runs out and measurement may by very long.
Line 3,937:		Line 3,959:
	\| '''DDBlockSize'''<br>Size of each block \|\| [B]<br>default 66000 \|\| [MB]<br>default 5		\| '''DDBlockSize'''<br>Size of each block \|\| [B]<br>default 66000 \|\| [MB]<br>default 5
	\|-		\|-
	\| '''~~DDBlockSizeDivider~~'''<br>Unit divider for smaller blocks on AdvaPIX \|\| (has no) \|\| [/MB]<br>default 1		\| '''DDBlockDivider'''<br>Unit divider for smaller blocks on AdvaPIX<br>Divider can shorten the timeout downto ~500 ms. \|\| (has no) \|\| [/MB]<br>default 1
	\|-		\|-
	\| '''DDDummyDataSpeed'''<br>Virtual data speed of dummy device \|\| (has no) \|\| 24831		\| '''DDDummyDataSpeed'''<br>Virtual data speed of dummy device \|\| (has no) \|\| 24831
			\|-
			\| '''DataOverflowCheck'''<br>If an overflow occurs and the check is on, the measurement is immediately terminated with an error. If it is off, the overflow is displayed in the data and the measurement continues to the normal end. \|\| [bool]<br>default 0 \|\| (has no)
			\|-
			\| '''BlockCount'''<br>Count of occupied blocks after measurement.<br>(zeroed at start and updated at the end of the measurement) \|\| (has no) \|\| (read)
	\|}		\|}
	\|}		\|}
Line 3,975:		Line 4,001:
	\| deviceIndex – index of the device, starting from zero		\| deviceIndex – index of the device, starting from zero
	\| measTime – the total time of the measurement in seconds. Use 0 for infinite.		\| measTime – the total time of the measurement in seconds. Use 0 for infinite.
	\| filename – output file name and path (extensions must ~~end~~ .t3pa, .~~trp~~, *.t3r)		\| filename – output file name and path (extensions must be .t3pa, .t3p, *.t3r)
	\| trgStg – settings of external trigger - one of the PXC_TRG_XXX values. Default PXC_TRG_NO		\| trgStg – settings of external trigger - one of the PXC_TRG_XXX values. Default PXC_TRG_NO
	\| callback – pointer to function of acqEventFunc type		\| callback – pointer to function of acqEventFunc type