hdps::util Namespace Reference

Classes
class	Archiver
class	ColorMap
class	ColorMapFilterModel
class	ColorMapModel
class	Logger
struct	MessageRecord
class	NumericalRange
class	PixelSelectionTool
class	PixelSelectionTypeModel
class	Preset
class	PresetsFilterModel
class	PresetsModel
class	Serializable
class	SmartDataset
class	Version
class	WidgetFader
class	WidgetOverlayer

Typedefs
using	MessageRecordPointers = std::deque< const MessageRecord * >
using	MessageRecords = std::deque< MessageRecord >
using	PixelSelectionTypes = QVector< PixelSelectionType >

Enumerations
enum class	ColorSpaceType {   Mono , Duo , RGB , HSL ,   LAB }
enum class	DockWidgetPermission { MayClose = 0x00 , MayMove = 0x01 , MayFloat = 0x02 , All = MayClose | MayMove | MayFloat }
enum class	InterpolationType { Bilinear , NearestNeighbor }
enum class	PixelSelectionType {   Rectangle , Brush , Lasso , Polygon ,   Sample , ROI }
enum class	PixelSelectionModifierType { Replace , Add , Subtract }
enum class	PresetType { Normal , Global , FactoryDefault }

Functions
QString	loadFileContents (QString path)
bool	ShowFileInFolder (const QString path)
float	lerp (float v0, float v1, float t)
QString	getIntegerCountHumanReadable (const float &count)
QString	getNoBytesHumanReadable (float noBytes)
template<typename ActionType >
void	sortActions (QVector< QPointer< ActionType > > &actions)
template<class WidgetClass >
WidgetClass *	findParent (const QWidget *widget)
QString	getTabIndentedMessage (QString message, const std::uint32_t &tabIndex)
QIcon	getPixelSelectionTypeIcon (const PixelSelectionType &selectionType)
void	saveRawDataToBinaryFile (const char *bytes, const std::uint64_t &numberOfBytes, const QString &filePath)
void	loadRawDataFromBinaryFile (const char *bytes, const std::uint64_t &numberOfBytes, const QString &filePath)
QVariantMap	rawDataToVariantMap (const char *bytes, const std::uint64_t &numberOfBytes, bool saveToDisk, std::uint64_t maxBlockSize)
void	populateDataBufferFromVariantMap (const QVariantMap &variantMap, const char *bytes)
void	variantMapMustContain (const QVariantMap &variantMap, const QString &key)

Typedef Documentation

MessageRecordPointers

using hdps::util::MessageRecordPointers = typedef std::deque<const MessageRecord*>

MessageRecords

using hdps::util::MessageRecords = typedef std::deque<MessageRecord>

PixelSelectionTypes

using hdps::util::PixelSelectionTypes = typedef QVector<PixelSelectionType>

Pixel selection types alias

Enumeration Type Documentation

ColorSpaceType

enum class hdps::util::ColorSpaceType

strong

Color space types enum

Enumerator
Mono
Duo	Single channel
RGB	Double channel
HSL	Red Green Blue
LAB	Hue Saturation Lightness

DockWidgetPermission

enum class hdps::util::DockWidgetPermission

strong

Dock widget permission

Enumerator
MayClose
MayMove	Dock widget may be closed
MayFloat	Dock widget may be moved
All	Dock widget may be floated

InterpolationType

enum class hdps::util::InterpolationType

strong

Interpolation types enum

Enumerator
Bilinear
NearestNeighbor	Bilinear interpolation

PixelSelectionModifierType

enum class hdps::util::PixelSelectionModifierType

strong

Selection modifiers enum

Enumerator
Replace
Add	Replace selection
Subtract	Add to selection Subtract from selection

PixelSelectionType

enum class hdps::util::PixelSelectionType

strong

Pixel selection types enum

Enumerator
Rectangle
Brush	Select pixels within a rectangle
Lasso	A brush is used the paint the pixel selection
Polygon	A lasso tool is used to select pixels
Sample	Select pixels in the interior of a polygon
ROI	Probe one pixel at a time Select all pixels in a ROI

