Compute a gray-scale image from color input. Alpha channel is not touched. More...

#include <imagegrayscale.h>

Inheritance diagram for inviwo::ImageGrayscale:

Public Member Functions
virtual const ProcessorInfo	getProcessorInfo () const override

Public Member Functions inherited from inviwo::ImageGLProcessor
	ImageGLProcessor (std::shared_ptr< const ShaderResource > fragmentShader, bool buildShader=true)

	ImageGLProcessor (const std::string &fragmentShader, bool buildShader=true)

virtual void	initializeResources () override

virtual void	process () override

Public Member Functions inherited from inviwo::Processor
	Processor (const std::string &identifier="", const std::string &displayName="")

std::string	getClassIdentifier () const

std::string	getCategory () const

CodeState	getCodeState () const

Tags	getTags () const

void	setIdentifier (const std::string &identifier)

const std::string &	getIdentifier () const

void	setDisplayName (const std::string &displayName)

const std::string &	getDisplayName () const

virtual std::vector< std::string >	getPath () const override

virtual void	setProcessorWidget (std::unique_ptr< ProcessorWidget > processorWidget)

ProcessorWidget *	getProcessorWidget () const

bool	hasProcessorWidget () const

virtual void	setNetwork (ProcessorNetwork *network)

ProcessorNetwork *	getNetwork () const

Port *	getPort (const std::string &identifier) const

Inport *	getInport (const std::string &identifier) const

Outport *	getOutport (const std::string &identifier) const

const std::vector< Inport * > &	getInports () const

const std::vector< Outport * > &	getOutports () const

const std::string &	getPortGroup (Port *port) const

std::vector< std::string >	getPortGroups () const

const std::vector< Port * > &	getPortsInGroup (const std::string &portGroup) const

const std::vector< Port * > &	getPortsInSameGroup (Port *port) const

bool	allInportsConnected () const

bool	allInportsAreReady () const

bool	isSource () const

bool	isSink () const

bool	isReady () const

virtual void	doIfNotReady ()

virtual void	setValid () override

virtual void	invalidate (InvalidationLevel invalidationLevel, Property *modifiedProperty=nullptr) override

void	addInteractionHandler (InteractionHandler *interactionHandler)

void	removeInteractionHandler (InteractionHandler *interactionHandler)

bool	hasInteractionHandler () const

const std::vector< InteractionHandler * > &	getInteractionHandlers () const

virtual void	invokeEvent (Event *event) override

virtual void	propagateEvent (Event event, Outport source) override

virtual Processor *	getProcessor () override

virtual const Processor *	getProcessor () const override

virtual void	serialize (Serializer &s) const override

virtual void	deserialize (Deserializer &d) override

template<typename T , typename std::enable_if_t< std::is_base_of< Inport, T >::value, int > = 0>
T &	addPort (std::unique_ptr< T > port, const std::string &portGroup="default")

template<typename T , typename std::enable_if_t< std::is_base_of< Outport, T >::value, int > = 0>
T &	addPort (std::unique_ptr< T > port, const std::string &portGroup="default")

template<typename T >
T &	addPort (T &port, const std::string &portGroup="default")

Port *	removePort (const std::string &identifier)

Inport *	removePort (Inport *port)

Outport *	removePort (Outport *port)

Public Member Functions inherited from inviwo::PropertyOwner
virtual	~PropertyOwner ()
	Removes all properties and notifies its observers of the removal.

virtual void	addProperty (Property *property, bool owner=true)

virtual void	addProperty (Property &property)

template<typename... Ts>
void	addProperties (Ts &... properties)

virtual void	insertProperty (size_t index, Property *property, bool owner=true)
	insert property `property` at position `index` If `index` is not valid, the property is appended. More...

virtual void	insertProperty (size_t index, Property &property)
	insert property `property` at position `index` If `index` is not valid, the property is appended. More...

virtual Property *	removeProperty (const std::string &identifier)

virtual Property *	removeProperty (Property *property)

virtual Property *	removeProperty (Property &property)

virtual Property *	removeProperty (size_t index)
	remove property referred to by `index` More...

const std::vector< Property * > &	getProperties () const

const std::vector< CompositeProperty * > &	getCompositeProperties () const

std::vector< Property * >	getPropertiesRecursive () const

Property *	getPropertyByIdentifier (const std::string &identifier, bool recursiveSearch=false) const

