GstAnalyticsTensorProvenanceMtd

GstAnalyticsTensorProvenanceMtd stores provenance associated with a tensor without keeping the tensor data itself alive. It stores the group and tensor IDs of the associated tensor.

Tensor provenance metadata can be related to other analytics metadata. For example, a preprocessing element can create a tensor from an object detection and keep the relation between them:

   GstAnalyticsRelationMeta
     |
     +-- GstAnalyticsODMtd
     |        ^
     |        |
     |     relation
     |        |
     +-- GstAnalyticsTensorProvenanceMtd
              |
              +-- correlation-id = 10

The correlation ID can be stored as provenance in GstTensorListMeta. This allows derived tensor data to be associated with its provenance metadata without keeping the original tensor alive:

   GstTensorListMeta
     |
     +-- item
           |
           +-- tensor "image"
           |
           +-- provenance
                 +-- "image" -> [ 10 ]
                                      |
                                      +--> GstAnalyticsTensorProvenanceMtd
                                             |
                                             +-- relation --> GstAnalyticsODMtd

The correlation ID is preserved when the provenance metadata is copied or transformed. Multiple provenance records can have the same correlation ID after copy or transform.

Tensor provenance metadata can also store a spatial transform from tensor coordinates to video buffer coordinates. A tensor decoder can use this transform to map spatial inference results back to the video buffer.

GstAnalyticsTensorProvenanceMtd

Handle containing data required to use gst_analytics_tensor_provenance_mtd APIs. This type is generally expected to be allocated on the stack.

Members

id (guint) –

Instance identifier.

Instance of GstAnalyticsRelationMeta where the analytics-metadata identified by id is stored.

Since : 1.30

GstAnalytics.TensorProvenanceMtd

Handle containing data required to use gst_analytics_tensor_provenance_mtd APIs. This type is generally expected to be allocated on the stack.

Members

id (Number) –

Instance identifier.

Instance of GstAnalytics.RelationMeta where the analytics-metadata identified by id is stored.

Since : 1.30

GstAnalytics.TensorProvenanceMtd

Handle containing data required to use gst_analytics_tensor_provenance_mtd APIs. This type is generally expected to be allocated on the stack.

Members

id (int) –

Instance identifier.

Instance of GstAnalytics.RelationMeta where the analytics-metadata identified by id is stored.

Since : 1.30

Methods

gst_analytics_tensor_provenance_mtd_get_correlation_id 

gint64
gst_analytics_tensor_provenance_mtd_get_correlation_id (const GstAnalyticsTensorProvenanceMtd * mtd)

Gets the correlation ID of mtd. The ID can be used to associate derived tensor data with this provenance metadata and is preserved when the metadata is copied.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

Returns –

the correlation ID

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.get_correlation_id 

function GstAnalytics.TensorProvenanceMtd.prototype.get_correlation_id(): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_get_correlation_id'
}

Gets the correlation ID of mtd. The ID can be used to associate derived tensor data with this provenance metadata and is preserved when the metadata is copied.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (Number) –

the correlation ID

Since : 1.30

GstAnalytics.TensorProvenanceMtd.get_correlation_id 

def GstAnalytics.TensorProvenanceMtd.get_correlation_id (self):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_get_correlation_id'

Gets the correlation ID of mtd. The ID can be used to associate derived tensor data with this provenance metadata and is preserved when the metadata is copied.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (int) –

the correlation ID

Since : 1.30

gst_analytics_tensor_provenance_mtd_get_group_id 

GQuark
gst_analytics_tensor_provenance_mtd_get_group_id (const GstAnalyticsTensorProvenanceMtd * mtd)

Gets the tensor group identifier.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

Returns –

the tensor group identifier

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.get_group_id 

function GstAnalytics.TensorProvenanceMtd.prototype.get_group_id(): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_get_group_id'
}

Gets the tensor group identifier.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (GLib.Quark) –

the tensor group identifier

Since : 1.30

GstAnalytics.TensorProvenanceMtd.get_group_id 

def GstAnalytics.TensorProvenanceMtd.get_group_id (self):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_get_group_id'

Gets the tensor group identifier.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (GLib.Quark) –

the tensor group identifier

Since : 1.30

gst_analytics_tensor_provenance_mtd_get_spatial_transform 

gboolean
gst_analytics_tensor_provenance_mtd_get_spatial_transform (const GstAnalyticsTensorProvenanceMtd * mtd,
                                                           gfloat * transform)

Gets the spatial transformation matrix. The matrix transforms coordinates from the tensor coordinate space to the coordinate space of the video buffer carrying the GstAnalyticsRelationMeta.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

transform ( [out][array fixed-size=9]) –

location for the 3x3 spatial transformation matrix in row-major order

Returns –

