//================================================================================================= /*! @file PegasusFunctionDefs.h @ingroup Software group @author Jean-Francois Hammond @brief API */ //================================================================================================= /*================================================================================================= Copyright (C) 2011 ANRAD Corporation This software is the sole property of ANRAD Corporation and may not be copied or reproduced in any way without prior written permission from ANRAD Corporation. This software is intended for use in systems produced by ANRAD Corporation. This software or any other copies thereof may not be provided or otherwise made available to any other person without written permission from ANRAD Corporation. No title to and ownership of the software is hereby transferred. The information in this software is subject to change without notice and should not be construed as a commitment by ANRAD Corporation. =================================================================================================*/ #ifndef PegasusFunctionDefs_H #define PegasusFunctionDefs_H #pragma pack(push, enter_PegasusFunctionDefsh) // Save the current packing alignment // Set packing alignment to 8 or 16 bytes for all data structures in this file // This is done to prevent compatibility problems due to different compilers / options #ifdef _WIN64 #pragma pack(16) #else #ifdef _WIN32 #pragma pack(8) #else #error "_WIN32 is not define" #endif #endif // //==================================== [ INCLUDE FILES ] ========================================== // //==================================== [ DEFINES ] ================================================ // //==================================== [ EXTERNS ] ================================================ // //==================================== [ STATIC GLOBAL ] ========================================== // //==================================== [ PROTOTYPES ] ============================================= /* EVENT CALLBACK ROUTINE EXAMPLE */ /* <----------------------------------------------------------------------------- Function : onEventCallback Summary : This function receives all events. Description : NAME I/O DESCRIPTION event I Event type error I Error code pContext I Specific data according to the event type **** pContext is only available in the current callback if not NULL. **** Content of pContext changes with the event type. **** pContext will be freed on exit of the callback. Return Value: return error value See Also : >---------------------------------------------------------------------------- */ #if 0 void onEventCallback(PEGASUS_EventType event, PEGASUS_ErrorCode error, void *pContext) { } #endif /* BASIC INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_RegisterProgressionCallback Summary : This function registers to receive progression callback. Event : PEGASUS_ProgressionEventCallback Description : NAME I/O DESCRIPTION pProgressionCallBack I Progression callback. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_RegisterProgressionCallback( PEGASUS_ProgressionEventCallback *pProgressionCallBack ); /* <----------------------------------------------------------------------------- Function : PEGASUS_Initialize Summary : This function initializes detector and make it ready to acquire. If an error happen, utility and debug interface must continue to work. **** Initialize & Reset = Initialize Event : PEGASUS_INITIALIZATION_EVENT Description : NAME I/O DESCRIPTION pRegistrationCallBack I Registration callback. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_Initialize( PEGASUS_EventRegistrationCallback *pRegistrationCallBack ); /* <----------------------------------------------------------------------------- Function : PEGASUS_QuickInitialize Summary : This function initializes detector and make it ready to acquire. If an error happen, utility and debug interface must continue to work. **** Initialize & Reset = Initialize Event : PEGASUS_INITIALIZATION_EVENT Description : NAME I/O DESCRIPTION pRegistrationCallBack I Registration callback. targetContext I Context to load isSkipEoConfig I Skip EO configuration if needed. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_QuickInitialize( PEGASUS_EventRegistrationCallback *pRegistrationCallBack, PEGASUS_Context targetContext, bool isSkipEoConfig ); /* <----------------------------------------------------------------------------- Function : PEGASUS_Shutdown Summary : This function shutdown the dectector. **** It cancels the registration callback also. Event : PEGASUS_SHUTDOWN_EVENT Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_Shutdown(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_LoadContext Summary : This function changes the context on the detector. **** ChangeContext & LoadContext = LoadContext Event : PEGASUS_CONTEXT_CHANGE_EVENT Event context contains the current context. Description : NAME I/O DESCRIPTION context I Change to this context Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() PEGASUS_ErrorCode PEGASUS_LoadContext(PEGASUS_Context context); /* INFORMATION INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_DetailedInformation Summary : This function gets detailed informations. Description : NAME I/O DESCRIPTION pDetailedInfo O Detailed informations Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_SystemDetailedInformation") PEGASUS_ErrorCode PEGASUS_DetailedInformation(PEGASUS_DetailedInfo *pDetailedInfo); /* <----------------------------------------------------------------------------- Function : PEGASUS_SystemDetailedInformation Summary : This function gets detailed informations about the system. Description : NAME I/O DESCRIPTION pDetailedInfo O Detailed informations Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_SystemDetailedInformation(PEGASUS_SystemDetailedInfo *pSystemDetailedInfo); /* <----------------------------------------------------------------------------- Function : PEGASUS_DetectorStatistics Summary : This function gets detector statistics for detector with boardtype <= PEGASUS_Type3. Description : NAME I/O DESCRIPTION pDetectorStats O Detector statistics Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_DetectorStatistics(PEGASUS_DetectorStats *pDetectorStats); /* <----------------------------------------------------------------------------- Function : PEGASUS_DetectorStatisticsLMAM3 Summary : his function gets detector statistics for detector with boardtype >= PEGASUS_Type4. Description : NAME I/O DESCRIPTION pDetectorStats O Detector statistics Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_DetectorStatisticsLMAM3(PEGASUS_DetectorStatsLMAM3 *pDetectorStats); /* <----------------------------------------------------------------------------- Function : PEGASUS_Information Summary : This function gets informations. Description : NAME I/O DESCRIPTION pInfo O Informations Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_Information(PEGASUS_Info *pInfo); /* <----------------------------------------------------------------------------- Function : PEGASUS_CalibrationInformation Summary : This function gets the calibration informations. Note : This command only work in state PEGASUS_CONTINUOUS_ACQUISITION_STATE. Description : NAME I/O DESCRIPTION pCalibrationInfo O Calibration informations. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_GetCalibrationInformationUsingType") PEGASUS_ErrorCode PEGASUS_CalibrationInformation(PEGASUS_CalibrationInfo *pCalibrationInfo); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetCalibrationInformation Summary : This function gets the calibration informations by type. Note : This command only work in state PEGASUS_CONTINUOUS_ACQUISITION_STATE. This function call PEGASUS_GetCalibrationInformationUsingType() Description : NAME I/O DESCRIPTION pCalibrationType I Calibration type. index I Calibration index (Ex. SHADING [0-5]) pCalibrationStats O Calibration stats. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_GetCalibrationInformationUsingType") PEGASUS_ErrorCode PEGASUS_GetCalibrationInformation(const char *pCalibrationType, int index, PEGASUS_CalibrationStats *pCalibrationStats); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetCalibrationInformationUsingType Summary : This function gets the calibration informations by type. Note : This command only work in state PEGASUS_CONTINUOUS_ACQUISITION_STATE. Description : NAME I/O DESCRIPTION calibrationType I Calibration type. index I Calibration index (Ex. SHADING [0-5]) pCalibrationStats O Calibration stats. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetCalibrationInformationUsingType( PEGASUS_CalibrationType calibrationType, int index, PEGASUS_CalibrationStats *pCalibrationStats ); /* <----------------------------------------------------------------------------- Function : PEGASUS_RecorderInformation Summary : This function save informations about the last acquistion. Note : This function save the following files in "C:\Pegasus\recorder": log files, calibration files, calfiles, eo files, images files. This function generates a report "C:\Pegasus\recorder\RecorderInformation_Report" with all the files path saved, and with detectors statistics informations. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_RecorderInformation(); /* ACQUIRE INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_IsReadyForExposure Summary : This function is used to verify if software if ready for exposure. Event : None. Return Value: true if software is ready for exposure, if not ready it returns false. See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("handling events from PEGASUS_StartContinuousAcquisitionEx, PEGASUS_StartSingleAcquisition and PEGASUS_RecoverImageEx") bool PEGASUS_IsReadyForExposure(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_IsDefectMapInDetectorAccessible Summary : This function is used to verify if defect map in detector is accessible. Event : None. Return Value: true if defect map in detector is accessible, if not accessible it returns false. See Also : >---------------------------------------------------------------------------- */ PEGASUS_API bool PEGASUS_IsDefectMapInDetectorAccessible(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_Acquire Summary : This function starts the exposure sequence in screening mode. Note : Callback for each buffer will happened even if an abort has been detected. Error code PEGASUS_WARNING_IMAGE_ABORTED will be used to notify HWS for each buffer that has been abort. Event : PEGASUS_AEC_DATA_EVENT PEGASUS_CORRECTED_IMAGE_EVENT PEGASUS_ACQUIRE_DONE_EVENT Description : NAME I/O DESCRIPTION targetFilter I Target filter in use. pAecData O Pointer to receive AEC data information after event received. pResultImage O Pointer to receive result image. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() PEGASUS_ErrorCode PEGASUS_Acquire( PEGASUS_TargetFilter targetFilter, PEGASUS_Image *pAecData, PEGASUS_Image *pResultImage ); /* <----------------------------------------------------------------------------- Function : PEGASUS_AbortAcquire Summary : This function aborts the acquisition process. Event : PEGASUS_ACQUIRE_ABORT_EVENT Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() PEGASUS_ErrorCode PEGASUS_AbortAcquire(void); /* CONTINUOUS ACQUISITION INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_StartContinuousAcquisition Summary : This function enters in continuous acquisition. Note : After this command is called, following commands are invalid: - PEGASUS_LoadContext - PEGASUS_Acquire - PEGASUS_SelfTest Event : PEGASUS_MULTI_READY_FOR_EXPOSURE_EVENT PEGASUS_MULTI_SEQUENCE_STARTED_EVENT PEGASUS_MULTI_AEC_DATA_EVENT PEGASUS_MULTI_CORRECTED_IMAGE_EVENT PEGASUS_MULTI_RAW_IMAGE_EVENT PEGASUS_MULTI_SEQUENCE_DONE_EVENT PEGASUS_MULTI_SEQUENCE_NOT_READY_EVENT Description : NAME I/O DESCRIPTION targetFilter I Target filter to use. isAecMode I Specify if AEC mode that will be used. context I Specify if context that will be used. pMultiEventRegistrationCallback I Registration callback for continuous acquisition. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_StartContinuousAcquisitionEx") PEGASUS_ErrorCode PEGASUS_StartContinuousAcquisition( PEGASUS_TargetFilter targetFilter, bool isAecMode, PEGASUS_Context context, PEGASUS_MultiEventRegistrationCallback *pMultiEventRegistrationCallback ); /* <----------------------------------------------------------------------------- Function : PEGASUS_StartContinuousAcquisitionEx Summary : This function enters in continuous acquisition. Note : For CONTACT, MAG, STEREO: targetFilterArrayLength = 1 only Event : PEGASUS_MULTI_READY_FOR_EXPOSURE_EVENT PEGASUS_MULTI_SEQUENCE_STARTED_EVENT PEGASUS_MULTI_AEC_DATA_EVENT PEGASUS_MULTI_CORRECTED_IMAGE_EVENT PEGASUS_MULTI_RAW_IMAGE_EVENT PEGASUS_MULTI_SEQUENCE_DONE_EVENT PEGASUS_MULTI_SEQUENCE_NOT_READY_EVENT Description : NAME I/O DESCRIPTION pAcquisitionProperties I Pointer to receive acquisition properties. pMultiEventRegistrationCallback I Registration callback for continuous acquisition. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_StartContinuousAcquisitionEx( PEGASUS_AcquisitionProperties *pAcquisitionProperties, PEGASUS_MultiEventRegistrationCallback *pMultiEventRegistrationCallback ); /* <----------------------------------------------------------------------------- Function : PEGASUS_ChangeContinuousAcquisitionProperties Summary : This function changes continuous acquisition properties for next sequence. Description : NAME I/O DESCRIPTION targetFilter I Target filter to use. isAecMode I Specify if AEC mode to use. context I Specify if contex to use. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_ChangeContinuousAcquisitionPropertiesEx") PEGASUS_ErrorCode PEGASUS_ChangeContinuousAcquisitionProperties( PEGASUS_TargetFilter targetFilter, bool isAecMode, PEGASUS_Context context ); /* <----------------------------------------------------------------------------- Function : PEGASUS_ChangeContinuousAcquisitionPropertiesEx Summary : This function changes continuous acquisition properties for next sequence. Note : For CONTACT, MAG, STEREO: targetFilterArrayLength = 1 only Description : NAME I/O DESCRIPTION pAcquisitionProperties I Pointer to receive acquisition properties. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_ChangeContinuousAcquisitionPropertiesEx( PEGASUS_AcquisitionProperties *pAcquisitionProperties ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetContinuousAcquisitionProperties Summary : This function gets continuous acquisition properties. Description : NAME I/O DESCRIPTION pTargetFilter O Pointer to receive current target filter in use. pIsAecMode O Pointer to receive current AEC mode in use. pCurrentContext O Pointer to receive current contexT in use. pCurrentSequenceId O Pointer to receive current sequence Id in use. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_GetContinuousAcquisitionPropertiesEx") PEGASUS_ErrorCode PEGASUS_GetContinuousAcquisitionProperties( PEGASUS_TargetFilter *pTargetFilter, bool *pIsAecMode, PEGASUS_Context *pCurrentContext, int *pCurrentSequenceId ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetContinuousAcquisitionPropertiesEx Summary : This function gets continuous acquisition properties. Note : If target filter array size is not sufficient, then an error will be retured. If pTargetFilterArray is NULL, then targetFilterArrayLength will contain the last array size that has been set. For CONTACT, MAG, STEREO: targetFilterArrayLength = 1 only Description : NAME I/O DESCRIPTION pAcquisitionProperties O Pointer to get acquisition properties. pCurrentSequenceId O Pointer to get current sequence Id in use. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetContinuousAcquisitionPropertiesEx( PEGASUS_AcquisitionProperties *pAcquisitionProperties, int *pCurrentSequenceId ); /* <----------------------------------------------------------------------------- Function : PEGASUS_OverrideTargetFilter Summary : This function overrides the target filter to use for corrected image. This function can only be used between PEGASUS_MULTI_AEC_DATA_EVENT and PEGASUS_MULTI_CORRECTED_IMAGE_EVENT. Description : NAME I/O DESCRIPTION sequenceId I Sequence Id receive from callback. targetFilter I Specify the Target filter to use. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_OverrideTargetFilter( int sequenceId, PEGASUS_TargetFilter targetFilter ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetAecImage Summary : This function gets AEC image. Description : NAME I/O DESCRIPTION sequenceId I Sequence Id receive from callback. pAecImage O Pointer to receive AEC image. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetAecImage( int sequenceId, PEGASUS_Image *pAecImage ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetCorrectedImage Summary : This function gets the corrected image. Description : NAME I/O DESCRIPTION sequenceId I Sequence Id received from callback. imageIndex I Image index received from callback. pCorrectedImage O Pointer to receive corrected image. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetCorrectedImage( int sequenceId, int imageIndex, PEGASUS_Image *pCorrectedImage ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetCorrectedImageEx Summary : This function gets the corrected image. Description : NAME I/O DESCRIPTION sequenceId I Sequence Id received from callback. imageIndex I Image index received from callback. pCorrectedImage O Pointer to receive corrected image. pIntegrationPeriod O Pointer to receive integration period in ms, -1 is unavailable pIsXRayFrame O Pointer to receive is the frame is exposed or not. 1 if exposed frame, 0 if dark frame, -1 if unavailable. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetCorrectedImageEx( int sequenceId, int imageIndex, PEGASUS_Image *pCorrectedImage, int *pIntegrationPeriod, int *pIsXRayFrame ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetRawImage Summary : This function gets the raw image. Description : NAME I/O DESCRIPTION sequenceId I Sequence Id received from callback. imageIndex I Image index received from callback. pRawImage O Pointer to receive raw image. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetRawImage( int sequenceId, int imageIndex, PEGASUS_Image *pRawImage, int *pIntegrationPeriod, int *pIsXRayFrame ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetInformationOfFirstAvailableImage Summary : This function is used to know the first available image to get. If there is no image available, then the command will be rejected. This command is available in error state. Description : NAME I/O DESCRIPTION pImageInformation O Pointer to receive image information. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetInformationOfFirstAvailableImage( PEGASUS_ImageInformation *pImageInformation ); /* <----------------------------------------------------------------------------- Function : PEGASUS_StartSingleAcquisition Summary : This function enters in single acquisition mode. Note : For CONTACT, MAG, STEREO: targetFilterArrayLength = 1 only Event : PEGASUS_MULTI_READY_FOR_PREPARE_FOR_EXPOSURE_EVENT PEGASUS_MULTI_READY_FOR_EXPOSURE_EVENT PEGASUS_MULTI_SEQUENCE_STARTED_EVENT PEGASUS_MULTI_AEC_DATA_EVENT PEGASUS_MULTI_CORRECTED_IMAGE_EVENT PEGASUS_MULTI_RAW_IMAGE_EVENT PEGASUS_MULTI_SEQUENCE_DONE_EVENT PEGASUS_MULTI_SEQUENCE_NOT_READY_EVENT Description : NAME I/O DESCRIPTION pAcquisitionProperties I Pointer to receive acquisition properties. pMultiEventRegistrationCallback I Registration callback for continuous acquisition. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_StartSingleAcquisition( PEGASUS_AcquisitionProperties *pAcquisitionProperties, PEGASUS_MultiEventRegistrationCallback *pMultiEventRegistrationCallback ); /* <----------------------------------------------------------------------------- Function : PEGASUS_PrepareForExposure Summary : This function prepares the acquisition. Note : If there are images to be retrieved from previous sequence, then Pegasus will return the error PEGASUS_MAJOR_IMAGES_ARE_PENDING_IN_MEMORY. For a good use of the timeout, the timeout should not be less than the time it takes to complete the acquisition sequence. If the timeout is reached, the error PEGASUS_MAJOR_TIMEOUT_WAITING_FOR_EXPOSURE will be thrown. Event : PEGASUS_MULTI_READY_FOR_EXPOSURE_EVENT Description : NAME I/O DESCRIPTION timeout I The timeout is the time in seconds that the host workstation is expecting the acquisition sequence to start on the detector. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_PrepareForExposure( int timeout ); /* <----------------------------------------------------------------------------- Function : PEGASUS_TriggerAcquisition Summary : This function triggers the acquisition for a K7 detector. Description : NAME I/O DESCRIPTION exposeWindowWidth I Reserved for future. Should be zero. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_TriggerAcquisition( int exposeWindowWidth ); /* <----------------------------------------------------------------------------- Function : PEGASUS_CancelAcquisition Summary : This function cancel the acquisition for a cassette detector. Description : NAME I/O DESCRIPTION Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_CancelAcquisition(); /* <----------------------------------------------------------------------------- Function : PEGASUS_TerminateAcquisition Summary : This function terminate the current integration and goes directly to the read. Description : NAME I/O DESCRIPTION Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_TerminateAcquisition(); /* RECOVERY INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_RecoverImage Summary : This function tries to recover an image. Event : PEGASUS_MULTI_SEQUENCE_STARTED_EVENT PEGASUS_MULTI_CORRECTED_IMAGE_EVENT PEGASUS_MULTI_SEQUENCE_DONE_EVENT Description : NAME I/O DESCRIPTION sequenceId I Specify the sequence ID to recover. targetFilter I Specify the Target filter to use. context I Specify the context to use. pMultiEventRegistrationCallback I Registration callback for continuous acquisition. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_RecoverImageEx") PEGASUS_ErrorCode PEGASUS_RecoverImage( int sequenceId, PEGASUS_TargetFilter targetFilter, PEGASUS_Context context, PEGASUS_MultiEventRegistrationCallback *pMultiEventRegistrationCallback ); /* <----------------------------------------------------------------------------- Function : PEGASUS_RecoverImageEx Summary : This function tries to recover an image. Note : For CONTACT, MAG, STEREO: targetFilterArrayLength = 1 only Event : PEGASUS_MULTI_SEQUENCE_STARTED_EVENT PEGASUS_MULTI_CORRECTED_IMAGE_EVENT PEGASUS_MULTI_SEQUENCE_DONE_EVENT Description : NAME I/O DESCRIPTION sequenceId I Specify the sequence ID to recover. pAcquisitionProperties I Pointer to receive acquisition properties. pMultiEventRegistrationCallback I Registration callback for continuous acquisition. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_RecoverImageEx( int sequenceId, PEGASUS_AcquisitionProperties *pAcquisitionProperties, PEGASUS_MultiEventRegistrationCallback *pMultiEventRegistrationCallback ); /* <----------------------------------------------------------------------------- Function : PEGASUS_CancelImageRecovery Summary : This function cancels image recovery if not needed. Description : NAME I/O DESCRIPTION sequenceId I Specify the sequence ID to recover. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_CancelImageRecovery(int sequenceId); /* <----------------------------------------------------------------------------- Function : PEGASUS_RecoverLastSequenceID Summary : This function gets last sequence ID. Description : NAME I/O DESCRIPTION pSequenceId I Pointer to receive the last sequence Id. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_RecoverLastSequenceID(int *pSequenceId); /* CALIBRATION INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_Calibrate Summary : This function call PEGASUS_CalibrateEx(0). It is kept for backward compatibility. Description : NAME I/O DESCRIPTION deprecated O Must be NULL. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_CalibrateUsingType") PEGASUS_ErrorCode PEGASUS_Calibrate(PEGASUS_Image *deprecated); /* <----------------------------------------------------------------------------- Function : PEGASUS_CalibrateEx Summary : This function calibrates the system and specify the number of sequence. Event : PEGASUS_CALIBRATION_ACQUIRE_READY_EVENT PEGASUS_CALIBRATION_DONE_EVENT Event context pointer contains the request for next exposure param. This function call PEGASUS_CalibrateUsingType(PEGASUS_CALIBRATION_TYPE_SHADING, numberOfSequences) Description : NAME I/O DESCRIPTION numberOfSequences I Specify the number of sequence. Return Value: PEGASUS_ErrorCode Note : PEGASUS_CalibrateEx( n ): - n=0 => Only one exposure sequence will be done or use exposure file if present. - n>0 => n exposure sequence will be done and ignore exposure file. See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_CalibrateUsingType") PEGASUS_ErrorCode PEGASUS_CalibrateEx(int numberOfSequences); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetNbrCalImagesLeft Summary : This function returns the number of image left to get before waiting for PEGASUS_CALIBRATION_DONE_EVENT. Description : NAME I/O DESCRIPTION pNbrCalImagesLeft O Pointer to receive the number of image left to acquire. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetNbrCalImagesLeft(int *pNbrCalImagesLeft); /* <----------------------------------------------------------------------------- Function : PEGASUS_AbortCalibration Summary : This function aborts the calibration process. Event : PEGASUS_CALIBRATION_ABORT_EVENT Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_AbortCalibration(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_AddImageToCalibration Summary : This function adds the specified image to the current calibration. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_AddImageToCalibration(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_RejectCalibrationImage Summary : This function rejects the specified image from the calibration. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_RejectCalibrationImage(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_AutoCalibrate Summary : This function starts the specified type of self calibration. Note : If an abort is requested, PEGASUS_CALIBRATION_DONE_EVENT error code will be PEGASUS_WARNING_CALIBRATION_ABORTED. This function call PEGASUS_CalibrateUsingType(..., 0) Event : PEGASUS_CALIBRATION_DONE_EVENT Description : NAME I/O DESCRIPTION calibrationType I Specified type of self calibration. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_CalibrateUsingType") PEGASUS_ErrorCode PEGASUS_AutoCalibrate(char calibrationType[PEGASUS_MAX_STRING_LENGTH]); /* <----------------------------------------------------------------------------- Function : PEGASUS_CalibrateUsingType Summary : This function starts the specified type of calibration. Note : If an abort is requested, PEGASUS_CALIBRATION_DONE_EVENT error code will be PEGASUS_WARNING_CALIBRATION_ABORTED. Exception for EO and GAIN. Event : PEGASUS_CALIBRATION_DONE_EVENT Description : NAME I/O DESCRIPTION calibrationType I Specified type of calibration. numberOfSequences I Specify the number of sequence. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_CalibrateUsingType( PEGASUS_CalibrationType calibrationType, int numberOfSequences ); /* <----------------------------------------------------------------------------- Function : PEGASUS_SetXrayStatus Summary : This function specified if the xray are on or off to Pegasus. Note : If the xray are on (isXrayOn = true), the offset tracking are not handled. Description : NAME I/O DESCRIPTION isXrayOn I Specified if the xray are on or off. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_SetXrayStatus(bool isXrayOn); /* UTILITY INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_StopComServer Summary : This function stops COM server. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_Exit") PEGASUS_ErrorCode PEGASUS_StopComServer(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetLogLevel Summary : This function gets the log level. Description : NAME I/O DESCRIPTION pLogLevel O Pointer to return log level Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() PEGASUS_ErrorCode PEGASUS_GetLogLevel(PEGASUS_LogLevel *pLogLevel); /* <----------------------------------------------------------------------------- Function : PEGASUS_SetLogLevel Summary : This function sets the log level. Description : NAME I/O DESCRIPTION logLevel I Log level to set Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() PEGASUS_ErrorCode PEGASUS_SetLogLevel(PEGASUS_LogLevel logLevel); /* <----------------------------------------------------------------------------- Function : PEGASUS_SelfTest Summary : This function executes self test. Event : PEGASUS_SELF_TEST_EVENT Event context contains the self test type. Description : NAME I/O DESCRIPTION selftTestType I Selft test to execute Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_SelfTest(PEGASUS_SelfTestType selftTestType); /* <----------------------------------------------------------------------------- Function : PEGASUS_Sleep Summary : This function sleeps without blocking Windows messages. Description : NAME I/O DESCRIPTION timeoutMsec I Timeout in msec See Also : WaitForMultipleObjectsEx >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() void PEGASUS_Sleep(int timeoutMsec); /* SERVICE INTERFACE */ /* <----------------------------------------------------------------------------- Function : PEGASUS_ServiceImageInformation Summary : This function gets service image informations. Description : NAME I/O DESCRIPTION imageType I Image type to get. pImageCount O Pointer to receive image count associated with the actual image type. pInfo O One image informations. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_ServiceImageInformation( PEGASUS_ServiceImageType imageType, int *pImageCount, PEGASUS_ServiceImageInfo *pInfo ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetServiceImage Summary : This function gets the service image. Note : If imageType == PEGASUS_SERVICE_IMAGE_DEFECT_MAP_WITH_DEFECTS_ORIGIN, the service image returns give information about every defect origin. Refer to PEGASUS_DefectMapValue structure for the defect origin. If from factory: pixel value equal to DEFECT_MAP_DEAD_VALUE_FACTORY, If from gain calibration: pixel value equal to DEFECT_MAP_DEAD_VALUE_EG, If from defect calibration: pixel value equal to DEFECT_MAP_DEAD_VALUE_DC, If from shading calibration: pixel value equal to DEFECT_MAP_DEAD_VALUE_SG, If from API: pixel value equal to DEFECT_MAP_DEAD_VALUE_AP If a defect pixel is from 2 origins or more, a bitwise OR is performed. For example, if a defect pixel is from EG and AP, the pixel value will be DEFECT_MAP_DEAD_VALUE_EG OR DEFECT_MAP_DEAD_VALUE_AP = 18. Description : NAME I/O DESCRIPTION imageType I Image type to get. imageIndex I Image index to get. context I Context to use. pServiceImage O Pointer to receive service image. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetServiceImage( PEGASUS_ServiceImageType imageType, int imageIndex, PEGASUS_Context context, PEGASUS_Image *pServiceImage ); /* <----------------------------------------------------------------------------- Function : PEGASUS_UpdateDefectMap Summary : This function updates the defect map. Note : Only available in service mode. If isAddDefect == true then add a defect otherwise remove a defect. If a defect is applied for a whole column then the row value will be ignored. If a defect is applied for a whole row then the column value will be ignored. Description : NAME I/O DESCRIPTION defectType I Specify defect type. context I Specify context to use. isAddDefect I Specify to add or remove a defect. column I Specify column. row I Specify row. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_BY("PEGASUS_UpdateDefectMapEx") PEGASUS_ErrorCode PEGASUS_UpdateDefectMap( PEGASUS_DefectType defectType, bool isAddDefect, int column, int row, PEGASUS_Context context ); /* <----------------------------------------------------------------------------- Function : PEGASUS_UpdateDefectMapEx Summary : This function updates the defect map. Note : Only available in service mode. If isAddDefect == true then add a defect otherwise remove a list of defect. If a defect is applied for a whole column then the row value will be ignored. If a defect is applied for a whole row then the column value will be ignored. Description : NAME I/O DESCRIPTION context I Specify context to use. isAddDefect I Specify to add or remove a defect. defectPixelCount I Specify the number of PEGASUS_GenericDefect. defectPixelarray I Reference to all PEGASUS_GenericDefect with the maximum defectPixelCount Return Value: PEGASUS_ErrorCode Example : std::vector v_defectPixel; PEGASUS_GenericDefect defectRow; defectRow.defectType = PEGASUS_DEFECT_ROW; defectRow.column = 0; defectRow.row = 501; PEGASUS_GenericDefect defectColumn; defectColumn.defectType = PEGASUS_DEFECT_COLUMN; defectColumn.column = 500; defectColumn.row = 0; PEGASUS_GenericDefect defectPixel; defectPixel.defectType = PEGASUS_DEFECT_PIXEL; defectPixel.column = 500; defectPixel.row = 501; v_defectPixel.push_back(defectRow); v_defectPixel.push_back(defectColumn); v_defectPixel.push_back(defectPixel); PEGASUS_ErrorCode err = PEGASUS_UpdateDefectMapEx(true, (int)v_defectPixel.size(), &v_defectPixel[0], PEGASUS_CONTEXT_CONTACT); See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_UpdateDefectMapEx( bool isAddDefect, int defectPixelCount, PEGASUS_GenericDefect* defectPixelarray, PEGASUS_Context context ); /* <----------------------------------------------------------------------------- Function : PEGASUS_RevertDefectMap Summary : This function is used to revert current defect map by removing defect from different calibration. Note : Only available in PEGASUS_SERVICE_STATE and PEGASUS_CALIBRATION_ADD_REJECT_STATE. Description : NAME I/O DESCRIPTION isRemoveEG I Specify to remove defects from gain calibration. isRemoveDC I Specify to remove defects from defect calibration. isRemoveAP I Specify to remove defects added by PEGASUS_UpdateDefectMap API call. context I Specify context to use. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_RevertDefectMap( bool isRemoveEG, bool isRemoveDC, bool isRemoveAP, PEGASUS_Context context); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetWeakDefect Summary : Get all weak line/column defect. Note : PEGASUS_GetWeakDefect(context, &InOutItemCount, NULL) = return the number of PEGASUS_WeakDefect to allocate PEGASUS_GetWeakDefect(context, &InOutItemCount, pWeakDefect) = return all the PEGASUS_WeakDefect with the maximum InOutItemCount Description : NAME I/O DESCRIPTION context I Specify context to use. pInOutItemCount I/O Specify or return the number of PEGASUS_WeakDefect. pOutWeakDefectArray O Return all the PEGASUS_WeakDefect with the maximum pInOutItemCount. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetWeakDefect( PEGASUS_Context context, unsigned int *pInOutItemCount, PEGASUS_WeakDefect *pOutWeakDefectArray ); /* <----------------------------------------------------------------------------- Function : PEGASUS_UpdateWeakDefect Summary : Add or remove a weak line/column using PEGASUS_WeakDefect. Description : NAME I/O DESCRIPTION context I Specify context to use. isAddDefect I Specify to add or remove a defect. pWeakDefect I Reference to PEGASUS_WeakDefect Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_UpdateWeakDefect( PEGASUS_Context context, bool isAddWeakDefect, PEGASUS_WeakDefect *pWeakDefect ); /* <----------------------------------------------------------------------------- Function : PEGASUS_UpdateAEDLine Summary : This function updates the aed lines gate (acceptable values : from 0 to 255) Note : Only available for a cassette detector Description : NAME I/O DESCRIPTION currentAedLine I Aed Line to replace newAedLine I New Aed Line. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_UpdateAEDLine( int currentAedLine, int newAedLine ); /* Debug interface */ /* <----------------------------------------------------------------------------- Function : PEGASUS_GetErrorDescription Summary : This function describes error code. It is used to get more Information about the current error. Description : NAME I/O DESCRIPTION errorCode I Error code to describe shortDescription O Short description longDescription O Long description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetErrorDescription( PEGASUS_ErrorCode errorCode, char shortDescription[PEGASUS_MAX_STRING_LENGTH], char longDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetEventDescription Summary : This function describes event code. Description : NAME I/O DESCRIPTION eventCode I Event code to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetEventDescription( PEGASUS_EventType eventCode, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetMultiEventDescription Summary : This function describes event code. Description : NAME I/O DESCRIPTION eventCode I Multi event code to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetMultiEventDescription( PEGASUS_MultiEventType eventCode, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetDebugDump Summary : This function dumps debug images. Return Value: PEGASUS_ErrorCode See Also : >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() PEGASUS_ErrorCode PEGASUS_GetDebugDump(void); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetProductTypeDescription Summary : This function describes product type. Description : NAME I/O DESCRIPTION product Type I Detector product to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetProductTypeDescription( PEGASUS_ProductType productType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetDetectorTypeDescription Summary : This function describes detector type. Description : NAME I/O DESCRIPTION detectorType I Detector type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetDetectorTypeDescription( PEGASUS_DetectorType detectorType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetFirmwareDetectorTypeDescription Summary : This function describes detector type at the firmware point of view. Description : NAME I/O DESCRIPTION detectorType I Detector type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetFirmwareDetectorTypeDescription( PEGASUS_FirmwareDetectorType FirmwaredetectorType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetContextCodeDescription Summary : This function describes context code. Description : NAME I/O DESCRIPTION contextCode I Context code to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetContextCodeDescription( PEGASUS_Context contextCode, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetDetectorStateDescription Summary : This function describes detector state. Description : NAME I/O DESCRIPTION detectorState I Detector state to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetDetectorStateDescription( PEGASUS_DetectorState detectorState, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetPegasusStateDescription Summary : This function describes Pegasus state. Description : NAME I/O DESCRIPTION pegasusState I Pegasus state to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetPegasusStateDescription( PEGASUS_State pegasusState, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetLogLevelCodeDescription Summary : This function describes log level code. Description : NAME I/O DESCRIPTION logLevelCode I Log level code to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_DEPRECATED_THIS() void PEGASUS_GetLogLevelCodeDescription( PEGASUS_LogLevel logLevelCode, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetSelfTestTypeDescription Summary : This function describes self test type. Description : NAME I/O DESCRIPTION selfTestType I Self test type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetSelfTestTypeDescription( PEGASUS_SelfTestType selfTestType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetTargetFilterTypeDescription Summary : This function describes target filter type. Description : NAME I/O DESCRIPTION targetFilterType I Target filter type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetTargetFilterTypeDescription( PEGASUS_TargetFilter targetFilterType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetFocusTypeDescription Summary : This function describes focus type. Description : NAME I/O DESCRIPTION focusType I Focus type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetFocusTypeDescription( PEGASUS_FocusType focusType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetServiceImageTypeDescription Summary : This function describes service image type. Description : NAME I/O DESCRIPTION serviceImageType I Service image type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetServiceImageTypeDescription( PEGASUS_ServiceImageType serviceImageType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetPixelFormatDescription Summary : This function describes pixel format. Description : NAME I/O DESCRIPTION pixelFormat I Pixel format to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetPixelFormatDescription( PEGASUS_PixelFormat pixelFormat, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetDefectTypeDescription Summary : This function describes defect type. Description : NAME I/O DESCRIPTION defectType I Defect type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetDefectTypeDescription( PEGASUS_DefectType defectType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetCalibrationTypeDescription Summary : This function describes calibration type. Description : NAME I/O DESCRIPTION calibrationType I Calibration type to describe shortDescription O Short description >---------------------------------------------------------------------------- */ PEGASUS_API void PEGASUS_GetCalibrationTypeDescription( PEGASUS_CalibrationType calibrationType, char shortDescription[PEGASUS_MAX_STRING_LENGTH] ); /* <----------------------------------------------------------------------------- Function : PEGASUS_GetShadingTable Summary : This function return the shading table image of the current context associated with the specified PEGASUS_TargetFilter. Description : NAME I/O DESCRIPTION targetFilterType I Target filter type to describe pShadingTable O Pointer to receive Shading table image. >---------------------------------------------------------------------------- */ PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetShadingTable( PEGASUS_TargetFilter targetFilterType, PEGASUS_Image *pShadingTable ); PEGASUS_API PEGASUS_ErrorCode PEGASUS_GetAvailableContext(int *pArrayLen, PEGASUS_Context *pContextArray); PEGASUS_API PEGASUS_ErrorCode PEGASUS_Entry(); // Start PegasusAXS PEGASUS_API PEGASUS_ErrorCode PEGASUS_Exit(); // Close communication and kill PegasusAXS // Return to original packing alignment #pragma pack(pop, enter_PegasusFunctionDefsh) #endif /* PegasusFunctionDefs_H */