orchid.h

相机传输图像程序源代码 拜耳模式（RAW格式文件）与RGB图像数据互相转换函数库

* a generic "GigE" or "USB" or directly the name of the camera.\n
* \n
* The best way how to find out the correct grabber name is to use the
* PicPort Demo, which lists all the grabbers found in the system, or use the
* enumeration functions (see lvx_QueryGrabberName() ).\n
* \n
* The name is not case sensitive.\n
* \n
* In case of multiple grabbers of the same name you should use the lvx_SetGrabberOrder()
* to specify the order of the grabber. Note that the grabber order can be also
* attached to the end of the grabber name in square brackets, for example
* "PicPortX Mono [2]". The grabber order does not apply to generic "GigE" and "USB"
* names, where the multiple cameras are distinguished by their nick names, not by
* the order. \n
* \n
* Important: In case you have multiple grabbers in the PC or multiple cameras
* cameras connected to the PC, you should use a seaparate module for each camera and
* assure that 2 modules will not access the same camera. In case you have a
* frame grabber which enables to connect multiple cameras (PicPort Express Stereo,
* PicPort Elite etc.), all the modules accessing the cameras must be in single
* process (application). That means you cannot use for example one application
* for accessing the first camera on PicPortX Stereo and another application for
* accessing the second camera on the same physical grabber, but you can have
*  2 modules opened in single application, each accessing one of the 2 cameras.\n
* \n
* In the LvxLive module the lvx_DisplayConnectionDialog() can be used
* for setting the Grabber-Connector-Camera properties at once by the user,
* using a pop-up dialog box.\n
* In the real-time modules the lvx_DisplayInitialSettingsDialog() method can be
* used for setting this property, together with other parameters.\n
* \n
* @note Changing the grabber name deactivates currently active
*       acquisition and returns the module to the uninitialized status.
* @sa lvx_QueryGrabberName() method, through which you can obtain a list of
*     grabbers available in the computer.
*
* @ingroup OrchidFunctionsInitializing
* @param hLvxTask   Handle to Orchid module, created by lvx_OpenTask().
* @param pszName    Name in form of a null-terminated string.
* @param iMaxLen    Size of the buffer.
*
* 
* @par See also .NET version:
*      LeutronVision::Orchid::LvxBaseAcquisition::Grabber
*/

DLLENTRY void WINAPI lvx_GetGrabber(HLVXTASK hLvxTask, char* pszName, int iMaxLen);

/* -------------------------------------------------------------------------- */

/* ---obsolete--- */
DLLENTRY void WINAPI lvx_SetGrabberNumber(HLVXTASK hLvxTask, int iNumber); /*obsolete - use GrabberOrder*/
/* ---obsolete--- */
DLLENTRY int  WINAPI lvx_GetGrabberNumber(HLVXTASK hLvxTask);

/* -------------------------------------------------------------------------- */

/** Sets the order number of the grabber.
* This value is useful in case multiple grabbers of the same type are installed
* in the computer - it indicates the order number of the grabber. If
* GrabberOrder is set to 0, then the first found grabber of the specified name
* is used. Otherwise the GrabberOrder specifies the order number (numbered from 1)
* of the grabber of the specified name in the PC.\n
* The GrabberOrder can be either specified by this function, or can be put
* directly as part of the grabber name in square brackets [], see examples below. \n
* \n
* The GrabberOrder numbers the grabbers of the
* same name, so the example of the numbering may look like this:
* - PicPortX Mono [1]
* - PicPortExpress Stereo RTF [1]
* - PicPortX Mono [2]
* - PicPort Elite [1]
*
* As you can see in the example, only the second "PicPortX Mono" needs to have
* the grabber order specified, for all the other grabbers the default 0 is O.K.,
* as 0 has the same meaning as 1 (these 2 numbers of the same meaning were a
* necessary solution when the obsolete GrabberNumber was replaced by the
* GrabberOrder).\n
* \n
* LvxLive module: when the connection is selected using the
* lvx_DisplayConnectionDialog() method, both the grabber name and grabber order
* are always set.\n
* @note Changing the grabber order deactivates currently active
*       acquisition and returns the module to the uninitialized status.

* @ingroup OrchidFunctionsInitializing
* @param hLvxTask  Handle to Orchid module, created by lvx_OpenTask().
* @param iOrder    The order number.
*
* @par See also .NET version:
*      LeutronVision::Orchid::LvxBaseAcquisition::GrabberOrder
*/

