Public Types | Public Member Functions
InferenceEngine::I420Blob Class Reference

Represents a blob that contains three planes (Y,U and V) in I420 color format. More...

#include <ie_compound_blob.h>

Inheritance diagram for InferenceEngine::I420Blob:
Inheritance graph
[legend]
Collaboration diagram for InferenceEngine::I420Blob:
Collaboration graph
[legend]

Public Types

using Ptr = std::shared_ptr< I420Blob >
 A smart pointer to the I420Blob object.
 
using CPtr = std::shared_ptr< const I420Blob >
 A smart pointer to the const I420Blob object.
 
- Public Types inherited from InferenceEngine::CompoundBlob
using Ptr = std::shared_ptr< CompoundBlob >
 A smart pointer to the CompoundBlob object.
 
using CPtr = std::shared_ptr< const CompoundBlob >
 A smart pointer to the const CompoundBlob object.
 
- Public Types inherited from InferenceEngine::Blob
using Ptr = std::shared_ptr< Blob >
 A smart pointer containing Blob object.
 
using CPtr = std::shared_ptr< const Blob >
 A smart pointer to the const Blob object.
 

Public Member Functions

 I420Blob ()=delete
 A deleted default constructor.
 
 I420Blob (const Blob::Ptr &y, const Blob::Ptr &u, const Blob::Ptr &v)
 Constructs I420 blob from three planes Y, U and V. More...
 
 I420Blob (Blob::Ptr &&y, Blob::Ptr &&u, Blob::Ptr &&v)
 Constructs I420 blob from three planes Y, U and V. More...
 
virtual ~I420Blob ()
 A virtual destructor. It is made out of line for RTTI to work correctly on some platforms.
 
 I420Blob (const I420Blob &blob)=default
 A copy constructor.
 
I420Bloboperator= (const I420Blob &blob)=default
 A copy assignment operator.
 
 I420Blob (I420Blob &&blob)=default
 A move constructor.
 
I420Bloboperator= (I420Blob &&blob)=default
 A move assignment operator.
 
Blob::Ptry () noexcept
 Returns a reference to shared pointer to Y plane. More...
 
const Blob::Ptry () const noexcept
 Returns a constant reference to shared pointer to Y plane. More...
 
Blob::Ptru () noexcept
 Returns a reference to shared pointer to U plane. More...
 
const Blob::Ptru () const noexcept
 Returns a constant reference to shared pointer to U plane. More...
 
Blob::Ptrv () noexcept
 Returns a reference to shared pointer to V plane. More...
 
const Blob::Ptrv () const noexcept
 Returns a constant reference to shared pointer to V plane. More...
 
- Public Member Functions inherited from InferenceEngine::CompoundBlob
virtual ~CompoundBlob ()=default
 A virtual destructor.
 
 CompoundBlob (const CompoundBlob &blob)
 A copy constructor.
 
CompoundBloboperator= (const CompoundBlob &blob)=default
 A copy assignment operator.
 
 CompoundBlob (CompoundBlob &&blob)
 A move constructor.
 
CompoundBloboperator= (CompoundBlob &&blob)=default
 A move assignment operator.
 
 CompoundBlob (const std::vector< Blob::Ptr > &blobs)
 Constructs a compound blob from a vector of blobs. More...
 
 CompoundBlob (std::vector< Blob::Ptr > &&blobs)
 Constructs a compound blob from a vector of blobs. More...
 
size_t byteSize () const noexcept override
 Always returns 0.
 
size_t element_size () const noexcept override
 Always returns 0.
 
void allocate () noexcept override
 No operation is performed. Compound blob does not allocate/deallocate any data.
 
bool deallocate () noexcept override
 No operation is performed. Compound blob does not allocate/deallocate any data. More...
 
LockedMemory< void > buffer () noexcept override
 Always returns an empty LockedMemory object.
 
LockedMemory< const void > cbuffer () const noexcept override
 Always returns an empty LockedMemory object.
 
size_t size () const noexcept override
 Returns the number of underlying blobs in the compound blob.
 
virtual Blob::Ptr getBlob (size_t i) const noexcept
 Returns an underlying blob at index i. More...
 
- Public Member Functions inherited from InferenceEngine::Blob
virtual ~Blob ()
 Blob virtual destructor.
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
bool is () noexcept
 Checks if the Blob object can be cast to the type T*. More...
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
bool is () const noexcept
 Checks if the Blob object can be cast to the type const T*. More...
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
T * as () noexcept
 Casts this Blob object to the type T*. More...
 
