#include <OverlayData.hpp>

Collaboration diagram for tuttle::plugin::histogramKeyer::OverlayData:

Public Types
typedef boost::gil::rgba32f_view_t	SView
Public Member Functions
	OverlayData (const OfxPointI &size, const int nbSteps, const int nbStepsCurvesFromSelection)
void	clearSelection ()
void	clearAll (const OfxPointI &size)
bool	isImageSizeModified (const OfxPointI &size) const
void	computeFullData (OFX::Clip *clipSrc, const OfxTime time, const OfxPointD &renderScale, const bool selectionOnly=false)
void	computeCurveFromSelectionData (OFX::Clip *clipSrc, const OfxTime time, const OfxPointD &renderScale)
void	setNbStep (const std::size_t nbStep)
bool	isCurrentTimeModified (const OfxTime time) const
void	resetCurvesFromSelectionData ()
Data Fields
HistogramBufferData	_data
HistogramBufferData	_selectionData
HistogramBufferData	_curveFromSelection
AverageBarData	_averageData
bool_2d	_imgBool
OfxTime	_currentTime
std::size_t	_vNbStep
std::size_t	_vNbStepCurveFromSelection
bool	_isComputing
bool	_isDataInvalid
Private Member Functions
void	computeHistogramBufferData (HistogramBufferData &data, SView &srcView, const OfxTime time, const bool isSelection=false)
void	correctHistogramBufferData (HistogramBufferData &toCorrect) const
void	resetHistogramBufferData (HistogramBufferData &toReset) const
	Set each values of the vector to null.
void	computeAverages ()
void	resetHistogramData ()
void	resetHistogramSelectionData ()
void	resetAverages ()
void	removeSelection ()
void	correctVector (HistogramVector &v) const
void	resetVectortoZero (HistogramVector &v, const std::size_t size) const
	Set each values of the vector to null.
int	computeAnAverage (const HistogramVector &selection_v) const
Private Attributes
OfxPointI	_size

Detailed Description

Definition at line 159 of file OverlayData.hpp.

Member Typedef Documentation

typedef boost::gil::rgba32f_view_t tuttle::plugin::histogramKeyer::OverlayData::SView

Definition at line 162 of file OverlayData.hpp.

Constructor & Destructor Documentation

tuttle::plugin::histogramKeyer::OverlayData::OverlayData	(	const OfxPointI &	size,
		const int	nbSteps,
		const int	nbStepsCurvesFromSelection
	)

Create a new empty data structure from scratch (data is null)

Parameters:

size	: size of the current source clip (width*height)

Definition at line 16 of file OverlayData.cpp.

References clearAll().

Here is the call graph for this function:

Member Function Documentation

void tuttle::plugin::histogramKeyer::OverlayData::clearAll ( const OfxPointI & size ) [inline]

Definition at line 176 of file OverlayData.hpp.

References _size.