Property *	getPropertyByPath (const std::vector< std::string > &path) const

template<class T >
std::vector< T * >	getPropertiesByType (bool recursiveSearch=false) const

size_t	size () const

Property *	operator[] (size_t)

const Property *	operator[] (size_t) const

iterator	begin ()

iterator	end ()

const_iterator	cbegin () const

const_iterator	cend () const

virtual bool	isValid () const

InvalidationLevel	getInvalidationLevel () const

void	setAllPropertiesCurrentStateAsDefault ()

void	resetAllPoperties ()

virtual InviwoApplication *	getInviwoApplication ()

Public Member Functions inherited from inviwo::PropertyOwnerObservable
void	notifyObserversWillAddProperty (Property *property, size_t index)

void	notifyObserversDidAddProperty (Property *property, size_t index)

void	notifyObserversWillRemoveProperty (Property *property, size_t index)

void	notifyObserversDidRemoveProperty (Property *property, size_t index)

Public Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
	Observable (const Observable< PropertyOwnerObserver > &other)

	Observable (Observable< PropertyOwnerObserver > &&other)

Observable< PropertyOwnerObserver > &	operator= (const Observable< PropertyOwnerObserver > &other)

Observable< PropertyOwnerObserver > &	operator= (Observable< PropertyOwnerObserver > &&other)

void	addObserver (PropertyOwnerObserver *observer)

