Binary Spectral Imaging API - Revision history

HudecekP: /* The Spectral imaging API basic workflow */

2024-01-04T10:53:48Z

The Spectral imaging API basic workflow

← Older revision		Revision as of 12:53, 4 January 2024
Line 40:		Line 40:
	: 10. Deinitialize the Pixet core, if the '''pxcInitialize''' was used in step 1.		: 10. Deinitialize the Pixet core, if the '''pxcInitialize''' was used in step 1.
	(For 1.a/b init ways see related Clustering API examples: '''[[Binary_Clustering_API#Initializing_using_the_pxpClLoadPixetCore\|Binary Clustering API: Initializing using the pxpClLoadPixetCore]]''' and '''[[Binary_Clustering_API#Initializing_from_the_active_Pixet_core\|Binary Clustering API: Initializing from the active Pixet_core]]''')<br>		(For 1.a/b init ways see related Clustering API examples: '''[[Binary_Clustering_API#Initializing_using_the_pxpClLoadPixetCore\|Binary Clustering API: Initializing using the pxpClLoadPixetCore]]''' and '''[[Binary_Clustering_API#Initializing_from_the_active_Pixet_core\|Binary Clustering API: Initializing from the active Pixet_core]]''')<br>
			<br>
			[[File:SpectralImg-principe.png\|frame\|center\|alt=What do the Spectral imaging\|What do the Spectral imaging]]
	<br>		<br>
	; Using BSTG files to save processing time:		; Using BSTG files to save processing time:

HudecekP: /* Functions that using the output data */

2024-01-03T12:43:24Z

Functions that using the output data

← Older revision		Revision as of 14:43, 3 January 2024
Line 758:		Line 758:
	\| handle – SpectraImg handle received from function pxpSiCreate		\| handle – SpectraImg handle received from function pxpSiCreate
	\| *data – data buffer where the spectrum will be stored		\| *data – data buffer where the spectrum will be stored
	\| step – step of the spectra		\| *step [out] – pointer to store step of the spectra
	\| *size [in/out] – pointer to the size of the supplied buffer. if buffer ~~small,~~ size will contain correct size.		\| *size [in/out] – pointer to the size of the supplied buffer.
			: If buffer size doesn't match error occurs and size will contain correct size.
	: Correct spectrum size can be obtained via '''pxpSiSpectrumSize''' function.		: Correct spectrum size can be obtained via '''pxpSiSpectrumSize''' function.
	\|		\|

HudecekP: /* Functions that using the output data */

2024-01-03T12:41:57Z

Functions that using the output data

← Older revision		Revision as of 14:41, 3 January 2024
Line 774:		Line 774:
	\| Nam = pxpSiGetGlobalSpectrumInRect		\| Nam = pxpSiGetGlobalSpectrumInRect
	\| HeSym = ==		\| HeSym = ==
	\| Sum = Gets the global energy spectrum in selected frame rectangle		\| Sum = Gets the global energy spectrum in selected frame rectangle. Pixel pos. conditions are <= and >=
	\| DefH = PXSIAPI int		\| DefH = PXSIAPI int
	\| DefP = clhandle_t handle, unsigned x1, unsigned y1, unsigned x2, unsigned y2, unsigned* data, double* step, size_t* size		\| DefP = clhandle_t handle, unsigned x1, unsigned y1, unsigned x2, unsigned y2, unsigned* data, double* step, size_t* size
Line 783:		Line 783:
	\| y2 – bottom coordinate of the rectangle		\| y2 – bottom coordinate of the rectangle
	\| *data – data buffer where the spectrum will be stored		\| *data – data buffer where the spectrum will be stored
	\| step – step of the spectra		\| *step [out] – pointer to store step of the spectra
	\| *size [in/out] – pointer to the size of the supplied buffer. if buffer ~~small,~~ size will contain correct size.		\| *size [in/out] – pointer to the size of the supplied buffer.
			: If buffer size doesn't match error occurs and size will contain correct size.
	: Correct spectrum size can be obtained via '''pxpSiSpectrumSize''' function.		: Correct spectrum size can be obtained via '''pxpSiSpectrumSize''' function.
	\| Ret = 0 if successful, otherwise the return value is a SI_ERR_XXX code.		\| Ret = 0 if successful, otherwise the return value is a SI_ERR_XXX code.

HudecekP: /* The Spectral imaging API basic workflow */

2024-01-03T10:18:24Z

The Spectral imaging API basic workflow

← Older revision		Revision as of 12:18, 3 January 2024
Line 39:		Line 39:
	: 9. Use some get… method and use the processed data.		: 9. Use some get… method and use the processed data.
	: 10. Deinitialize the Pixet core, if the '''pxcInitialize''' was used in step 1.		: 10. Deinitialize the Pixet core, if the '''pxcInitialize''' was used in step 1.
	(For 1.a/b init ways see related Clustering API examples: '''[[Binary_Clustering_API#Initializing_using_the_pxpClLoadPixetCore\|Binary Clustering API: Initializing using the pxpClLoadPixetCore]]''' and '''[[Binary_Clustering_API#Initializing_from_the_active_Pixet_core\|Binary Clustering API: Initializing from the active Pixet_core]]''')		(For 1.a/b init ways see related Clustering API examples: '''[[Binary_Clustering_API#Initializing_using_the_pxpClLoadPixetCore\|Binary Clustering API: Initializing using the pxpClLoadPixetCore]]''' and '''[[Binary_Clustering_API#Initializing_from_the_active_Pixet_core\|Binary Clustering API: Initializing from the active Pixet_core]]''')<br>
	<br>		<br>
	; Using BSTG files to save processing time:		; Using BSTG files to save processing time:

