Mech-Eye API Reference 2.1.4-alpha
API reference documentation for Mech-Eye 3D Laser Profiler
All Classes Functions Variables Enumerations Enumerator Pages
Public Types | Public Member Functions | Friends | List of all members
mmind::eye::ProfileBatch Class Reference

Represents a batch of profiles. 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

MMIND_API_EXPORT ProfileBatch (size_t width)
 Constructor with parameter.
 
MMIND_API_EXPORT ~ProfileBatch ()=default
 Default destructor.
 
MMIND_API_EXPORT size_t width () const
 Returns the width of the ProfileBatch object (number of data points per profile).
 
MMIND_API_EXPORT size_t height () const
 Returns the height of the ProfileBatch object (number of profiles in the batch).
 
MMIND_API_EXPORT bool isEmpty () const
 Checks if the ProfileBatch object has no elements.
 
MMIND_API_EXPORT void reserve (size_t height)
 Reserves the input height for the ProfileBatch object.
 
MMIND_API_EXPORT void append (const ProfileBatch &batch)
 Appends the data of one ProfileBatch object to another.
 
MMIND_API_EXPORT void clear ()
 Clears the data in the ProfileBatch object.
 
MMIND_API_EXPORT Profile getProfile (size_t profileIndex) const
 Gets a profile in the batch by inputting the index of the profile.
 
MMIND_API_EXPORT ProfileIndexArray getProfileIndexArray () const
 Gets an array of indices of all profiles in the batch.
 
MMIND_API_EXPORT EncoderArray getEncoderArray () const
 Gets an array of encoder values of all profiles in the batch.
 
MMIND_API_EXPORT IntensityImage getIntensityImage () const
 Gets the intensity image data in the batch.
 
MMIND_API_EXPORT DepthMap getDepthMap () const
 Gets the depth map data in the batch.
 
MMIND_API_EXPORT ErrorStatus getErrorStatus () const
 Gets the error code and description of the function.
 

Friends

class ProfilerImpl
 

Detailed Description

Represents a batch of profiles.

Definition at line 26 of file ProfileData.h.

Member Typedef Documentation

◆ DepthMap

Definition at line 32 of file ProfileData.h.

◆ EncoderArray

Definition at line 30 of file ProfileData.h.

◆ IntensityImage

Definition at line 31 of file ProfileData.h.

◆ ProfileIndexArray

Definition at line 29 of file ProfileData.h.

Friends And Related Symbol Documentation

◆ ProfilerImpl

friend class ProfilerImpl
friend

Definition at line 105 of file ProfileData.h.


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