Class InferenceObjectDetector

View Source

Definition

Namespace:
Tizen.Multimedia.Vision
Assembly:
Tizen.Multimedia.Vision.dll

Provides the ability to detect object.


                
C#

                

                    
Copy

                    

                

            
public class InferenceObjectDetector : IDisposable
Inheritance
object
InferenceObjectDetector
Implements
System.IDisposable

Constructors

View Source

InferenceObjectDetector()

Initializes a new instance of the InferenceObjectDetector class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public InferenceObjectDetector()
Exceptions
Type Condition
System.NotSupportedException

The required features are not supported.

Methods

View Source

Dispose()

Releases all resources used by the InferenceObjectDetector.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
View Source

Dispose(bool)

Releases the unmanaged resources used by the InferenceObjectDetector.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
View Source

~InferenceObjectDetector()

Finalizes an instance of the InferenceObjectDetector class.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected ~InferenceObjectDetector()
View Source

GetRequestResults()

Gets the bounding boxes as a result of RequestInference(MediaVisionSource).

Declaration

                
C#

                

                    
Copy

                    

                

            
public InferenceObjectDetectorResult GetRequestResults()
Returns
Type Description
InferenceObjectDetectorResult

The bounding boxes of detected object.
Remarks

If there's no detected object, BoundingBoxes will be empty.
This method uses about twice as much memory as Inference(MediaVisionSource).

Exceptions
Type Condition
System.ObjectDisposedException

The InferenceObjectDetector already has been disposed.
See Also
View Source

Inference(MediaVisionSource)

Detects objects on the source image synchronously.

Declaration

                
C#

                

                    
Copy

                    

                

            
public InferenceObjectDetectorResult Inference(MediaVisionSource source)
Parameters
Type Name Description
MediaVisionSource source

The image data to detect object.
Returns
Type Description
InferenceObjectDetectorResult

BoundingBoxes of detected object.
Remarks

BoundingBoxes can be empty, if there's no detected object.

Exceptions
Type Condition
System.ObjectDisposedException

The InferenceObjectDetector already has been disposed.
System.ArgumentNullException

source is null.
View Source

InferenceAsync(MediaVisionSource)

Detects objects on the source image asynchronously.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Task<InferenceObjectDetectorResult> InferenceAsync(MediaVisionSource source)
Parameters
Type Name Description
MediaVisionSource source

The image data to detect object.
Returns
Type Description
System.Threading.Tasks.Task<TResult><InferenceObjectDetectorResult>
Remarks

BoundingBoxes can be empty, if there's no detected object.
This method uses about twice as much memory as Inference(MediaVisionSource).

Exceptions
Type Condition
System.ObjectDisposedException

The InferenceObjectDetector already has been disposed.
System.ArgumentNullException

source is null.
View Source

RequestInference(MediaVisionSource)

Requests detecting objects to get their bounding boxes asynchronously.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ulong RequestInference(MediaVisionSource source)
Parameters
Type Name Description
MediaVisionSource source

The image data to detect object.
Returns
Type Description
ulong

The request ID that indicates the order of requests.
Remarks

This function does not guarantee that inference is done when this method returns. The user can get the result by using GetRequestResults().
If the user calls this method again before the previous one is finished internally, the call will be ignored.
BoundingBoxes can be empty, if there's no detected object.
Note that this method could use about twice as much memory as Inference(MediaVisionSource).

Exceptions
Type Condition
System.ObjectDisposedException

The InferenceObjectDetector already has been disposed.
System.ArgumentNullException

source is null.
See Also

Implements

System.IDisposable