PresetType

enum class hdps::util::PresetType

strong

Preset types enum

Enumerator
Normal
Global	Normal preset
FactoryDefault	Global preset (not coupled to a dataset/plugin etc.) Factory default

Function Documentation

findParent()

template<class WidgetClass >

WidgetClass * hdps::util::findParent

(

const QWidget *

widget

)

Find parent of type WidgetClass

Parameters

widget

Pointer to widget to search for

Returns

Pointer to parent widget of type WidgetClass, otherwise a nullptr

getIntegerCountHumanReadable()

QString hdps::util::getIntegerCountHumanReadable

(

const float &

count

)

Returns a human readable string of an integer count

Parameters

count

Integer count

Returns

Human readable string of an integer count

getNoBytesHumanReadable()

QString hdps::util::getNoBytesHumanReadable

(

float

noBytes

)

Returns a human readable string of a byte count

Parameters

noBytes

Number of bytes

Returns

Human readable string of a byte count

getPixelSelectionTypeIcon()

QIcon hdps::util::getPixelSelectionTypeIcon

(

const PixelSelectionType &

selectionType

)

Get the icon for the specified selection type

Parameters

selectionType

The type of selection e.g. brush rectangle etc.

getTabIndentedMessage()

QString hdps::util::getTabIndentedMessage ( QString  message, const std::uint32_t &  tabIndex  )

inline

Get tabbed (indented) message

Parameters

message	Message to prefix with tab indentation
tabIndex	Number of tabs to prefix with

Returns

Message indented with tabs

lerp()

float hdps::util::lerp	(	float	v0,
		float	v1,
		float	t
	)

loadFileContents()

QString hdps::util::loadFileContents

(

QString

path

)

loadRawDataFromBinaryFile()

void hdps::util::loadRawDataFromBinaryFile	(	const char *	bytes,
		const std::uint64_t &	numberOfBytes,
		const QString &	filePath
	)

Load raw data from binary file on disk

Parameters

bytes	Pointer to input buffer
numberOfBytes	Number of input bytes
filePath	Path of the file on disk

populateDataBufferFromVariantMap()

void hdps::util::populateDataBufferFromVariantMap	(	const QVariantMap &	variantMap,
		const char *	bytes
	)

Convert variant map to raw data

Parameters

variantMap	Variant map containing the data blocks
bytes	Output buffer to which the data is copied

rawDataToVariantMap()

QVariantMap hdps::util::rawDataToVariantMap	(	const char *	bytes,
		const std::uint64_t &	numberOfBytes,
		bool	saveToDisk = false,
		std::uint64_t	maxBlockSize = -1
	)

Convert raw data buffer to variant map (divide up in blocks when the total number of bytes exceeds maxBlockSize)

Parameters

bytes	Pointer to input buffer
numberOfBytes	Number of input bytes
saveToDisk	Whether to save the raw data to disk or inline in the variant
maxBlockSize	Maximum size per block (DEFAULT_MAX_BLOCK_SIZE when maxBlockSize == -1)

saveRawDataToBinaryFile()

void hdps::util::saveRawDataToBinaryFile	(	const char *	bytes,
		const std::uint64_t &	numberOfBytes,
		const QString &	filePath
	)

Save raw data to binary file on disk

Parameters

bytes	Pointer to input buffer
numberOfBytes	Number of input bytes
filePath	Path of the file on disk

ShowFileInFolder()

bool hdps::util::ShowFileInFolder

(

const QString

path

)

sortActions()

template<typename ActionType >

void hdps::util::sortActions

(

QVector< QPointer< ActionType > > &

actions

)

Sort action based on their text

Parameters

actions

Actions to sort

variantMapMustContain()

void hdps::util::variantMapMustContain	(	const QVariantMap &	variantMap,
		const QString &	key
	)

Raises an exception if an item with key is not found in a variant map

Parameters

variantMap	Variant map that should contain the key
key	Item name