PySpin.CameraList

class CameraList(*args)

Used to hold a list of camera objects.

Add(self, camera)

Parameters

camera: Spinnaker::CameraPtr

Spinnaker::CameraList::Add Adds a copy of an camera object.

param camera:

A camera object to be added to this list.

Append(self, list)

Parameters

list: Spinnaker::CameraList const &

Spinnaker::CameraList::Append Appends a copy of the camera list.

param list:

Another CameraList object, whose elements are added to this list.

Clear(self)

Spinnaker::CameraList::Clear Clears the list of cameras and destroys their corresponding reference counted objects. This is necessary in order to clean up the parent interface. It is important that the camera list is destroyed or is cleared before calling system->ReleaseInstance() or else the call to system->ReleaseInstance() will result in an error message thrown that a reference to the camera is still held.

See: System:ReleaseInstance()

GetByDeviceID(self, deviceID) → CameraPtr

Parameters

deviceID: std::string

Spinnaker::CameraList::GetByDeviceID Returns a pointer to a camera object with the specified device identifier. This function will return a NULL CameraPtr if no matching device identifier is found.

param deviceID:

The unique device identifier of the camera object to retrieve

A pointer to a camera object.

GetByIndex(self, index) → CameraPtr

Parameters

index: unsigned int

Spinnaker::CameraList::GetByIndex Returns a pointer to a camera object at the “index”. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

param index:

The index at which to retrieve the camera object

A pointer to a camera object.

GetBySerial(self, serialNumber) → CameraPtr

Parameters

serialNumber: std::string

Spinnaker::CameraList::GetBySerial Returns a pointer to a camera object with the specified serial number. This function will return a NULL CameraPtr if no matching camera serial is found.

param serialNumber:

The serial number of the camera object to retrieve

A pointer to a camera object.

GetSize(self) → unsigned int

Spinnaker::CameraList::GetSize Returns the size of the camera list. The size is the number of Camera objects stored in the list.

An integer that represents the list size.

Remove(self, camera)

Parameters

camera: Spinnaker::CameraPtr

Spinnaker::CameraList::Remove Removes all occurences of an camera that is pointed to by the input camera pointer and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLEerror if no matching camera is found.

param camera:

Pointer to the camera that is to be removed

RemoveByDeviceID(self, deviceID)

Parameters

deviceID: std::string

Spinnaker::CameraList::RemoveByDeviceID Removes a camera using its unique device identifier and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLE error if no matching device identifier is found.

param deviceID:

The unique device identifier of the camera object to retrieve

RemoveByIndex(self, index)

Parameters

index: unsigned int

Spinnaker::CameraList::RemoveByIndex Removes a camera at “index” and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_INVALID_PARAMETER error if the input index is out of range.

param index:

The index at which to remove the Camera object

RemoveBySerial(self, serialNumber)

Parameters

serialNumber: std::string

Spinnaker::CameraList::RemoveBySerial Removes a camera using its serial number and destroys its corresponding reference counted object. This function will throw a Spinnaker exception with SPINNAKER_ERR_NOT_AVAILABLE error if no matching camera serial is found.

param serialNumber:

The serial number of the Camera object to remove