dl::V2::IImage Class Reference

#include <dlapi.h>

Inheritance diagram for dl::V2::IImage:

Classes
class	IMetadataKey

Public Member Functions
virtual bool	hasMetadataKeys () const =0
	Checks if the image has any metadata keys associated with it.
virtual size_t	getMetadataKeyCount () const =0
	Returns the number of metadata keys associated with the image.
virtual IMetadataKey *	getMetadataKey (size_t index) const =0
	Returns the metadata key at the specified index.
virtual IMetadataKey *	getMetadataKey (const char *key) const =0
	Returns the metadata key by key string.
Public Member Functions inherited from dl::IImageExt
virtual size_t	getLayerCount () const =0
virtual TLayerMetadata	getLayerMetadata (unsigned int layer) const =0
virtual void	getExpMidpoint (char *pBuffer, size_t &lng) const =0

Member Function Documentation

getMetadataKey() [1/2]

virtual IMetadataKey * dl::V2::IImage::getMetadataKey ( const char * key ) const

pure virtual

Returns the metadata key by key string.

Parameters

index

The key string of the metadata key to retrieve.

Returns

A pointer to the metadata key, or nullptr if the index doesn't exist.

This function retrieves the metadata key at the given key string. If the key doesn't exist, it returns nullptr.

example usage:

++
              if (auto pKey = pImage->getMetadataKey("DATE-GPS")) {
                 std::cout << "GPS Date: " << pKey->asString() << std::endl;
              }
              
              // Retrieve the eGain value from the metadata
              // Note: eGain is a floating-point value, so we use asDouble() to retrieve it.
              if (auto pKey = pImage->getMetadataKey("EGAIN")) {
                std::cout << "eGain: " << pKey->asDouble() << std::endl;
              }

getMetadataKey() [2/2]

virtual IMetadataKey * dl::V2::IImage::getMetadataKey ( size_t index ) const

pure virtual

Returns the metadata key at the specified index.

Parameters

index

The index of the metadata key to retrieve.

Returns

A pointer to the metadata key, or nullptr if the index doesn't exist.

This function retrieves the metadata key at the given index. If the index is out of bounds, it returns nullptr.

getMetadataKeyCount()

virtual size_t dl::V2::IImage::getMetadataKeyCount ( ) const

pure virtual

Returns the number of metadata keys associated with the image.

Returns

The count of metadata keys.

This function returns the total number of metadata keys available for the image.

hasMetadataKeys()

virtual bool dl::V2::IImage::hasMetadataKeys ( ) const

pure virtual

Checks if the image has any metadata keys associated with it.

Returns

true if metadata keys are present, false otherwise.

This function checks if the image has any metadata keys associated with it. If there are no metadata keys, it returns false. If there are metadata keys, it returns true.

---

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

• C:/Users/arobi/Perforce/nightly/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h