|
XimeaCamera Class |
The class provides access to XIMEA cameras.
Inheritance HierarchySystemObject
Accord.Video.XimeaXimeaCamera
Accord.Video.XimeaXimeaCamera
Namespace: Accord.Video.Ximea
Assembly: Accord.Video.Ximea (in Accord.Video.Ximea.dll) Version: 3.8.0
SyntaxThe XimeaCamera type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | XimeaCamera | Initializes a new instance of the XimeaCamera class |
Properties| Name | Description | |
|---|---|---|
  | CamerasCount |
Get number of XIMEA camera connected to the system.
|
| DeviceID |
ID of the the recently opened XIMEA camera.
|
| IsAcquisitionStarted |
Specifies if camera's data acquisition is currently active for the opened camera (if any).
|
| IsDeviceOpen |
Specifies if a camera is currently opened by the instance of the class.
|
Methods| Name | Description | |
|---|---|---|
| Close |
Close opened camera (if any) and release allocated resources.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetImage |
Get image from the opened XIMEA camera.
|
| GetImage(Int32) |
Get image from the opened XIMEA camera.
|
| GetImage(Int32, Boolean) |
Get image from the opened XIMEA camera.
|
| GetParamFloat |
Get camera's parameter as float value.
|
| GetParamInt |
Get camera's parameter as integer value.
|
| GetParamString |
Get camera's parameter as string value.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Open |
Open XIMEA camera.
|
| SetParam(String, Int32) |
Set camera's parameter.
|
| SetParam(String, Single) |
Set camera's parameter.
|
| StartAcquisition |
Begin camera's work cycle and start data acquisition from it.
|
| StopAcquisition |
End camera's work cycle and stops data acquisition.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | HasMethod |
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.) |
| IsEqual |
Compares two objects for equality, performing an elementwise
comparison if the elements are vectors or matrices.
(Defined by Matrix.) |
| To(Type) | Overloaded.
Converts an object into another type, irrespective of whether
the conversion can be done at compile time or not. This can be
used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.) |
| ToT | Overloaded.
Converts an object into another type, irrespective of whether
the conversion can be done at compile time or not. This can be
used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.) |
RemarksThe class allows to perform image acquisition from XIMEA cameras. It wraps XIMEA'a xiAPI, which means that users of this class will also require m3api.dll and a correct TM file for the camera model connected to the system (both are provided with XIMEA API software package).
Sample usage:
XimeaCamera camera = new XimeaCamera( ); // open camera and start data acquisition camera.Open( 0 ); camera.StartAcquisition( ); // set exposure time to 10 milliseconds camera.SetParam( CameraParameter.Exposure, 10 * 1000 ); // get image from the camera Bitmap bitmap = camera.GetImage( ); // process the image // ... // dispose the image when it is no longer needed bitmap.Dispose( ); // stop data acquisition and close the camera camera.StopAcquisition( ); camera.Close( );
See Also