Mech-Eye API 2.3.3
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
mmind::eye::ProfileBatch Class Reference

Represents a batch of profiles, which can be obtained by calling Profiler::retrieveBatchData(). It contains four elements of profile index, encoder value, intensity image, and depth map. More...

#include <ProfileData.h>

Public Types

using ProfileIndexArray = BatchArray<unsigned int>
 
using EncoderArray = BatchArray<unsigned int>
 
using IntensityImage = BatchArray<unsigned char>
 
using DepthMap = BatchArray<float>
 

Public Member Functions

 ProfileBatch (size_t width)
 Constructor.
 
 ~ProfileBatch ()=default
 Default destructor.
 
size_t width () const
 Returns the width of the ProfileBatch object (the number of data points per profile).
 
size_t height () const
 Returns the height of the ProfileBatch object (the number of profiles in the batch).
 
bool isEmpty () const
 Checks if the ProfileBatch object has no elements.
 
void reserve (size_t height)
 Reserves the input height for the ProfileBatch object.
 
bool append (const ProfileBatch &batch)
 Appends the data of one ProfileBatch object to another.
 
void clear ()
 Clears the data in the ProfileBatch object.
 
Profile getProfile (size_t profileIndex) const
 Gets a profile in the batch by inputting the index of the profile.
 
ProfileIndexArray getProfileIndexArray () const
 Gets an array of indices of all profiles in the batch. Each profile data corresponds to an index.
 
EncoderArray getEncoderArray () const
 Gets an array of encoder values of all profiles in the batch. Each profile data corresponds to an encoder value.
 
IntensityImage getIntensityImage () const
 Gets the intensity image data in the batch. The invalid data of intensity image is 0.
 
DepthMap getDepthMap () const
 Gets the depth map data in the batch. Each point in DepthMap contains the Z information in the laser profiler coordinate system. The depth data unit is mm, and invalid data is nan.
 
ErrorStatus getErrorStatus () const
 Gets the error code and description of the function.
 

Friends

class ProfilerImpl
 
class VirtualProfilerImpl
 

Detailed Description

Represents a batch of profiles, which can be obtained by calling Profiler::retrieveBatchData(). It contains four elements of profile index, encoder value, intensity image, and depth map.

Definition at line 29 of file ProfileData.h.

Member Typedef Documentation

◆ DepthMap

Definition at line 35 of file ProfileData.h.

◆ EncoderArray

Definition at line 33 of file ProfileData.h.

◆ IntensityImage

Definition at line 34 of file ProfileData.h.

◆ ProfileIndexArray

Definition at line 32 of file ProfileData.h.

Friends And Related Symbol Documentation

◆ ProfilerImpl

friend class ProfilerImpl
friend

Definition at line 112 of file ProfileData.h.

◆ VirtualProfilerImpl

friend class VirtualProfilerImpl
friend

Definition at line 113 of file ProfileData.h.


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