Referenced by computeCurveFromSelectionData(), computeFullData(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw(), and OverlayData().

void tuttle::plugin::histogramKeyer::OverlayData::clearSelection ( ) [inline]

reset selection data (button clear selection)

Definition at line 170 of file OverlayData.hpp.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam(), and tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penDown().

int tuttle::plugin::histogramKeyer::OverlayData::computeAnAverage ( const HistogramVector & selection_v ) const [private]

Compute a specific channel average

Parameters:

selection_v vector which contain the selection histogram

Returns:

Definition at line 126 of file OverlayData.cpp.

Referenced by computeAverages().

void tuttle::plugin::histogramKeyer::OverlayData::computeAverages ( ) [private]

Compute average bars for display

Definition at line 109 of file OverlayData.cpp.

Referenced by computeFullData().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::computeCurveFromSelectionData	(	OFX::Clip *	clipSrc,
		const OfxTime	time,
		const OfxPointD &	renderScale
	)

Compute only curve from selection data (averages,histograms buffer and selection buffer)

Parameters:

clipSrc	source of the plugin
time	current time
renderScale	current renderScale

Definition at line 322 of file OverlayData.cpp.

References _currentTime, _curveFromSelection, _imgBool, _isComputing, clearAll(), correctHistogramBufferData(), OFX::eBitDepthFloat, tuttle::plugin::eImageOrientationIndependant, OFX::Clip::fetchImage(), OFX::Clip::getCanonicalRod(), OFX::Clip::getPixelComponents(), OFX::Clip::getPixelDepth(), OFX::Clip::getPixelRod(), OFX::Clip::isConnected(), isImageSizeModified(), resetCurvesFromSelectionData(), terry::algorithm::transform_pixels(), TUTTLE_LOG_WARNING, and OfxPointI::x.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::computeFullData	(	OFX::Clip *	clipSrc,
		const OfxTime	time,
		const OfxPointD &	renderScale,
		const bool	selectionOnly = `false`
	)

Histogram computing

Compute full data (averages,histograms buffer and selection buffer)

Parameters:

clipSrc	source of the plugin
time	current time
renderScale	current renderScale

Definition at line 149 of file OverlayData.cpp.

References _currentTime, _data, _isComputing, _selectionData, clearAll(), computeAverages(), computeHistogramBufferData(), OFX::eBitDepthFloat, tuttle::plugin::eImageOrientationIndependant, OFX::Clip::fetchImage(), OFX::Clip::getCanonicalRod(), OFX::Clip::getPixelComponents(), OFX::Clip::getPixelDepth(), OFX::Clip::getPixelRod(), OFX::Clip::isConnected(), isImageSizeModified(), resetHistogramData(), resetHistogramSelectionData(), TUTTLE_LOG_WARNING, and OfxPointI::x.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::computeHistogramBufferData	(	HistogramBufferData &	data,
		SView &	srcView,
		const OfxTime	time,
		const bool	isSelection = `false`
	)		`[private]`

Update selection areas buffer to selection histograms overlay

Parameters:

args	needed to have current time

Definition at line 31 of file OverlayData.cpp.

References _imgBool, _size, tuttle::plugin::histogramKeyer::HistogramBufferData::_step, _vNbStep, correctHistogramBufferData(), terry::algorithm::transform_pixels(), OfxPointI::x, and OfxPointI::y.

Referenced by computeFullData().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::correctHistogramBufferData ( HistogramBufferData & toCorrect ) const [private]

Correct the HistogramBufferData buffers wrong value with an average

Parameters:

toCorrect HistogramBufferData to correct

Definition at line 80 of file OverlayData.cpp.

References tuttle::plugin::histogramKeyer::HistogramBufferData::_bufferBlue, tuttle::plugin::histogramKeyer::HistogramBufferData::_bufferGreen, tuttle::plugin::histogramKeyer::HistogramBufferData::_bufferHue, tuttle::plugin::histogramKeyer::HistogramBufferData::_bufferLightness, tuttle::plugin::histogramKeyer::HistogramBufferData::_bufferRed, tuttle::plugin::histogramKeyer::HistogramBufferData::_bufferSaturation, and correctVector().

Referenced by computeCurveFromSelectionData(), and computeHistogramBufferData().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::correctVector ( HistogramVector & v ) const [private]

Replace vector null values by average (better for histogram display)

Parameters:

v	vector to modify

Definition at line 97 of file OverlayData.cpp.

Referenced by correctHistogramBufferData().

bool tuttle::plugin::histogramKeyer::OverlayData::isCurrentTimeModified ( const OfxTime time ) const

Current time checker

Definition at line 311 of file OverlayData.cpp.

References _currentTime.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw(), and tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::render().

bool tuttle::plugin::histogramKeyer::OverlayData::isImageSizeModified ( const OfxPointI & imgSize ) const

Image size checker

Warning:: HACK changeClip method doesn't work in nuke when time of source clip is changed so we have to check size of imgBool all the time

Check size (verify that imgBool always has the good size

Definition at line 302 of file OverlayData.cpp.

References _size, OfxPointI::x, and OfxPointI::y.

Referenced by computeCurveFromSelectionData(), computeFullData(), and tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw().

void tuttle::plugin::histogramKeyer::OverlayData::removeSelection ( ) [private]

Definition at line 270 of file OverlayData.cpp.

References _imgBool, _size, OfxPointI::x, and OfxPointI::y.

void tuttle::plugin::histogramKeyer::OverlayData::resetAverages ( ) [private]

Set all of averages to 0

Definition at line 288 of file OverlayData.cpp.

References tuttle::plugin::histogramKeyer::AverageBarData::_averageBlue, _averageData, tuttle::plugin::histogramKeyer::AverageBarData::_averageGreen, tuttle::plugin::histogramKeyer::AverageBarData::_averageHue, tuttle::plugin::histogramKeyer::AverageBarData::_averageLightness, tuttle::plugin::histogramKeyer::AverageBarData::_averageRed, and tuttle::plugin::histogramKeyer::AverageBarData::_averageSaturation.

void tuttle::plugin::histogramKeyer::OverlayData::resetCurvesFromSelectionData ( )

HistoramData management

Reset the data (all values to 0)

Parameters:

size	size of the current source clip

Definition at line 252 of file OverlayData.cpp.

References _curveFromSelection, tuttle::plugin::histogramKeyer::HistogramBufferData::_step, _vNbStepCurveFromSelection, and resetHistogramBufferData().

Referenced by computeCurveFromSelectionData().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::resetHistogramBufferData ( HistogramBufferData & toReset ) const [private]

Set each values of the vector to null.

Parameters:

toReset HistogramBufferdata instance to reset

Definition at line 62 of file OverlayData.cpp.

Referenced by resetCurvesFromSelectionData(), resetHistogramData(), and resetHistogramSelectionData().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::resetHistogramData ( ) [private]

Reset the data (all values to 0)

Parameters:

size	size of the current source clip

Definition at line 241 of file OverlayData.cpp.

References _data, tuttle::plugin::histogramKeyer::HistogramBufferData::_step, _vNbStep, and resetHistogramBufferData().

Referenced by computeFullData().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::resetHistogramSelectionData ( ) [private]

Reset the data (all values to 0)

Parameters:

size	size of the current source clip

Definition at line 263 of file OverlayData.cpp.

References _selectionData, tuttle::plugin::histogramKeyer::HistogramBufferData::_step, _vNbStep, and resetHistogramBufferData().

Referenced by computeFullData().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::OverlayData::resetVectortoZero	(	HistogramVector &	v,
		const std::size_t	numberOfStep
	)		const `[private]`

Set each values of the vector to null.

Parameters:

v	vector to reset
numberOfStep	number of step (size of the vector)

Definition at line 53 of file OverlayData.cpp.

Referenced by resetHistogramBufferData().

void tuttle::plugin::histogramKeyer::OverlayData::setNbStep ( const std::size_t nbStep ) [inline]

Definition at line 196 of file OverlayData.hpp.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam().

Field Documentation

AverageBarData tuttle::plugin::histogramKeyer::OverlayData::_averageData

Definition at line 234 of file OverlayData.hpp.

Referenced by computeAverages(), and resetAverages().

OfxTime tuttle::plugin::histogramKeyer::OverlayData::_currentTime

Definition at line 236 of file OverlayData.hpp.

Referenced by computeCurveFromSelectionData(), computeFullData(), and isCurrentTimeModified().

HistogramBufferData tuttle::plugin::histogramKeyer::OverlayData::_curveFromSelection

Definition at line 232 of file OverlayData.hpp.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam(), computeCurveFromSelectionData(), and resetCurvesFromSelectionData().

HistogramBufferData tuttle::plugin::histogramKeyer::OverlayData::_data

Todo:: accessors

Definition at line 230 of file OverlayData.hpp.

Referenced by computeFullData(), tuttle::plugin::histogramKeyer::HSLOverlay::draw(), tuttle::plugin::histogramKeyer::RGBOverlay::draw(), and resetHistogramData().

bool_2d tuttle::plugin::histogramKeyer::OverlayData::_imgBool

Definition at line 235 of file OverlayData.hpp.

Referenced by computeCurveFromSelectionData(), computeHistogramBufferData(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penMotion(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penUp(), and removeSelection().

bool tuttle::plugin::histogramKeyer::OverlayData::_isComputing

Definition at line 239 of file OverlayData.hpp.

Referenced by computeCurveFromSelectionData(), and computeFullData().

bool tuttle::plugin::histogramKeyer::OverlayData::_isDataInvalid

Definition at line 241 of file OverlayData.hpp.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedClip(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::HistogramKeyerOverlay(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::keyUp(), and tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penUp().

HistogramBufferData tuttle::plugin::histogramKeyer::OverlayData::_selectionData

Definition at line 231 of file OverlayData.hpp.

Referenced by computeAverages(), computeFullData(), and resetHistogramSelectionData().

OfxPointI tuttle::plugin::histogramKeyer::OverlayData::_size [private]

Definition at line 244 of file OverlayData.hpp.

Referenced by computeHistogramBufferData(), isImageSizeModified(), and removeSelection().

std::size_t tuttle::plugin::histogramKeyer::OverlayData::_vNbStep

Definition at line 237 of file OverlayData.hpp.

Referenced by computeHistogramBufferData(), resetHistogramData(), and resetHistogramSelectionData().

std::size_t tuttle::plugin::histogramKeyer::OverlayData::_vNbStepCurveFromSelection

Definition at line 238 of file OverlayData.hpp.

Referenced by tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::changedParam(), and resetCurvesFromSelectionData().

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

plugins/image/process/color/HistogramKeyer/src/OverlayData.hpp
plugins/image/process/color/HistogramKeyer/src/OverlayData.cpp

Public Types

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation