Blender V5.0
Public Member Functions | List of all members
libmv::Array3D< T > Class Template Reference

3D array (row, column, channel). More...

#include <array_nd.h>

Inherits libmv::ArrayND< T, 3 >.

Public Member Functions

 Array3D ()
 Array3D (int height, int width, int depth=1)
 Array3D (T *data, int height, int width, int depth=1)
void Resize (int height, int width, int depth=1)
int Height () const
int Width () const
int Depth () const
int rows () const
int cols () const
int depth () const
int Get_Step () const
T & operator() (int i0, int i1, int i2=0)
 Enable accessing with 2 indices for grayscale images.
const T & operator() (int i0, int i1, int i2=0) const
Public Member Functions inherited from libmv::ArrayND< T, 3 >
 ArrayND ()
 Create an empty array.
 ArrayND (const Index &shape)
 Create an array with the specified shape.
 ArrayND (int *shape)
 Create an array with the specified shape.
 ArrayND (const ArrayND< T, N > &b)
 Copy constructor.
 ArrayND (int s0)
 ArrayND (int s0, int s1)
 ArrayND (int s0, int s1, int s2)
 ArrayND (T *data, int s0, int s1, int s2)
 ~ArrayND ()
 Destructor deletes pixel data.
ArrayND & operator= (const ArrayND< T, N > &b)
 Assignation copies pixel data.
const Index & Shapes () const
const Index & Strides () const
void Resize (const Index &new_shape)
 Create an array of shape s.
void ResizeLike (const ArrayND< D, N > &other)
void Resize (const int *new_shape_array)
 Resizes the array to shape s. All data is lost.
void Resize (int s0)
 Resize a 1D array to length s0.
void Resize (int s0, int s1)
 Resize a 2D array to shape (s0,s1).
void resize (int rows, int cols)
void Resize (int s0, int s1, int s2)
 Resize a 3D array to shape (s0,s1,s2).
void CopyFrom (const ArrayND< D, N > &other)
void Fill (T value)
void fill (T value)
const Index & Shape () const
 Return a tuple containing the length of each axis.
int Shape (int axis) const
 Return the length of an axis.
int Stride (int axis) const
 Return the distance between neighboring elements along axis.
int Size () const
 Return the number of elements of the array.
int MemorySizeInBytes () const
 Return the total amount of memory used by the array.
T * Data ()
 Pointer to the first element of the array.
const T * Data () const
 Constant pointer to the first element of the array.
int Offset (const Index &index) const
 Distance between the first element and the element at position index.
int Offset (int i0) const
 1D specialization.
int Offset (int i0, int i1) const
 2D specialization.
int Offset (int i0, int i1, int i2) const
 3D specialization.
T & operator() (const Index &index)
 Return a reference to the element at position index.
T & operator() (int i0)
 1D specialization.
T & operator() (int i0, int i1)
 2D specialization.
T & operator() (int i0, int i1, int i2)
 3D specialization.
const T & operator() (const Index &index) const
 Return a constant reference to the element at position index.
const T & operator() (int i0) const
 1D specialization.
const T & operator() (int i0, int i1) const
 2D specialization.
const T & operator() (int i0, int i1, int i2) const
 3D specialization.
bool Contains (const Index &index) const
 True if index is inside array.
bool Contains (int i0) const
 1D specialization.
bool Contains (int i0, int i1) const
 2D specialization.
bool Contains (int i0, int i1, int i2) const
 3D specialization.
bool operator== (const ArrayND< T, N > &other) const
bool operator!= (const ArrayND< T, N > &other) const
ArrayND< T, N > operator* (const ArrayND< T, N > &other) const
 ArrayND ()
 Create an empty array.
 ArrayND (const Index &shape)
 Create an array with the specified shape.
 ArrayND (int *shape)
 Create an array with the specified shape.
 ArrayND (const ArrayND< T, N > &b)
 Copy constructor.
 ArrayND (int s0)
 ArrayND (int s0, int s1)
 ArrayND (int s0, int s1, int s2)
 ArrayND (T *data, int s0, int s1, int s2)
 ~ArrayND ()
 Destructor deletes pixel data.
ArrayND & operator= (const ArrayND< T, N > &b)
 Assignation copies pixel data.
const Index & Shapes () const
const Index & Strides () const
void Resize (const Index &new_shape)
 Create an array of shape s.
void Resize (const int *new_shape_array)
 Resizes the array to shape s. All data is lost.
void Resize (int s0)
 Resize a 1D array to length s0.
void Resize (int s0, int s1)
 Resize a 2D array to shape (s0,s1).
void Resize (int s0, int s1, int s2)
 Resize a 3D array to shape (s0,s1,s2).
void ResizeLike (const ArrayND< D, N > &other)
void resize (int rows, int cols)
void CopyFrom (const ArrayND< D, N > &other)
void Fill (T value)
void fill (T value)
const Index & Shape () const
 Return a tuple containing the length of each axis.
int Shape (int axis) const
 Return the length of an axis.
int Stride (int axis) const
 Return the distance between neighboring elements along axis.
int Size () const
 Return the number of elements of the array.
int MemorySizeInBytes () const
 Return the total amount of memory used by the array.
T * Data ()
 Pointer to the first element of the array.
const T * Data () const
 Constant pointer to the first element of the array.
int Offset (const Index &index) const
 Distance between the first element and the element at position index.
int Offset (int i0) const
 1D specialization.
int Offset (int i0, int i1) const
 2D specialization.
int Offset (int i0, int i1, int i2) const
 3D specialization.
T & operator() (const Index &index)
 Return a reference to the element at position index.
T & operator() (int i0)
 1D specialization.
T & operator() (int i0, int i1)
 2D specialization.
T & operator() (int i0, int i1, int i2)
 3D specialization.