TRUE if spatial transformation information is available, otherwise FALSE

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.get_spatial_transform 

function GstAnalytics.TensorProvenanceMtd.prototype.get_spatial_transform(): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_get_spatial_transform'
}

Gets the spatial transformation matrix. The matrix transforms coordinates from the tensor coordinate space to the coordinate space of the video buffer carrying the GstAnalytics.RelationMeta.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns a tuple made of:

(Number ) –

true if spatial transformation information is available, otherwise false

transform ([ Number ] ) –

true if spatial transformation information is available, otherwise false

Since : 1.30

GstAnalytics.TensorProvenanceMtd.get_spatial_transform 

def GstAnalytics.TensorProvenanceMtd.get_spatial_transform (self):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_get_spatial_transform'

Gets the spatial transformation matrix. The matrix transforms coordinates from the tensor coordinate space to the coordinate space of the video buffer carrying the GstAnalytics.RelationMeta.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns a tuple made of:

(bool ) –

True if spatial transformation information is available, otherwise False

transform ([ float ] ) –

True if spatial transformation information is available, otherwise False

Since : 1.30

gst_analytics_tensor_provenance_mtd_get_tensor_id 

GQuark
gst_analytics_tensor_provenance_mtd_get_tensor_id (const GstAnalyticsTensorProvenanceMtd * mtd)

Gets the tensor identifier.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

Returns –

the tensor identifier

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.get_tensor_id 

function GstAnalytics.TensorProvenanceMtd.prototype.get_tensor_id(): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_get_tensor_id'
}

Gets the tensor identifier.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (GLib.Quark) –

the tensor identifier

Since : 1.30

GstAnalytics.TensorProvenanceMtd.get_tensor_id 

def GstAnalytics.TensorProvenanceMtd.get_tensor_id (self):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_get_tensor_id'

Gets the tensor identifier.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (GLib.Quark) –

the tensor identifier

Since : 1.30

gst_analytics_tensor_provenance_mtd_get_timestamp 

gboolean
gst_analytics_tensor_provenance_mtd_get_timestamp (const GstAnalyticsTensorProvenanceMtd * mtd,
                                                   GstClockTime * timestamp,
                                                   GstClockTime * duration)

Parameters:

mtd –
No description available
timestamp –
No description available
duration –
No description available
Returns –
No description available

GstAnalytics.TensorProvenanceMtd.prototype.get_timestamp 

function GstAnalytics.TensorProvenanceMtd.prototype.get_timestamp(timestamp: Number, duration: Number): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_get_timestamp'
}

Parameters:

No description available
timestamp (Number) –
No description available
duration (Number) –
No description available
Returns (Number) –
No description available

GstAnalytics.TensorProvenanceMtd.get_timestamp 

def GstAnalytics.TensorProvenanceMtd.get_timestamp (self, timestamp, duration):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_get_timestamp'

Parameters:

No description available
timestamp (int) –
No description available
duration (int) –
No description available
Returns (bool) –
No description available

gst_analytics_tensor_provenance_mtd_has_spatial_transform 

gboolean
gst_analytics_tensor_provenance_mtd_has_spatial_transform (const GstAnalyticsTensorProvenanceMtd * mtd)

Checks whether mtd contains spatial transformation information.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

Returns –

TRUE if spatial transformation information is available, otherwise FALSE

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.has_spatial_transform 

function GstAnalytics.TensorProvenanceMtd.prototype.has_spatial_transform(): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_has_spatial_transform'
}

Checks whether mtd contains spatial transformation information.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (Number) –

true if spatial transformation information is available, otherwise false

Since : 1.30

GstAnalytics.TensorProvenanceMtd.has_spatial_transform 

def GstAnalytics.TensorProvenanceMtd.has_spatial_transform (self):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_has_spatial_transform'

Checks whether mtd contains spatial transformation information.

Parameters:

a GstAnalytics.TensorProvenanceMtd

Returns (bool) –

True if spatial transformation information is available, otherwise False

Since : 1.30

gst_analytics_tensor_provenance_mtd_set_spatial_transform 

gboolean
gst_analytics_tensor_provenance_mtd_set_spatial_transform (GstAnalyticsTensorProvenanceMtd * mtd,
                                                           const gfloat * transform)

Sets a spatial transform from tensor coordinates to video buffer coordinates.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

transform ( [array fixed-size=9]) –

a 3x3 transformation matrix in row-major order

Returns –

TRUE on success, otherwise FALSE

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.set_spatial_transform 

function GstAnalytics.TensorProvenanceMtd.prototype.set_spatial_transform(transform: [ Number ]): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_set_spatial_transform'
}

Sets a spatial transform from tensor coordinates to video buffer coordinates.

Parameters:

a GstAnalytics.TensorProvenanceMtd

transform ([ Number ]) –