HudecekP: /* The Spectral imaging API basic workflow */

2024-01-03T10:18:08Z

The Spectral imaging API basic workflow

← Older revision		Revision as of 12:18, 3 January 2024
Line 39:		Line 39:
	: 9. Use some get… method and use the processed data.		: 9. Use some get… method and use the processed data.
	: 10. Deinitialize the Pixet core, if the '''pxcInitialize''' was used in step 1.		: 10. Deinitialize the Pixet core, if the '''pxcInitialize''' was used in step 1.
			(For 1.a/b init ways see related Clustering API examples: '''[[Binary_Clustering_API#Initializing_using_the_pxpClLoadPixetCore\|Binary Clustering API: Initializing using the pxpClLoadPixetCore]]''' and '''[[Binary_Clustering_API#Initializing_from_the_active_Pixet_core\|Binary Clustering API: Initializing from the active Pixet_core]]''')
	<br>		<br>
	; Using BSTG files to save processing time:		; Using BSTG files to save processing time:

HudecekP: /* LoadPixetCore and UnloadPixetCore */

2024-01-03T10:14:28Z

LoadPixetCore and UnloadPixetCore

← Older revision		Revision as of 12:14, 3 January 2024
Line 51:		Line 51:
	\| Nam = pxpSiLoadPixetCore		\| Nam = pxpSiLoadPixetCore
	\| HeSym = ===		\| HeSym = ===
	\| Sum = Loads the pixet core library (pxcore.dll/so). When the measurement with a device is intented the user has to either load pixet core with this function, or if the core is already loaded in the application (pxcore.dll/so was loaded separatelly), the ~~setIPixet~~ function has to be called.		\| Sum = Loads the pixet core library (pxcore.dll/so). When the measurement with a device is intented the user has to either load pixet core with this function, or if the core is already loaded in the application (pxcore.dll/so was loaded separatelly), the '''pxpSiSetIPixet''' function has to be called.
	\| DefH = PXSIAPI int		\| DefH = PXSIAPI int
	\| DefP = const char* pxCoreLibPath		\| DefP = const char* pxCoreLibPath

HudecekP: /* Software */

2024-01-03T10:11:34Z

Software

← Older revision		Revision as of 12:11, 3 January 2024
Line 17:		Line 17:
	* Other '''auxilliary files''':		* Other '''auxilliary files''':
	** '''pixet.ini'''		** '''pixet.ini'''
	** '''device config''' file(s)		** '''device config''' file(s) (both measuring or processing) or '''ABCT calibration files set''' (offline processing only)
	** '''hwlibs''' and optional other device specific files (only for measuring)		** '''hwlibs''' and optional other device specific files (only for measuring)
	::; See		::; See

HudecekP: /* The Spectral imaging API basic workflow */

2024-01-03T10:07:38Z

The Spectral imaging API basic workflow

← Older revision		Revision as of 12:07, 3 January 2024
Line 41:		Line 41:
	<br>		<br>
	; Using BSTG files to save processing time:		; Using BSTG files to save processing time:
	: 1. After processing is complete (end of waiting steps above), use the pxpSiSaveToFile(handle, "file.bstg") method.		: 1. After processing is complete (end of waiting steps above), use the '''pxpSiSaveToFile'''(handle, "file.bstg") method.
	: 2. Anytime later use the pxpSiLoadFromFile(handle, "file.bstg").		: 2. Anytime later use the '''pxpSiLoadFromFile'''(handle, "file.bstg").
	: 3. Use the pxpSiGetMeasParams to evaluate measure settings or set it to your program variables or GUI		: 3. Use the '''pxpSiGetMeasParams''' to evaluate measure settings or set it to your program variables or GUI
	: 4. Continue using the data as it was processed. The program now is in the step 9 of the list above.		: 4. Continue using the data as it was processed. The program now is in the step 9 of the list above.

HudecekP: /* Software */

2024-01-03T10:04:12Z

Software

← Older revision		Revision as of 12:04, 3 January 2024
Line 18:		Line 18:
	** '''pixet.ini'''		** '''pixet.ini'''
	** '''device config''' file(s)		** '''device config''' file(s)
	** '''hwlibs''' and optional other device specific files		** '''hwlibs''' and optional other device specific files (only for measuring)
	::; See		::; See
	::: '''[[Pixet_SDK#Auxilliary_files\|Pixet SDK: Auxilliary files]]'''		::: '''[[Pixet_SDK#Auxilliary_files\|Pixet SDK: Auxilliary files]]'''

HudecekP: /* Software */

2024-01-03T10:01:45Z

Software

← Older revision		Revision as of 12:01, 3 January 2024
Line 15:		Line 15:
	: '''pxcore.lib''' (for linking only, Windows only, only if the '''pxcInitialize'''+'''pxcGetIPixet''' initializing way used)		: '''pxcore.lib''' (for linking only, Windows only, only if the '''pxcInitialize'''+'''pxcGetIPixet''' initializing way used)
	(on Linux equivalent SOs instead of DLLs)		(on Linux equivalent SOs instead of DLLs)
			* Other '''auxilliary files''':
			** '''pixet.ini'''
			** '''device config''' file(s)
			** '''hwlibs''' and optional other device specific files
			::; See
			::: '''[[Pixet_SDK#Auxilliary_files\|Pixet SDK: Auxilliary files]]'''
			::: '''[[Files and directories of the Pixet and SDK]]'''

	= The Spectral imaging API basic workflow =		= The Spectral imaging API basic workflow =