colourManager Class Reference

colourManager manages colours wrapping the CRS Color Toolbox More...

Detailed Description

colourManager manages colours wrapping the CRS Color Toolbox

Copyright ©2014-2022 Ian Max Andolina — released: LGPL3, see LICENCE.md

Inheritance diagram for colourManager:

Public Member Functions
function	colourManager (in varargin)
	Class constructor.
function	DKLtoRGB (in obj, in source, in background)
function	RGBtoDKL (in obj, in source, in background)
function	RGBtoxyY (in obj, in source)
function	RGBtoMB (in obj, in source)
function	MBtoRGB (in obj, in source)
function	DKLtoxyY (in obj, in source, in background)
function	xyYtoRGB (in obj, in source)
function	plot (in obj)
function	closeScreen (in obj)
Public Member Functions inherited from optickaCore
function	optickaCore (in varargin)
	Class constructor.
function get	fullName (in me)
function	getALF (in me, in subject, in sessionPrefix, in lab, in create)
function	findAttributes (in me, in attrName, in attrValue)
function	findAttributesandType (in me, in attrName, in attrValue, in type)
	find properties of object with specific attributes, for example all properties whose GetAcccess attribute is public and type is logical.
function	findPropertyDefault (in me, in propName)
function	clone (in me)
	Use this syntax to make a deep copy of the object, i.e. OBJ_OUT has the same field values, but will not behave as a handle-copy of me anymore.
function	checkSuperclasses (in List)
function	editProperties (in me, in properties)
	method to modify a set of properties
function	setProp (in me, in property, in value)
	method to fast change a particular value. This is useful for use in anonymous functions, like in the state machine.
function	initialiseGlobals (in me, in doReset, in doOpen)
function	initialiseSaveFile (in me)
	Initialise Save prefix.
function	checkPaths (in me)
	checks the paths are valid

Public Attributes
Property	verbose
	verbosity
Property	deviceSPD
Property	sensitivities
Property	sensitivitiesCIE
Property	backgroundColour
	background colour
Property	screen
	screen
Property	gamutLimit
	how many times to try to find within gamut value?
Property	axisPriority
	prioritize which value to get back into gamut?
Property	autoPlot
	auto plot last RGB
Property	modifyRadius
	the step to modify radius to get into gamut
Property	lastRGB
Property	lastDKL
Property	lastMB
Property	lastxyY
Public Attributes inherited from optickaCore
Property	name
	object name
Property	comment
	comment
Property	verbose
	verbose logging, subclasses must assign this. This is normally logical true/false
Property	dateStamp
	clock() dateStamp set on construction
Property	uuid
	universal ID
Property	paths
	storage of various paths
Property	fullName
	The fullName is the object name combined with its uuid and class name.

Additional Inherited Members
Static Public Member Functions inherited from optickaCore
static function	makeArgs (in args)
	Converts cell args to structure array.
static function	addDefaults (in args, in defs)
	add default options to arg input
static function	hasKey (in in, in key)
	check if a struct / object has a propery / field
static function	getKeys (in device)
	PTB Get key presses, stops key bouncing.
Protected Member Functions inherited from optickaCore
function	parseArgs (in me, in args, in allowedProperties)
	Sets properties from a structure or normal arguments pairs, ignores invalid or non-allowed properties.
function	addArgs (in me, in args)
function	setPaths (in me)
	Sets properties from a structure or normal arguments pairs, ignores invalid or non-allowed properties.
function	getFonts (in me)
	set paths for object
function	toStructure (in me)
	Converts properties to a structure.
function	getType (in me, in in)
function	logOutput (in me, in in, in message, in override)
	Give a metaproperty return the likely property class.
function	salutation (in me, in varargin)
	Prints messages dependent on verbosity.
Protected Attributes inherited from optickaCore
Property	cloning
	are we cloning this from another object
Property	mversion
	Matlab version number, this is transient so it is not saved.
Property	sansFont
	sans font
Property	monoFont
	monoFont
Property	className
	class name
Property	savePrefix
	save prefix generated from clock time
Property	fullName_
	cached full name

Constructor & Destructor Documentation

colourManager()

function colourManager::colourManager

(

in

varargin

)

Class constructor.

screenManager constructor

Parameters

varargin

can be simple name value pairs, a structure or cell array

Returns

instance of the class.

Member Function Documentation

closeScreen()

function colourManager::closeScreen

(

in

obj

)

Parameters

return

DKLtoRGB()

function colourManager::DKLtoRGB	(	in	obj,
		in	source,
		in	background
	)

Parameters

return

DKLtoxyY()

function colourManager::DKLtoxyY	(	in	obj,
		in	source,
		in	background
	)

Parameters

return

MBtoRGB()

function colourManager::MBtoRGB	(	in	obj,
		in	source
	)

Parameters

return

plot()

function colourManager::plot

(

in

obj

)

Parameters

return

RGBtoDKL()

function colourManager::RGBtoDKL	(	in	obj,
		in	source,
		in	background
	)

Parameters

return

RGBtoMB()

function colourManager::RGBtoMB	(	in	obj,
		in	source
	)

Parameters

return

RGBtoxyY()

function colourManager::RGBtoxyY	(	in	obj,
		in	source
	)

Parameters

return

xyYtoRGB()

function colourManager::xyYtoRGB	(	in	obj,
		in	source
	)

Parameters

return

Member Data Documentation

autoPlot

Property colourManager::autoPlot

auto plot last RGB

axisPriority

Property colourManager::axisPriority

prioritize which value to get back into gamut?

backgroundColour

Property colourManager::backgroundColour

background colour

deviceSPD

Property colourManager::deviceSPD

gamutLimit

Property colourManager::gamutLimit

how many times to try to find within gamut value?

lastDKL

Property colourManager::lastDKL

lastMB

Property colourManager::lastMB

lastRGB

Property colourManager::lastRGB

lastxyY

Property colourManager::lastxyY

modifyRadius

Property colourManager::modifyRadius

the step to modify radius to get into gamut

screen

Property colourManager::screen

screen

sensitivities

Property colourManager::sensitivities

sensitivitiesCIE

Property colourManager::sensitivitiesCIE

verbose

Property colourManager::verbose

verbosity

---

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

• calibration/colourManager.m