a 3x3 transformation matrix in row-major order

Returns (Number) –

true on success, otherwise false

Since : 1.30

GstAnalytics.TensorProvenanceMtd.set_spatial_transform 

def GstAnalytics.TensorProvenanceMtd.set_spatial_transform (self, transform):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_set_spatial_transform'

Sets a spatial transform from tensor coordinates to video buffer coordinates.

Parameters:

a GstAnalytics.TensorProvenanceMtd

transform ([ float ]) –

a 3x3 transformation matrix in row-major order

Returns (bool) –

True on success, otherwise False

Since : 1.30

gst_analytics_tensor_provenance_mtd_set_spatial_transform_from_rectangles 

gboolean
gst_analytics_tensor_provenance_mtd_set_spatial_transform_from_rectangles (GstAnalyticsTensorProvenanceMtd * mtd,
                                                                           const GstVideoRectangle * tensor_rect,
                                                                           const GstVideoRectangle * video_rect)

Sets a spatial transform that maps tensor_rect to video_rect.

This is a convenience function for axis-aligned scale and translation. For other transformations, use gst_analytics_tensor_provenance_mtd_set_spatial_transform.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

tensor_rect –

rectangle in tensor coordinates

video_rect –

rectangle in video buffer coordinates

Returns –

TRUE on success, otherwise FALSE

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.set_spatial_transform_from_rectangles 

function GstAnalytics.TensorProvenanceMtd.prototype.set_spatial_transform_from_rectangles(tensor_rect: GstVideo.VideoRectangle, video_rect: GstVideo.VideoRectangle): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_set_spatial_transform_from_rectangles'
}

Sets a spatial transform that maps tensor_rect to video_rect.

This is a convenience function for axis-aligned scale and translation. For other transformations, use GstAnalytics.TensorProvenanceMtd.prototype.set_spatial_transform.

Parameters:

a GstAnalytics.TensorProvenanceMtd

tensor_rect (GstVideo.VideoRectangle) –

rectangle in tensor coordinates

video_rect (GstVideo.VideoRectangle) –

rectangle in video buffer coordinates

Returns (Number) –

true on success, otherwise false

Since : 1.30

GstAnalytics.TensorProvenanceMtd.set_spatial_transform_from_rectangles 

def GstAnalytics.TensorProvenanceMtd.set_spatial_transform_from_rectangles (self, tensor_rect, video_rect):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_set_spatial_transform_from_rectangles'

Sets a spatial transform that maps tensor_rect to video_rect.

This is a convenience function for axis-aligned scale and translation. For other transformations, use GstAnalytics.TensorProvenanceMtd.set_spatial_transform.

Parameters:

a GstAnalytics.TensorProvenanceMtd

tensor_rect (GstVideo.VideoRectangle) –

rectangle in tensor coordinates

video_rect (GstVideo.VideoRectangle) –

rectangle in video buffer coordinates

Returns (bool) –

True on success, otherwise False

Since : 1.30

gst_analytics_tensor_provenance_mtd_set_timestamp 

gboolean
gst_analytics_tensor_provenance_mtd_set_timestamp (GstAnalyticsTensorProvenanceMtd * mtd,
                                                   GstClockTime timestamp,
                                                   GstClockTime duration)

Parameters:

mtd –
No description available
timestamp –
No description available
duration –
No description available
Returns –
No description available

GstAnalytics.TensorProvenanceMtd.prototype.set_timestamp 

function GstAnalytics.TensorProvenanceMtd.prototype.set_timestamp(timestamp: Number, duration: Number): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_set_timestamp'
}

Parameters:

No description available
timestamp (Number) –
No description available
duration (Number) –
No description available
Returns (Number) –
No description available

GstAnalytics.TensorProvenanceMtd.set_timestamp 

def GstAnalytics.TensorProvenanceMtd.set_timestamp (self, timestamp, duration):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_set_timestamp'

Parameters:

No description available
timestamp (int) –
No description available
duration (int) –
No description available
Returns (bool) –
No description available

gst_analytics_tensor_provenance_mtd_transform_point 

gboolean
gst_analytics_tensor_provenance_mtd_transform_point (const GstAnalyticsTensorProvenanceMtd * mtd,
                                                     gfloat * x,
                                                     gfloat * y)

Transforms (@x, y) from tensor coordinates to video buffer coordinates.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

x ( [inout]) –

x coordinate

y ( [inout]) –

y coordinate

Returns –

TRUE on success, otherwise FALSE

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.transform_point 

function GstAnalytics.TensorProvenanceMtd.prototype.transform_point(x: Number, y: Number): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_transform_point'
}

Transforms (@x, y) from tensor coordinates to video buffer coordinates.

Parameters:

a GstAnalytics.TensorProvenanceMtd

