apollo::perception::base::Blob< Dtype > 模板类 参考

A wrapper around SyncedMemory holders serving as the basic computational unit for images, feature maps, etc. 更多...

#include <blob.h>

apollo::perception::base::Blob< Dtype > 的协作图:

Public 成员函数
	Blob ()
	Blob (bool use_cuda_host_malloc)
	Blob (const int num, const int channels, const int height, const int width, const bool use_cuda_host_malloc=false)
	Deprecated; use Blob(const std::vector<int>& shape).
	Blob (const std::vector< int > &shape, const bool use_cuda_host_malloc=false)
	Blob (const Blob &)=delete
void	operator= (const Blob &)=delete
void	Reshape (const int num, const int channels, const int height, const int width)
	Deprecated; use Reshape(const std::vector<int>& shape).
void	Reshape (const std::vector< int > &shape)
	Change the dimensions of the blob, allocating new memory if necessary.
void	ReshapeLike (const Blob &other)
std::string	shape_string () const
const std::vector< int > &	shape () const
int	shape (int index) const
	Returns the dimension of the index-th axis (or the negative index-th axis from the end, if index is negative).
int	num_axes () const
int	count () const
int	count (int start_axis, int end_axis) const
	Compute the volume of a slice; i.e., the product of dimensions among a range of axes.
int	count (int start_axis) const
	Compute the volume of a slice spanning from a particular first axis to the final axis.
int	CanonicalAxisIndex (int axis_index) const
	create RoI Blob.
int	num () const
	Deprecated legacy shape accessor num: use shape(0) instead.
int	channels () const
	Deprecated legacy shape accessor channels: use shape(1) instead.
int	height () const
	Deprecated legacy shape accessor height: use shape(2) instead.
int	width () const
	Deprecated legacy shape accessor width: use shape(3) instead.
int	LegacyShape (int index) const
int	offset (const int n, const int c=0, const int h=0, const int w=0) const
int	offset (const std::vector< int > &indices) const
void	CopyFrom (const Blob< Dtype > &source, bool reshape=false)
	Copy from a source Blob.
Dtype	data_at (const int n, const int c, const int h, const int w) const
Dtype	data_at (const std::vector< int > &index) const
const std::shared_ptr< SyncedMemory > &	data () const
const Dtype *	cpu_data () const
void	set_cpu_data (Dtype *data)
const int *	gpu_shape () const
const Dtype *	gpu_data () const
void	set_gpu_data (Dtype *data)
Dtype *	mutable_cpu_data ()
Dtype *	mutable_gpu_data ()
void	set_head_gpu ()
void	set_head_cpu ()
SyncedMemory::SyncedHead	head () const
void	ShareData (const Blob &other)
	Set the data_ std::shared_ptr to point to the SyncedMemory holding the data_ of Blob other – useful in Layers which simply perform a copy in their Forward pass.

Protected 属性
std::shared_ptr< SyncedMemory >	data_
std::shared_ptr< SyncedMemory >	shape_data_
std::vector< int >	shape_
int	count_
int	capacity_
bool	use_cuda_host_malloc_

详细描述

template<typename Dtype>
class apollo::perception::base::Blob< Dtype >

A wrapper around SyncedMemory holders serving as the basic computational unit for images, feature maps, etc.

TODO(dox): more thorough description.

在文件 blob.h 第 88 行定义.

构造及析构函数说明

Blob() [1/5]

template<typename Dtype >

apollo::perception::base::Blob< Dtype >::Blob ( )

inline

在文件 blob.h 第 90 行定义.

: data_(), count_(0), capacity_(0), use_cuda_host_malloc_(false) {}

Blob() [2/5]

template<typename Dtype >

apollo::perception::base::Blob< Dtype >::Blob ( bool  use_cuda_host_malloc )

inlineexplicit

在文件 blob.h 第 91 行定义.

      : data_(),
        count_(0),
        capacity_(0),
        use_cuda_host_malloc_(use_cuda_host_malloc) {}

Blob() [3/5]

template<typename Dtype >

apollo::perception::base::Blob< Dtype >::Blob	(	const int	num,
		const int	channels,
		const int	height,
		const int	width,
		const bool	use_cuda_host_malloc = false
	)

Deprecated; use Blob(const std::vector<int>& shape).

在文件 blob.cc 第 115 行定义.

    : capacity_(0), use_cuda_host_malloc_(use_cuda_host_malloc) {
  Reshape(num, channels, height, width);
}

Blob() [4/5]

template<typename Dtype >

apollo::perception::base::Blob< Dtype >::Blob ( const std::vector< int > &  shape, const bool  use_cuda_host_malloc = false  )

explicit