DLLENTRY void WINAPI lvx_SetGrabberOrder(HLVXTASK hLvxTask, int iOrder);

/* -------------------------------------------------------------------------- */

/** Sets the order number of the grabber.
* This value is useful in case multiple grabbers of the same type are installed
* in the computer - it indicates the order number of the grabber. If
* GrabberOrder is set to 0, then the first found grabber of the specified name
* is used. Otherwise the GrabberOrder specifies the order number (numbered from 1)
* of the grabber of the specified name in the PC.\n
* The GrabberOrder can be either specified by this function, or can be put
* directly as part of the grabber name in square brackets [], see examples below. \n
* \n
* The GrabberOrder numbers the grabbers of the
* same name, so the example of the numbering may look like this:
* - PicPortX Mono [1]
* - PicPortExpress Stereo RTF [1]
* - PicPortX Mono [2]
* - PicPort Elite [1]
*
* As you can see in the example, only the second "PicPortX Mono" needs to have
* the grabber order specified, for all the other grabbers the default 0 is O.K.,
* as 0 has the same meaning as 1 (these 2 numbers of the same meaning were a
* necessary solution when the obsolete GrabberNumber was replaced by the
* GrabberOrder).\n
* \n
* LvxLive module: when the connection is selected using the
* lvx_DisplayConnectionDialog() method, both the grabber name and grabber order
* are always set.\n
* @note Changing the grabber order deactivates currently active
*       acquisition and returns the module to the uninitialized status.

* @ingroup OrchidFunctionsInitializing
* @param hLvxTask  Handle to Orchid module, created by lvx_OpenTask().
*
* @par See also .NET version
*      LeutronVision::Orchid::LvxBaseAcquisition::GrabberOrder
*/

DLLENTRY int  WINAPI lvx_GetGrabberOrder(HLVXTASK hLvxTask);

/* -------------------------------------------------------------------------- */

/** Sets the camera name.
*
* The camera name is a part of the connection specification triplet
* (Camera -> Connector -> Grabber), which is required to be set before
* acquisition module initialization.\n
* \n
* The name is not case-sensitive.\n
* \n
* The best way how to find out the correct camera name is to use the
* PicPort Demo, which lists all the cameras found for the specified grabber,
* or use the enumeration functions (see lvx_QueryCameraName() ).\n
*
* @note Changing the camera name deactivates currently active
*   acquisition and returns the module to the uninitialized status.
* @sa lvx_QueryCameraName() method, through which you can obtain a list
*   of cameras for the specified grabber.\n
* @ingroup OrchidFunctionsInitializing
* @param hLvxTask   Handle to Orchid module, created by lvx_OpenTask().
* @param pszName    Name in form of null-terminated string, for example "PicSight_P141B_CL".
*
* @par See also .NET version:
*      LeutronVision::Orchid::LvxBaseAcquisition::Camera
*/
DLLENTRY void WINAPI lvx_SetCamera(HLVXTASK hLvxTask, const char* pszName);

