Skip to content

Class cuvis::Measurement

ClassList > cuvis > Measurement

central measurement class

  • #include <cuvis.hpp>

Public Types

Type Name
typedef std::map< std::string, cuvis_gps_t > gps_data_t
typedef std::map< std::string, image_variant_t > image_data_t
typedef std::variant< image_t< std::uint8_t >, image_t< std::uint16_t >, image_t< std::uint32_t >, image_t< float > > image_variant_t
typedef std::map< std::string, SensorInfoData > sensor_info_data_t
typedef std::map< std::string, std::string > string_data_t

Public Functions

Type Name
Measurement (Measurement && measurement) = default
Measurement (Measurement const & source)
Measurement (std::filesystem::path const & path)
Measurement (CUVIS_MESU handle)
Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well.
void clear_cube ()
clears the cube from the measurement
void clear_implicit_reference (reference_type_t type)
Clear the implicit reference measurement.
std::string get_calib_id () const
get calibration id of this measurement
std::vector< capabilities_t > get_capabilities () const
Get the capabilites of the measurement which were present in the calibration during capture. This doesn't indicate which capabilities are currently available for the measurement.
gps_data_t const * get_gps () const
Get GPS data from measurement.
CUVIS_MESU get_handle () const
Expert: Return the current handle of the wrapper class.
CUVIS_MESU get_handle_copy () const
Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk.
image_data_t const * get_imdata () const
Get image data from measurement.
MeasurementMetaData const * get_meta () const
Get the metadata of the measurement.
sensor_info_data_t const * get_sensor_info () const
Get image info data from measurement.
string_data_t const * get_strdata () const
Get string data from measurement.
image_t< std::uint8_t > const * get_thumbnail () const
Get thumbnail / preview image of measurement.
Measurement & operator= (Measurement const & measurement) = default
void refresh ()
Resynchronize the Measurement with the SDK data.
void save (SaveArgs const & args)
Save measurement.
void set_comment (std::string const & comment)
set comment of measurement
void set_name (std::string const & name)
Set name of measurement.

Public Types Documentation

typedef gps_data_t

using cuvis::Measurement::gps_data_t =  std::map<std::string, cuvis_gps_t>;

typedef image_data_t

using cuvis::Measurement::image_data_t =  std::map<std::string, image_variant_t>;

typedef image_variant_t

using cuvis::Measurement::image_variant_t =  std::variant<image_t<std::uint8_t>, image_t<std::uint16_t>, image_t<std::uint32_t>, image_t<float> >;

typedef sensor_info_data_t

using cuvis::Measurement::sensor_info_data_t =  std::map<std::string, SensorInfoData>;

typedef string_data_t

using cuvis::Measurement::string_data_t =  std::map<std::string, std::string>;

Public Functions Documentation

function Measurement [1/4]

cuvis::Measurement::Measurement (
    Measurement && measurement
) = default

function Measurement [2/4]

cuvis::Measurement::Measurement (
    Measurement  const & source
)

function Measurement [3/4]

cuvis::Measurement::Measurement (
    std::filesystem::path const & path
)

function Measurement [4/4]

Expert: Create a wrapper class around a handle. This only allowed once per handle, otherwise the handle could be freed before all instances of the wrapper class are deleted. This can be useful if a previously a handle has been copied and now should be wrapped at another place in a program. Most of the time this is not necesarry and the wrapper class can be copied just as well. 

cuvis::Measurement::Measurement (
    CUVIS_MESU handle
)

function clear_cube

clears the cube from the measurement 

void cuvis::Measurement::clear_cube ()

Clears the proceessing result, i. e. the cube, from the measurement. This returns the measurement the state before applying the processing. This can be usefull for reduced data usage.

function clear_implicit_reference

Clear the implicit reference measurement. 

void cuvis::Measurement::clear_implicit_reference (
    reference_type_t type
)

Implict measurements are created, when a measurement is processed with a processing context, where explicit references are set. Then, these references are remebemred by the measurement. When changing the processing context, the references are implicitly available, still. Clearing them may be interesing if the references set are wrong/invalid or if disk space is a concearn.

Parameters:

  • type Type of reference to clear

function get_calib_id

get calibration id of this measurement 

std::string cuvis::Measurement::get_calib_id () const

function get_capabilities

Get the capabilites of the measurement which were present in the calibration during capture. This doesn't indicate which capabilities are currently available for the measurement. 

std::vector< capabilities_t > cuvis::Measurement::get_capabilities () const

function get_gps

Get GPS data from measurement. 

inline gps_data_t  const * cuvis::Measurement::get_gps () const

function get_handle

Expert: Return the current handle of the wrapper class. 

CUVIS_MESU cuvis::Measurement::get_handle () const

function get_handle_copy

Expert: Create a copy of the current handle of the wrapper class and return it. This handle needs to be also freed before the resource will be released by the sdk. 

CUVIS_MESU cuvis::Measurement::get_handle_copy () const

function get_imdata

Get image data from measurement. 

inline image_data_t  const * cuvis::Measurement::get_imdata () const

Return image data from measurement.

function get_meta

Get the metadata of the measurement. 

MeasurementMetaData  const * cuvis::Measurement::get_meta () const

The meta-data from the measurement contains information about the measurement when it was recorded: when and how. Meta-Data do not contain the actual recorded data.

function get_sensor_info

Get image info data from measurement. 

sensor_info_data_t  const * cuvis::Measurement::get_sensor_info () const

Return image data from a measurement.

function get_strdata

Get string data from measurement. 

inline string_data_t  const * cuvis::Measurement::get_strdata () const

function get_thumbnail

Get thumbnail / preview image of measurement. 

image_t < std::uint8_t > const * cuvis::Measurement::get_thumbnail () const

function operator=

Measurement & cuvis::Measurement::operator= (
    Measurement  const & measurement
) = default

function refresh

Resynchronize the Measurement with the SDK data. 

void cuvis::Measurement::refresh ()

usally this does not have to be called manually, but is rather called internally by any operation that may result in invalidated (meta-)data

function save

Save measurement. 

void cuvis::Measurement::save (
    SaveArgs  const & args
)

Save the measurement with given arguments

Parameters:

  • args The Save Arguments to use for saving the measurement. See also SaveArgs

function set_comment

set comment of measurement 

void cuvis::Measurement::set_comment (
    std::string const & comment
)

Parameters:

  • comment String to use as comment for the measurement

function set_name

Set name of measurement. 

void cuvis::Measurement::set_name (
    std::string const & name
)

Parameters:

  • name String to use as name of the measuremen

Friends Documentation

friend AcquisitionContext

class cuvis::Measurement::AcquisitionContext (
    AcquisitionContext
)

friend AsyncMesu

class cuvis::Measurement::AsyncMesu (
    AsyncMesu
)

friend Exporter

class cuvis::Measurement::Exporter (
    Exporter
)

friend ProcessingContext

class cuvis::Measurement::ProcessingContext (
    ProcessingContext
)

friend SessionFile

class cuvis::Measurement::SessionFile (
    SessionFile
)

friend Viewer

class cuvis::Measurement::Viewer (
    Viewer
)

friend Worker

class cuvis::Measurement::Worker (
    Worker
)

The documentation for this class was generated from the following file cuvis.cpp/interface/cuvis.hpp