在文件 blob.cc 第 123 行定义.

    : capacity_(0), use_cuda_host_malloc_(use_cuda_host_malloc) {
  Reshape(shape);
}

Blob() [5/5]

template<typename Dtype >

apollo::perception::base::Blob< Dtype >::Blob ( const Blob< Dtype > &  )

delete

成员函数说明

CanonicalAxisIndex()

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::CanonicalAxisIndex ( int  axis_index ) const

inline

create RoI Blob.

参数

roi_begin	begin of roi
roi_end	end of roi

Returns the 'canonical' version of a (usually) user-specified axis, allowing for negative indexing (e.g., -1 for the last axis).

参数

axis_index

the axis index. If 0 <= index < num_axes(), return index. If -num_axes <= index <= -1, return (num_axes() - (-index)), e.g., the last axis index (num_axes() - 1) if index == -1, the second to last if index == -2, etc. Dies on out of range index.

在文件 blob.h 第 196 行定义.

                                                      {
    CHECK_GE(axis_index, -num_axes())
        << "axis " << axis_index << " out of range for " << num_axes()
        << "-D Blob with shape " << shape_string();
    CHECK_LT(axis_index, num_axes())
        << "axis " << axis_index << " out of range for " << num_axes()
        << "-D Blob with shape " << shape_string();
    if (axis_index < 0) {
      return axis_index + num_axes();
    }
    return axis_index;
  }

channels()

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::channels ( ) const

inline

Deprecated legacy shape accessor channels: use shape(1) instead.

在文件 blob.h 第 212 行定义.

{ return LegacyShape(1); }

CopyFrom()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::CopyFrom	(	const Blob< Dtype > &	source,
		bool	reshape = false
	)

Copy from a source Blob.

参数

source	the Blob to copy from
reshape	if false, require this Blob to be pre-shaped to the shape of other (and die otherwise); if true, Reshape this Blob to other's shape if necessary

count() [1/3]

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::count ( ) const

inline

在文件 blob.h 第 143 行定义.

{ return count_; }

count() [2/3]

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::count ( int  start_axis ) const

inline

Compute the volume of a slice spanning from a particular first axis to the final axis.

参数

start_axis

The first axis to include in the slice.

在文件 blob.h 第 171 行定义.

                                         {
    return count(start_axis, num_axes());
  }

count() [3/3]

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::count ( int  start_axis, int  end_axis  ) const

inline

Compute the volume of a slice; i.e., the product of dimensions among a range of axes.

参数

start_axis	The first axis to include in the slice.
end_axis	The first axis to exclude from the slice.

在文件 blob.h 第 153 行定义.

                                                       {
    CHECK_LE(start_axis, end_axis);
    CHECK_GE(start_axis, 0);
    CHECK_GE(end_axis, 0);
    CHECK_LE(start_axis, num_axes());
    CHECK_LE(end_axis, num_axes());
    int count = 1;
    for (int i = start_axis; i < end_axis; ++i) {
      count *= shape(i);
    }
    return count;
  }

cpu_data()

template<typename Dtype >

const Dtype * apollo::perception::base::Blob< Dtype >::cpu_data

(

)

const

在文件 blob.cc 第 137 行定义.

                                         {
  ACHECK(data_);
  return (const Dtype*)data_->cpu_data();
}

data()

template<typename Dtype >

const std::shared_ptr< SyncedMemory > & apollo::perception::base::Blob< Dtype >::data ( ) const

inline

在文件 blob.h 第 276 行定义.

                                                         {
    ACHECK(data_);
    return data_;
  }

data_at() [1/2]

template<typename Dtype >

Dtype apollo::perception::base::Blob< Dtype >::data_at ( const int  n, const int  c, const int  h, const int  w  ) const

inline

在文件 blob.h 第 267 行定义.

                                          {
    return cpu_data()[offset(n, c, h, w)];
  }

data_at() [2/2]

template<typename Dtype >

Dtype apollo::perception::base::Blob< Dtype >::data_at ( const std::vector< int > &  index ) const

inline

在文件 blob.h 第 272 行定义.

                                                          {
    return cpu_data()[offset(index)];
  }

gpu_data()

template<typename Dtype >

const Dtype * apollo::perception::base::Blob< Dtype >::gpu_data

(

)

const

在文件 blob.cc 第 154 行定义.

                                         {
  ACHECK(data_);
  return (const Dtype*)data_->gpu_data();
}

gpu_shape()

template<typename Dtype >

const int * apollo::perception::base::Blob< Dtype >::gpu_shape

(

)

const

在文件 blob.cc 第 131 行定义.

                                        {
  ACHECK(shape_data_);
  return (const int*)shape_data_->gpu_data();
}

head()

template<typename Dtype >

SyncedMemory::SyncedHead apollo::perception::base::Blob< Dtype >::head ( ) const

inline

在文件 blob.h 第 290 行定义.

{ return data_->head(); }

height()

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::height ( ) const

inline

Deprecated legacy shape accessor height: use shape(2) instead.

在文件 blob.h 第 214 行定义.

{ return LegacyShape(2); }

LegacyShape()

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::LegacyShape ( int  index ) const

inline

在文件 blob.h 第 217 行定义.

                                          {
    CHECK_LE(num_axes(), 4)
        << "Cannot use legacy accessors on Blobs with > 4 axes.";
    CHECK_LT(index, 4);
    CHECK_GE(index, -4);
    if (index >= num_axes() || index < -num_axes()) {
      // Axis is out of range, but still in [0, 3] (or [-4, -1] for reverse
      // indexing) -- this special case simulates the one-padding used to fill
      // extraneous axes of legacy blobs.
      return 1;
    }
    return shape(index);
  }

mutable_cpu_data()

template<typename Dtype >

Dtype * apollo::perception::base::Blob< Dtype >::mutable_cpu_data

(

)

在文件 blob.cc 第 171 行定义.

                                     {
  ACHECK(data_);
  return static_cast<Dtype*>(data_->mutable_cpu_data());
}

mutable_gpu_data()

template<typename Dtype >

Dtype * apollo::perception::base::Blob< Dtype >::mutable_gpu_data

(

)

在文件 blob.cc 第 177 行定义.

                                     {
  ACHECK(data_);
  return static_cast<Dtype*>(data_->mutable_gpu_data());
}

num()

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::num ( ) const

inline

Deprecated legacy shape accessor num: use shape(0) instead.

在文件 blob.h 第 210 行定义.

{ return LegacyShape(0); }

num_axes()

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::num_axes ( ) const

inline

在文件 blob.h 第 142 行定义.

{ return static_cast<int>(shape_.size()); }

offset() [1/2]

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::offset ( const int  n, const int  c = 0, const int  h = 0, const int  w = 0  ) const

inline

在文件 blob.h 第 231 行定义.

                                           {
    CHECK_GE(n, 0);
    CHECK_LE(n, num());
    CHECK_GE(channels(), 0);
    CHECK_LE(c, channels());
    CHECK_GE(height(), 0);
    CHECK_LE(h, height());
    CHECK_GE(width(), 0);
    CHECK_LE(w, width());
    return ((n * channels() + c) * height() + h) * width() + w;
  }

offset() [2/2]

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::offset ( const std::vector< int > &  indices ) const

inline

在文件 blob.h 第 244 行定义.

                                                         {
    CHECK_LE(indices.size(), static_cast<size_t>(num_axes()));
    int offset = 0;
    for (int i = 0; i < num_axes(); ++i) {
      offset *= shape(i);
      if (static_cast<int>(indices.size()) > i) {
        CHECK_GE(indices[i], 0);
        CHECK_LT(indices[i], shape(i));
        offset += indices[i];
      }
    }
    return offset;
  }

operator=()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::operator= ( const Blob< Dtype > &  )

delete

Reshape() [1/2]

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::Reshape	(	const int	num,
		const int	channels,
		const int	height,
		const int	width
	)

Deprecated; use Reshape(const std::vector<int>& shape).

在文件 blob.cc 第 72 行定义.

                                           {
  std::vector<int> shape(4);
  shape[0] = num;
  shape[1] = channels;
  shape[2] = height;
  shape[3] = width;
  Reshape(shape);
}

Reshape() [2/2]

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::Reshape

(

const std::vector< int > &

shape

)

Change the dimensions of the blob, allocating new memory if necessary.

This function can be called both to create an initial allocation of memory, and to adjust the dimensions of a top blob during Layer::Reshape or Layer::Forward. When changing the size of blob, memory will only be reallocated if sufficient memory does not already exist, and excess memory will never be freed.

Note that reshaping an input blob and immediately calling Net::Backward is an error; either Net::Forward or Net::Reshape need to be called to propagate the new input shape to higher layers.

在文件 blob.cc 第 83 行定义.

                                                     {
  CHECK_LE(shape.size(), kMaxBlobAxes);
  count_ = 1;
  shape_.resize(shape.size());
  if (!shape_data_ || shape_data_->size() < shape.size() * sizeof(int)) {
    shape_data_.reset(
        new SyncedMemory(shape.size() * sizeof(int), use_cuda_host_malloc_));
  }
  int* shape_data = static_cast<int*>(shape_data_->mutable_cpu_data());
  for (size_t i = 0; i < shape.size(); ++i) {
    CHECK_GE(shape[i], 0);
    if (count_ != 0) {
      CHECK_LE(shape[i], std::numeric_limits<int>::max() / count_)
          << "blob size exceeds std::numeric_limits<int>::max()";
    }
    count_ *= shape[i];
    shape_[i] = shape[i];
    shape_data[i] = shape[i];
  }
  if (count_ > capacity_) {
    capacity_ = count_;
    data_.reset(
        new SyncedMemory(capacity_ * sizeof(Dtype), use_cuda_host_malloc_));
  }
}