const T & operator() (const Index &index) const
 Return a constant reference to the element at position index.
const T & operator() (int i0) const
 1D specialization.
const T & operator() (int i0, int i1) const
 2D specialization.
const T & operator() (int i0, int i1, int i2) const
 3D specialization.
bool Contains (const Index &index) const
 True if index is inside array.
bool Contains (int i0) const
 1D specialization.
bool Contains (int i0, int i1) const
 2D specialization.
bool Contains (int i0, int i1, int i2) const
 3D specialization.
bool operator== (const ArrayND< T, N > &other) const
bool operator!= (const ArrayND< T, N > &other) const
ArrayND< T, N > operator* (const ArrayND< T, N > &other) const

Additional Inherited Members

Public Types inherited from libmv::ArrayND< T, 3 >
typedef T Scalar
typedef Tuple< int, N > Index
 Type for the multidimensional indices.
Protected Attributes inherited from libmv::ArrayND< T, 3 >
Index shape_
 The number of element in each dimension.
Index strides_
 How to jump to neighbors in each dimension.
T * data_
 Pointer to the first element of the array.
bool own_data_
 Flag if this Array either own or reference the data.
Index shape_
 The number of element in each dimension.
Index strides_
 How to jump to neighbors in each dimension.
T * data_
 Pointer to the first element of the array.
bool own_data_
 Flag if this Array either own or reference the data.

Detailed Description

template<typename T>
class libmv::Array3D< T >

3D array (row, column, channel).

Definition at line 332 of file array_nd.h.

Constructor & Destructor Documentation

◆ Array3D() [1/3]

template<typename T>
libmv::Array3D< T >::Array3D ( )
inline

Definition at line 336 of file array_nd.h.

◆ Array3D() [2/3]

template<typename T>
libmv::Array3D< T >::Array3D ( int height,
int width,
int depth = 1 )
inline

Definition at line 337 of file array_nd.h.

◆ Array3D() [3/3]

template<typename T>
libmv::Array3D< T >::Array3D ( T * data,
int height,
int width,
int depth = 1 )
inline

Definition at line 338 of file array_nd.h.

Member Function Documentation

◆ cols()

template<typename T>
int libmv::Array3D< T >::cols ( ) const
inline

Definition at line 352 of file array_nd.h.

Referenced by libmv::RegionIsInBounds().

◆ Depth()

template<typename T>
int libmv::Array3D< T >::Depth ( ) const
inline

Definition at line 347 of file array_nd.h.

Referenced by libmv::ByteArrayToScaledFloatArray(), libmv::Array3D< unsigned char >::depth(), libmv::Detect(), libmv::Array3D< unsigned char >::Get_Step(), libmv_floatImageToByteBuffer(), libmv_floatImageToFloatBuffer(), libmv_saveImage(), libmv::SampleLinear(), libmv::SamplePlanarPatch(), libmv::TEST(), and libmv::TEST().

◆ depth()

template<typename T>
int libmv::Array3D< T >::depth ( ) const
inline

Definition at line 353 of file array_nd.h.

◆ Get_Step()

template<typename T>
int libmv::Array3D< T >::Get_Step ( ) const
inline

Definition at line 355 of file array_nd.h.

◆ Height()

template<typename T>
int libmv::Array3D< T >::Height ( ) const
inline

Definition at line 345 of file array_nd.h.

Referenced by libmv::ByteArrayToScaledFloatArray(), libmv_floatImageToByteBuffer(), libmv_floatImageToFloatBuffer(), libmv_saveImage(), libmv::Array3D< unsigned char >::operator()(), libmv::Array3D< unsigned char >::operator()(), libmv::PearsonProductMomentCorrelation(), libmv::Array3D< unsigned char >::rows(), libmv::SampleLinear(), libmv::SampleLinear(), libmv::TEST(), libmv::TEST(), and libmv::BruteRegionTracker::Track().

◆ operator()() [1/2]

template<typename T>
T & libmv::Array3D< T >::operator() ( int i0,
int i1,
int i2 = 0 )
inline

Enable accessing with 2 indices for grayscale images.

Definition at line 358 of file array_nd.h.

◆ operator()() [2/2]

template<typename T>
const T & libmv::Array3D< T >::operator() ( int i0,
int i1,
int i2 = 0 ) const
inline

Definition at line 363 of file array_nd.h.

◆ Resize()

template<typename T>
void libmv::Array3D< T >::Resize ( int height,
int width,
int depth = 1 )
inline

Definition at line 341 of file array_nd.h.

Referenced by libmv::BlurredImageAndDerivativesChannels(), libmv_byteBufferToFloatImage(), libmv_floatBufferToFloatImage(), libmv::SamplePattern(), libmv::SamplePlanarPatch(), and libmv::SplitChannels().

◆ rows()

template<typename T>
int libmv::Array3D< T >::rows ( ) const
inline

Definition at line 351 of file array_nd.h.

Referenced by libmv::RegionIsInBounds().

◆ Width()

template<typename T>
int libmv::Array3D< T >::Width ( ) const
inline

Definition at line 346 of file array_nd.h.

Referenced by libmv::ByteArrayToScaledFloatArray(), libmv::Array3D< unsigned char >::cols(), libmv::Array3D< unsigned char >::Get_Step(), libmv_floatImageToByteBuffer(), libmv_floatImageToFloatBuffer(), libmv_saveImage(), libmv::Array3D< unsigned char >::operator()(), libmv::Array3D< unsigned char >::operator()(), libmv::PearsonProductMomentCorrelation(), libmv::SampleLinear(), libmv::SampleLinear(), libmv::TEST(), libmv::TEST(), and libmv::BruteRegionTracker::Track().

The documentation for this class was generated from the following file:
Generated on for Blender by  doxygen 1.16.1