/** Returns the camera name.
*
* The camera name is a part of the connection specification triplet
* (Camera -> Connector -> Grabber), which is required to be set before
* acquisition module initialization.\n
* \n
* The name is not case-sensitive.\n
* \n
* The best way how to find out the correct camera name is to use the
* PicPort Demo, which lists all the cameras found for the specified grabber,
* or use the enumeration functions (see lvx_QueryCameraName() ).\n
*
* @note Changing the camera name deactivates currently active
*   acquisition and returns the module to the uninitialized status.
* @sa lvx_QueryCameraName() method, through which you can obtain a list
*   of cameras for the specified grabber.\n
* @ingroup OrchidFunctionsInitializing
* @param hLvxTask  Handle to Orchid module, created by lvx_OpenTask().
* @param pszName   Buffer for name in form of null-terminated string.
* @param iMaxLen   Size of the buffer.
*
* @par See also .NET version:
*      LeutronVision::Orchid::LvxBaseAcquisition::Camera
*/
DLLENTRY void WINAPI lvx_GetCamera(HLVXTASK hLvxTask, char* pszName, int iMaxLen);

/* -------------------------------------------------------------------------- */

/* ---obsolete--- */
DLLENTRY void WINAPI lvx_SetBaseCamera(HLVXTASK hLvxTask, const char* pszName);
/* ---obsolete--- */
DLLENTRY void WINAPI lvx_GetBaseCamera(HLVXTASK hLvxTask, char* pszName, int iMaxLen);

/* -------------------------------------------------------------------------- */

/** Sets the connector name.
* The connector name is a part of the connection specification triplet
* (Camera -> Connector -> Grabber), which is required to be set before the
* acquisition module initialization.\n
* \n
* The name is not case-sensitive.\n
* \n
* The best way how to find out the correct connector name is to use the
* PicPort Demo, which lists all the connectors found for the specified camera,
* or use the enumeration functions (see lvx_QueryConnectorName() ).\n
* The connector name for GigE and USB cameras is:
* - "internal" in case the camera name is used as the grabber name
* - the camera name in case the generic "GigE" or "USB" grabber names are used for the grabber name.
*
* @note Changing the connector name deactivates currently active
*   acquisition and returns the module to the uninitialized status.
* @note Instead of the connector name you can specify an asterisk (*) - in such
*       case the first found connector will be used. The asterisk cannot be
*       used when generic "GigE" and "USB" grabber names are used.
* @sa lvx_QueryConnectorName() method, through which you can obtain a list
*   of cameras for the specified grabber.\n
* @ingroup OrchidFunctionsInitializing
* @param hLvxTask   Handle to Orchid module, created by lvx_OpenTask().
* @param pszName    Name in form of null-terminated string.
*
* @par See also .NET version:
*      LeutronVision::Orchid::LvxBaseAcquisition::Connector
*/
DLLENTRY void WINAPI lvx_SetConnector(HLVXTASK hLvxTask, const char* pszName);

/* -------------------------------------------------------------------------- */

/** Returns the connector name.
* The connector name is a part of the connection specification triplet
* (Camera -> Connector -> Grabber), which is required to be set before the
* acquisition module initialization.\n
* \n
* The name is not case-sensitive.\n
* \n
* The best way how to find out the correct connector name is to use the
* PicPort Demo, which lists all the connectors found for the specified camera,
* or use the enumeration functions (see lvx_QueryConnectorName() ).\n
* The connector name for GigE and USB cameras is:
* - "internal" in case the camera name is used as the grabber name
* - the camera name in case the generic "GigE" or "USB" grabber names are used for the grabber name.
*
* @note Changing the connector name deactivates currently active
*   acquisition and returns the module to the uninitialized status.
* @note Instead of the connector name you can specify an asterisk (*) - in such
*       case the first found connector will be used. The asterisk cannot be
*       used when generic "GigE" and "USB" grabber names are used.
* @sa lvx_QueryConnectorName() method, through which you can obtain a list
*   of cameras for the specified grabber.\n
* @ingroup OrchidFunctionsInitializing
* @param hLvxTask   Handle to Orchid module, created by lvx_OpenTask().
* @param pszName    Name in form of null-terminated string.
* @param iMaxLen    Maximum length of the name
*
* @par See also .NET version:
*      LeutronVision::Orchid::LvxBaseAcquisition::Connector
*/
DLLENTRY void WINAPI lvx_GetConnector(HLVXTASK hLvxTask, char* pszName, int iMaxLen);