ReshapeLike()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::ReshapeLike

(

const Blob< Dtype > &

other

)

在文件 blob.cc 第 110 行定义.

                                                      {
  Reshape(other.shape());
}

set_cpu_data()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::set_cpu_data

(

Dtype *

data

)

在文件 blob.cc 第 143 行定义.

                                          {
  ACHECK(data);
  // Make sure CPU and GPU sizes remain equal
  size_t size = count_ * sizeof(Dtype);
  if (data_->size() != size) {
    data_.reset(new SyncedMemory(size, use_cuda_host_malloc_));
  }
  data_->set_cpu_data(data);
}

set_gpu_data()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::set_gpu_data

(

Dtype *

data

)

在文件 blob.cc 第 160 行定义.

                                          {
  ACHECK(data);
  // Make sure CPU and GPU sizes remain equal
  size_t size = count_ * sizeof(Dtype);
  if (data_->size() != size) {
    data_.reset(new SyncedMemory(size, use_cuda_host_malloc_));
  }
  data_->set_gpu_data(data);
}

set_head_cpu()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::set_head_cpu ( )

inline

在文件 blob.h 第 289 行定义.

{ data_->set_head_cpu(); }

set_head_gpu()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::set_head_gpu ( )

inline

在文件 blob.h 第 288 行定义.

{ data_->set_head_gpu(); }

shape() [1/2]

template<typename Dtype >

const std::vector< int > & apollo::perception::base::Blob< Dtype >::shape ( ) const

inline

在文件 blob.h 第 130 行定义.

{ return shape_; }

shape() [2/2]

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::shape ( int  index ) const

inline

Returns the dimension of the index-th axis (or the negative index-th axis from the end, if index is negative).

参数

index

the axis index, which may be negative as it will be "canonicalized" using CanonicalAxisIndex. Dies on out of range index.

在文件 blob.h 第 139 行定义.

                                    {
    return shape_[CanonicalAxisIndex(index)];
  }

shape_string()

template<typename Dtype >

std::string apollo::perception::base::Blob< Dtype >::shape_string ( ) const

inline

在文件 blob.h 第 125 行定义.

                                        {
    return shape_.empty()
               ? absl::StrCat("(", count_, ")")
               : absl::StrCat(absl::StrJoin(shape_, " "), " (", count_, ")");
  }

ShareData()

template<typename Dtype >

void apollo::perception::base::Blob< Dtype >::ShareData

(

const Blob< Dtype > &

other

)

Set the data_ std::shared_ptr to point to the SyncedMemory holding the data_ of Blob other – useful in Layers which simply perform a copy in their Forward pass.

This deallocates the SyncedMemory holding this Blob's data_, as std::shared_ptr calls its destructor when reset with the "=" operator.

在文件 blob.cc 第 183 行定义.

                                             {
  CHECK_EQ(count_, other.count());
  data_ = other.data();
}

width()

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::width ( ) const

inline

Deprecated legacy shape accessor width: use shape(3) instead.

在文件 blob.h 第 216 行定义.

{ return LegacyShape(3); }

类成员变量说明

capacity_

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::capacity_

protected

在文件 blob.h 第 308 行定义.

count_

template<typename Dtype >

int apollo::perception::base::Blob< Dtype >::count_

protected

在文件 blob.h 第 307 行定义.

data_

template<typename Dtype >

std::shared_ptr<SyncedMemory> apollo::perception::base::Blob< Dtype >::data_

protected

在文件 blob.h 第 304 行定义.

shape_

template<typename Dtype >

std::vector<int> apollo::perception::base::Blob< Dtype >::shape_

protected

在文件 blob.h 第 306 行定义.

shape_data_

template<typename Dtype >

std::shared_ptr<SyncedMemory> apollo::perception::base::Blob< Dtype >::shape_data_

protected

在文件 blob.h 第 305 行定义.

use_cuda_host_malloc_

template<typename Dtype >

bool apollo::perception::base::Blob< Dtype >::use_cuda_host_malloc_

protected

在文件 blob.h 第 309 行定义.

---

该类的文档由以下文件生成:

• modules/perception/common/base/blob.h
• modules/perception/common/base/blob.cc