class dlstreamer::BaseFrame

Overview

#include <frame.h>

class BaseFrame: public dlstreamer::Frame {
public:
    // construction

    BaseFrame(MediaType media_type, Format format, TensorVector tensors);
    BaseFrame(MediaType media_type, Format format, MemoryType memory_type);

    // methods

    virtual size_t num_tensors() const;
    virtual TensorPtr tensor(int index);
    virtual iterator begin();
    virtual iterator end();
    virtual MediaType media_type() const;
    virtual Format format() const;
    virtual MemoryType memory_type() const;
    virtual Metadata& metadata();
    virtual FramePtr parent() const;
    void set_parent(FramePtr parent);
    virtual std::vector<FramePtr> regions() const;
    void add_region(FramePtr frame);
};

// direct descendants

class CPUFrameAlloc;
class FFmpegFrame;
class GSTFrame;
class OpenVINOFrame;
class VAAPIFrame;

Inherited Members

public:
    // typedefs

    typedef std::vector<TensorPtr>::iterator iterator;

    // methods

    Frame& operator = (const Frame&);
    virtual MediaType media_type() const = 0;
    virtual Format format() const = 0;
    virtual MemoryType memory_type() const = 0;
    virtual iterator begin() = 0;
    virtual iterator end() = 0;
    virtual TensorPtr tensor(int index = -1) = 0;
    virtual size_t num_tensors() const = 0;
    virtual Metadata& metadata() = 0;
    const Metadata& metadata() const;
    virtual FramePtr parent() const = 0;
    virtual std::vector<FramePtr> regions() const = 0;

Detailed Documentation

Methods

virtual size_t num_tensors() const

Returns number tensors in frame.

virtual TensorPtr tensor(int index)

Returns tensor by index. If index less than 0 (default is -1), function checks that frame contains only one tensor and returns it, otherwise exception is thrown.

Parameters:

index

Tensor index

virtual MediaType media_type() const

Returns media type (Tensors, Image, Audio, etc).

virtual Format format() const

Returns format (media type specific) of frame’s data.

virtual MemoryType memory_type() const

Returns memory type used for tensors allocation.

virtual Metadata& metadata()

Returns metadata object.

virtual FramePtr parent() const

Returns parent frame if this frame was mapped (using MemoryMapper) from another frame or contains sub-region of another frame, otherwise returns nullptr.

virtual std::vector<FramePtr> regions() const

Returns list of regions. Each region typically represents an object detected on frame and may contain own metadata describing region specific attributes.