void	removeObserver (PropertyOwnerObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Public Member Functions inherited from inviwo::MetaDataOwner
	MetaDataOwner (const MetaDataOwner &rhs)=default

MetaDataOwner &	operator= (const MetaDataOwner &rhs)=default

void	copyMetaDataFrom (const MetaDataOwner &src)

void	copyMetaDataTo (MetaDataOwner &dst)

template<typename T >
T *	createMetaData (const std::string &key)

template<typename T , typename U >
void	setMetaData (const std::string &key, U value)

template<typename T >
bool	unsetMetaData (const std::string &key)
	unset, i.e. remove the metadata entry matching the given key and type More...

template<typename T , typename U >
U	getMetaData (const std::string &key, U val) const

template<typename T >
T *	getMetaData (const std::string &key)

template<typename T >
const T *	getMetaData (const std::string &key) const

MetaDataMap *	getMetaDataMap ()

const MetaDataMap *	getMetaDataMap () const

template<typename T >
bool	hasMetaData (const std::string &key) const

Public Member Functions inherited from inviwo::Observable< ProcessorObserver >
	Observable (const Observable< ProcessorObserver > &other)

	Observable (Observable< ProcessorObserver > &&other)

Observable< ProcessorObserver > &	operator= (const Observable< ProcessorObserver > &other)

Observable< ProcessorObserver > &	operator= (Observable< ProcessorObserver > &&other)

void	addObserver (ProcessorObserver *observer)

void	removeObserver (ProcessorObserver *observer)

virtual void	startBlockingNotifications () override final

virtual void	stopBlockingNotifications () override final

Static Public Attributes
static const ProcessorInfo	processorInfo_

Protected Member Functions
virtual void	preProcess (TextureUnitContainer &cont) override
	this function gets called right before the actual processing but after the shader has been activated More...

Protected Member Functions inherited from inviwo::ImageGLProcessor
void	markInvalid ()

virtual void	postProcess ()
	this function gets called at the end of the process function More...

virtual void	afterInportChanged ()
	this function gets called whenever the inport changes More...

size2_t	calcOutputDimensions () const

Protected Member Functions inherited from inviwo::Processor
void	addPortToGroup (Port *port, const std::string &portGroup)

void	removePortFromGroups (Port *port)

Protected Member Functions inherited from inviwo::PropertyOwner
	PropertyOwner (const PropertyOwner &rhs)

PropertyOwner &	operator= (const PropertyOwner &that)=delete

Protected Member Functions inherited from inviwo::Observable< PropertyOwnerObserver >
void	forEachObserver (C callback)

Protected Member Functions inherited from inviwo::ObservableInterface
void	addObservationHelper (Observer *observer)

void	removeObservationHelper (Observer *observer)

Protected Member Functions inherited from inviwo::ProcessorObservable
void	notifyObserversAboutPropertyChange (Property *p)

void	notifyObserversInvalidationBegin (Processor *p)

void	notifyObserversInvalidationEnd (Processor *p)

void	notifyObserversIdentifierChanged (Processor *p, const std::string &oldIdentifier)

void	notifyObserversDisplayNameChanged (Processor *p, const std::string &oldDisplayName)

void	notifyObserversProcessorPortAdded (Processor p, Port port)

void	notifyObserversProcessorPortRemoved (Processor p, Port port)

void	notifyObserversAboutToProcess (Processor *p)

void	notifyObserversFinishedProcess (Processor *p)

void	notifyObserversSourceChange (Processor *p)

void	notifyObserversSinkChange (Processor *p)

void	notifyObserversReadyChange (Processor *p)

Protected Member Functions inherited from inviwo::Observable< ProcessorObserver >
void	forEachObserver (C callback)

Additional Inherited Members
Public Types inherited from inviwo::PropertyOwner
using	iterator = std::vector< Property * >::iterator

using	const_iterator = std::vector< Property * >::const_iterator

Static Protected Member Functions inherited from inviwo::ImageGLProcessor
static void	createCustomImage (const size2_t &dim, const DataFormatBase *dataFormat, const SwizzleMask &swizzleMask, ImageInport &inport, ImageOutport &outport)

static void	createDefaultImage (const size2_t &dim, ImageInport &inport, ImageOutport &outport)

Protected Attributes inherited from inviwo::ImageGLProcessor
ImageInport	inport_

ImageOutport	outport_

const DataFormatBase *	dataFormat_

SwizzleMask	swizzleMask_

bool	internalInvalid_

std::string	fragmentShader_

Shader	shader_

Protected Attributes inherited from inviwo::Processor
std::unique_ptr< ProcessorWidget >	processorWidget_

StateCoordinator< bool >	isReady_

StateCoordinator< bool >	isSink_

StateCoordinator< bool >	isSource_

Protected Attributes inherited from inviwo::PropertyOwner
std::vector< Property * >	properties_

std::vector< EventProperty * >	eventProperties_

std::vector< CompositeProperty * >	compositeProperties_

std::vector< std::unique_ptr< Property > >	ownedProperties_

Protected Attributes inherited from inviwo::MetaDataOwner
MetaDataMap	metaData_

Protected Attributes inherited from inviwo::ProcessorObservable
friend	ProcessorNetworkEvaluator

friend	Property

Detailed Description

Compute a gray-scale image from color input. Alpha channel is not touched.

Compute a gray-scale image from a color input image. The alpha channel is not touched. The input image is converted to gray-scale as follows

grayValue = l.r * in.r + l.g * in.g + l.b * in.b
out.rgb = vec3(grayValue)
out.a = in.a

The color conversion factor l depends on the chosen luminance model:

perceived l.rgb = vec3(0.299, 0.587, 0.114)
relative l.rgb = vec3(0.2126, 0.7152, 0.0722), XYZ color space
average l.rgb = vec3(1/3, 1/3, 1/3)
red l.rgb = vec3(1/3, 0, 0)
green l.rgb = vec3(0, 1/3, 0)
blue l.rgb = vec3(0, 0, 1/3)

Inports

ImageInport The input image.

Outports

ImageOutport The grayscale output image.

Properties

Luminance Model Model for converting the input to grayscale. Options are perceived (default), relative, average, red only, green only, and blue only.

This processor computes the gray-scale image from a color image according to either perceived luminance (Y = 0.299 R + 0.587 G + 0.114 B) or relative luminance for XYZ color space (Y = 0.2126 R + 0.7152 G + 0.0722 B) utilizing the ImageGLProcessor.

Member Function Documentation

◆ preProcess()

void inviwo::ImageGrayscale::preProcess ( TextureUnitContainer & cont )

overrideprotectedvirtual

this function gets called right before the actual processing but after the shader has been activated

overwrite this function in the derived class to perform things like custom shader setup

Reimplemented from inviwo::ImageGLProcessor.

Member Data Documentation

◆ processorInfo_

const ProcessorInfo inviwo::ImageGrayscale::processorInfo_

static

Initial value:

{
    "org.inviwo.ImageGrayscale",  
    "Image Grayscale",            
    "Image Operation",            
    CodeState::Stable,            
    Tags::GL,                     
}

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

imagegrayscale.h
imagegrayscale.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members