Edit

Share via

class Input::VisionSource

  • Article

Represents a source of vision data, used as input to a Computer Vision operation.

Members

Properties

Syntax: public Input::VisionSourceProperties & Properties;

Gets a collection of additional VisionSource properties.

~VisionSource

Syntax: public inline virtual ~VisionSource ( );

Destructs an instance of the VisionSource class.

FromDefaultCaptureDevice

Syntax: public inline static std::shared_ptr< VisionSource > FromDefaultCaptureDevice ( );

Initializes a new instance of the VisionSource class using the default capture device, such as a camera.

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

Not yet supported for use with ImageAnalyzer

FromCaptureDevice

Syntax: public inline static std::shared_ptr< VisionSource > FromCaptureDevice ( const std::string & deviceAttributes );

Initializes a new instance of the VisionSource class from a capture device specified by its attributes.

Parameters

  • deviceAttributes Capture device attributes (e.g. "front=true;"), or an empty string for default capture device<

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

Not yet supported for use with ImageAnalyzer.

FromCaptureDevice

Syntax: public inline static std::shared_ptr< VisionSource > FromCaptureDevice ( const std::wstring & deviceAttributes );

Initializes a new instance of the VisionSource class from a capture device specified by its attributes.

Parameters

  • deviceAttributes Capture device attributes (e.g. "front=true;"), or an empty string for default capture device<

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

Not yet supported for use with ImageAnalyzer.

FromFile

Syntax: public inline static std::shared_ptr< VisionSource > FromFile ( const std::string & fileName );

Initializes a new instance of the VisionSource class using a local input image or video file.

Parameters

  • fileName The full path name of the local file

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

FromFile

Syntax: public inline static std::shared_ptr< VisionSource > FromFile ( const std::wstring & fileName );

Initializes a new instance of the VisionSource class using a local input image or video file.

Parameters

  • fileName The full path name of the local file

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

FromUrl

Syntax: public inline static std::shared_ptr< VisionSource > FromUrl ( const std::string & url );

Initializes a new instance of the VisionSource class using the specified internet-accessible URL.

Parameters

  • url An accessible URL for the input media

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

FromUrl

Syntax: public inline static std::shared_ptr< VisionSource > FromUrl ( const std::wstring & url );

Initializes a new instance of the VisionSource class using the specified internet-accessible URL.

Parameters

  • url An accessible URL for the input media

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

FromFrameSource

Syntax: public inline static std::shared_ptr< VisionSource > FromFrameSource ( const std::shared_ptr< Frames::FrameSource > & frameSource );

Initializes a new instance of the VisionSource class with a FrameSource.

Parameters

  • frameSource A FrameSource obtained via FrameSource::FromFormat()

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

Not yet supported for use with ImageAnalyzer

FromFrameSetSource

Syntax: public inline static std::shared_ptr< VisionSource > FromFrameSetSource ( const std::shared_ptr< Frames::FrameSetSource > & frameSetSource );

Initializes a new instance of the VisionSource class with a FrameSource.

Parameters

  • frameSetSource A FrameSetSource obtained via FrameSetSource::FromFormat()

Returns

The newly created VisionSource wrapped inside a std::shared_ptr

Not yet supported for use with ImageAnalyzer

FromImageSourceBuffer

Syntax: public inline static std::shared_ptr< VisionSource > FromImageSourceBuffer ( const std::shared_ptr< ImageSourceBuffer > & imageSourceBuffer );

Initializes a new instance of the VisionSource class from an ImageSourceBuffer, allowing the application to pass in an image from a memory buffer.

Parameters

  • imageSourceBuffer The image source buffer containing the image to process

Returns

The newly created VisionSource as a std::shared_ptr