x (Number) –

x coordinate

y (Number) –

y coordinate

Returns a tuple made of:

(Number ) –

true on success, otherwise false

x (Number ) –

true on success, otherwise false

y (Number ) –

true on success, otherwise false

Since : 1.30

GstAnalytics.TensorProvenanceMtd.transform_point 

def GstAnalytics.TensorProvenanceMtd.transform_point (self, x, y):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_transform_point'

Transforms (@x, y) from tensor coordinates to video buffer coordinates.

Parameters:

a GstAnalytics.TensorProvenanceMtd

x (float) –

x coordinate

y (float) –

y coordinate

Returns a tuple made of:

(bool ) –

True on success, otherwise False

x (float ) –

True on success, otherwise False

y (float ) –

True on success, otherwise False

Since : 1.30

gst_analytics_tensor_provenance_mtd_transform_rectangle 

gboolean
gst_analytics_tensor_provenance_mtd_transform_rectangle (const GstAnalyticsTensorProvenanceMtd * mtd,
                                                         gfloat * x,
                                                         gfloat * y,
                                                         gfloat * width,
                                                         gfloat * height)

Transforms an axis-aligned rectangle from tensor coordinates to video buffer coordinates.

Parameters:

mtd –

a GstAnalyticsTensorProvenanceMtd

x ( [inout]) –

x coordinate of the rectangle

y ( [inout]) –

y coordinate of the rectangle

width ( [inout]) –

width of the rectangle

height ( [inout]) –

height of the rectangle

Returns –

TRUE on success. FALSE if the transform is not available or does not preserve an axis-aligned rectangle.

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.transform_rectangle 

function GstAnalytics.TensorProvenanceMtd.prototype.transform_rectangle(x: Number, y: Number, width: Number, height: Number): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_transform_rectangle'
}

Transforms an axis-aligned rectangle from tensor coordinates to video buffer coordinates.

Parameters:

a GstAnalytics.TensorProvenanceMtd

x (Number) –

x coordinate of the rectangle

y (Number) –

y coordinate of the rectangle

width (Number) –

width of the rectangle

height (Number) –

height of the rectangle

Returns a tuple made of:

(Number ) –

true on success. false if the transform is not available or does not preserve an axis-aligned rectangle.

x (Number ) –

true on success. false if the transform is not available or does not preserve an axis-aligned rectangle.

y (Number ) –

true on success. false if the transform is not available or does not preserve an axis-aligned rectangle.

width (Number ) –

true on success. false if the transform is not available or does not preserve an axis-aligned rectangle.

height (Number ) –

true on success. false if the transform is not available or does not preserve an axis-aligned rectangle.

Since : 1.30

GstAnalytics.TensorProvenanceMtd.transform_rectangle 

def GstAnalytics.TensorProvenanceMtd.transform_rectangle (self, x, y, width, height):
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_transform_rectangle'

Transforms an axis-aligned rectangle from tensor coordinates to video buffer coordinates.

Parameters:

a GstAnalytics.TensorProvenanceMtd

x (float) –

x coordinate of the rectangle

y (float) –

y coordinate of the rectangle

width (float) –

width of the rectangle

height (float) –

height of the rectangle

Returns a tuple made of:

(bool ) –

True on success. False if the transform is not available or does not preserve an axis-aligned rectangle.

x (float ) –

True on success. False if the transform is not available or does not preserve an axis-aligned rectangle.

y (float ) –

True on success. False if the transform is not available or does not preserve an axis-aligned rectangle.

width (float ) –

True on success. False if the transform is not available or does not preserve an axis-aligned rectangle.

height (float ) –

True on success. False if the transform is not available or does not preserve an axis-aligned rectangle.

Since : 1.30

Functions

gst_analytics_tensor_provenance_mtd_get_mtd_type 

GstAnalyticsMtdType
gst_analytics_tensor_provenance_mtd_get_mtd_type ()
Returns –

the GstAnalyticsMtdType of GstAnalyticsTensorProvenanceMtd

Since : 1.30

GstAnalytics.TensorProvenanceMtd.prototype.get_mtd_type 

function GstAnalytics.TensorProvenanceMtd.prototype.get_mtd_type(): {
    // javascript wrapper for 'gst_analytics_tensor_provenance_mtd_get_mtd_type'
}
Returns (Number) –

the Number of GstAnalytics.TensorProvenanceMtd

Since : 1.30

GstAnalytics.TensorProvenanceMtd.get_mtd_type 

def GstAnalytics.TensorProvenanceMtd.get_mtd_type ():
    #python wrapper for 'gst_analytics_tensor_provenance_mtd_get_mtd_type'
Returns (int) –

the int of GstAnalytics.TensorProvenanceMtd

Since : 1.30

The results of the search are