ColorToLabelMapIO.h File Reference

This header contains private IO functions for ColorToLabelMap types. More...

#include "ColorToLabelMap.h"

Include dependency graph for ColorToLabelMapIO.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	CortidQCT
	Name namespace for CortidQCT library.
	CortidQCT::ColorToLabelMaps
	Namespace containing color to label maps.

Functions
CustomMap	CortidQCT::ColorToLabelMaps::IO::loadCustomMapFromYAMLNode (YAML::Node const &node)
	Reads a custom color to label map from the given yaml node. More...
ColorRGB	CortidQCT::ColorToLabelMaps::IO::loadColorRGBFromYAMLNode (YAML::Node const &node)
	Reads a ColorRGB from a YAML node. More...

Detailed Description

This header contains private IO functions for ColorToLabelMap types.

Author

Stefan Reinhold

Copyright

Copyright (C) 2018 Stefan Reinhold – All Rights Reserved. You may use, distribute and modify this code under the terms of the AFL 3.0 license; see LICENSE for full license details.

Function Documentation

ColorRGB CortidQCT::ColorToLabelMaps::IO::loadColorRGBFromYAMLNode

(

YAML::Node const &

node

)

Reads a ColorRGB from a YAML node.

The YAML node must be a sequence of 3 unsigned integers

Parameters

node	The YAML node to read the color from.

Exceptions

YAML::Exception	on parsing failure
std::invalid_argument	if the YAML node is malformed.

Returns

A ColorRGB value

CustomMap CortidQCT::ColorToLabelMaps::IO::loadCustomMapFromYAMLNode

(

YAML::Node const &

node

)

Reads a custom color to label map from the given yaml node.

The YAML format is as follows: [[R1, G1, B1], L1], [R2, G2, B2, L2]], where Rx, Gx, Bx, L, are the x-th red, green, blue color components and label values, respectively. The color components must be given as unsigned 8-bit integers in the range [0, 255]. Optional the color map can be specified as a map type. Then the data specification above will go under the 'map' key and optionally, a undefinedLabel can be set.

Parameters

node	The YAML node to read the map from

Exceptions

YAML::Exception	on failure.
std::invalid_argument	if the YAML node is malformed

Returns

A ColorToLabelMaps::CustomMap object.