template<typename T , typename std::enable_if<!std::is_pointer< T >::value &&!std::is_reference< T >::value, int >::type = 0, typename std::enable_if< std::is_base_of< Blob, T >::value, int >::type = 0>
const T * as () const noexcept
 Casts this Blob object to the type const T*. More...
 
 Blob (const TensorDesc &tensorDesc)
 Constructor. Creates an empty Blob object with the specified precision. More...
 
virtual const TensorDescgetTensorDesc () const noexcept
 Returns the tensor description.
 
virtual TensorDescgetTensorDesc () noexcept
 Returns the tensor description.
 

Additional Inherited Members

- Static Public Member Functions inherited from InferenceEngine::Blob
static Ptr CreateFromData (const DataPtr &data)
 Creates a TBlob<> object from a Data node. More...
 
- Protected Member Functions inherited from InferenceEngine::CompoundBlob
 CompoundBlob ()
 A default constructor.
 
const std::shared_ptr< IAllocator > & getAllocator () const noexcept override
 Returns nullptr as CompoundBlob is not allocator-based.
 
void * getHandle () const noexcept override
 Returns nullptr as CompoundBlob is not allocator-based.
 
- Static Protected Member Functions inherited from InferenceEngine::Blob
static size_t product (const SizeVector &dims) noexcept
 Multiplies the dimension vector values. More...
 
- Protected Attributes inherited from InferenceEngine::CompoundBlob
std::vector< Blob::Ptr_blobs
 Compound blob container for underlying blobs.
 
- Protected Attributes inherited from InferenceEngine::Blob
TensorDesc tensorDesc
 The tensor descriptor of the given blob.
 

Detailed Description

Represents a blob that contains three planes (Y,U and V) in I420 color format.

Constructor & Destructor Documentation

§ I420Blob() [1/2]

InferenceEngine::I420Blob::I420Blob ( const Blob::Ptr y,
const Blob::Ptr u,
const Blob::Ptr v 
)

Constructs I420 blob from three planes Y, U and V.

Parameters
yBlob object that represents Y plane in I420 color format
uBlob object that represents U plane in I420 color format
vBlob object that represents V plane in I420 color format

§ I420Blob() [2/2]

InferenceEngine::I420Blob::I420Blob ( Blob::Ptr &&  y,
Blob::Ptr &&  u,
Blob::Ptr &&  v 
)

Constructs I420 blob from three planes Y, U and V.

Parameters
yBlob object that represents Y plane in I420 color format
uBlob object that represents U plane in I420 color format
vBlob object that represents V plane in I420 color format

Member Function Documentation

§ u() [1/2]

Blob::Ptr& InferenceEngine::I420Blob::u ( )
noexcept

Returns a reference to shared pointer to U plane.

Please note that reference to Blob::Ptr is returned. I.e. the reference will be valid until the I420Blob object is destroyed.

Returns
reference to shared pointer object of U plane

§ u() [2/2]

const Blob::Ptr& InferenceEngine::I420Blob::u ( ) const
noexcept

Returns a constant reference to shared pointer to U plane.

Please note that reference to Blob::Ptr is returned. I.e. the reference will be valid until the I420Blob object is destroyed.

Returns
constant reference to shared pointer object of U plane

§ v() [1/2]

Blob::Ptr& InferenceEngine::I420Blob::v ( )
noexcept

Returns a reference to shared pointer to V plane.

Please note that reference to Blob::Ptr is returned. I.e. the reference will be valid until the I420Blob object is destroyed.

Returns
reference to shared pointer object of V plane

§ v() [2/2]

const Blob::Ptr& InferenceEngine::I420Blob::v ( ) const
noexcept

Returns a constant reference to shared pointer to V plane.

Please note that reference to Blob::Ptr is returned. I.e. the reference will be valid until the I420Blob object is destroyed.

Returns
constant reference to shared pointer object of V plane

§ y() [1/2]

Blob::Ptr& InferenceEngine::I420Blob::y ( )
noexcept

Returns a reference to shared pointer to Y plane.

Please note that reference to Blob::Ptr is returned. I.e. the reference will be valid until the I420Blob object is destroyed.

Returns
reference to shared pointer object of Y plane

§ y() [2/2]

const Blob::Ptr& InferenceEngine::I420Blob::y ( ) const
noexcept

Returns a constant reference to shared pointer to Y plane.

Please note that reference to Blob::Ptr is returned. I.e. the reference will be valid until the I420Blob object is destroyed.

Returns
constant reference to shared pointer object of Y plane*

The documentation for this class was generated from the following file: