TuttleOFX  1
tuttle::plugin::imageStatistics Namespace Reference

Data Structures

class  ImageStatisticsOverlayInteract
class  ImageStatisticsEffectOverlayDescriptor
struct  ImageStatisticsProcessParams
class  ImageStatisticsPlugin
 ImageStatistics plugin. More...
class  ImageStatisticsProcess
 Compute the image average. More...
struct  OutputParams
struct  ComputeOutputParams

Enumerations

enum  EParamCoordinateSystem { eParamCoordinateSystemNormalized = 0, eParamCoordinateSystemCanonical }
enum  EParamChooseOutput {
  eParamChooseOutputSource = 0, eParamChooseOutputAverage, eParamChooseOutputVariance, eParamChooseOutputChannelMin,
  eParamChooseOutputChannelMax, eParamChooseOutputLuminosityMin, eParamChooseOutputLuminosityMax
}

Functions

 mDeclarePluginFactory (ImageStatisticsPluginFactory,{},{})
template<typename T >
standard_deviation (const T v_sum, const T v_sum_p2, const std::size_t nb)
template<typename Pixel >
Pixel pixel_standard_deviation (const Pixel &v_sum, const Pixel &v_sum_p2, const std::size_t nb)
template<typename T >
kurtosis (const T v_mean, const T v_standard_deviation, const T v_sum, const T v_sum_p2, const T v_sum_p3, const T v_sum_p4, const std::size_t nb)
 In probability theory and statistics, kurtosis is a measure of the "peakedness" of the probability distribution of a real-valued random variable.
template<typename Pixel >
Pixel pixel_kurtosis (const Pixel &v_mean, const Pixel &v_standard_deviation, const Pixel &v_sum, const Pixel &v_sum_p2, const Pixel &v_sum_p3, const Pixel &v_sum_p4, const std::size_t nb)
template<typename T >
skewness (const T v_mean, const T v_standard_deviation, const T v_sum, const T v_sum_p2, const T v_sum_p3, const std::size_t nb)
 In probability theory and statistics, skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable.
template<typename Pixel >
Pixel pixel_skewness (const Pixel &v_mean, const Pixel &v_standard_deviation, const Pixel &v_sum, const Pixel &v_sum_p2, const Pixel &v_sum_p3, const std::size_t nb)
template<typename OutputParamsRGBA , typename OutputParamsHSL >
void setOutputParams (const OutputParamsRGBA &outputParamsRGBA, const OutputParamsHSL &outputParamsHSL, const OfxTime time, ImageStatisticsPlugin &plugin)

Variables

static const std::string kParamCoordinateSystem = "coordinateSystem"
static const std::string kParamCoordinateSystemNormalized = "coordinateSystemNormalized"
static const std::string kParamCoordinateSystemCanonical = "coordinateSystemCanonical"
static const std::string kParamRectCenter = "rectCenter"
static const std::string kParamRectSize = "rectSize"
static const std::string kParamOutputGroup = "outputGroup"
static const std::string kParamOutputGroupRGBA = "outputGroupRGBA"
static const std::string kParamOutputAverage = "outputAverage"
static const std::string kParamOutputVariance = "outputVariance"
static const std::string kParamOutputChannelMin = "outputChannelMin"
static const std::string kParamOutputChannelMax = "outputChannelMax"
static const std::string kParamOutputLuminosityMin = "outputLuminosityMin"
static const std::string kParamOutputLuminosityMax = "outputLuminosityMax"
static const std::string kParamOutputKurtosis = "outputKurtosis"
static const std::string kParamOutputSkewness = "outputSkewness"
static const std::string kParamOutputGroupHSL = "outputGroupHSL"
static const std::string kParamOutputAverageHSL = "outputAverageHSL"
static const std::string kParamOutputChannelMinHSL = "outputChannelMinHSL"
static const std::string kParamOutputChannelMaxHSL = "outputChannelMaxHSL"
static const std::string kParamOutputLuminosityMinHSL = "outputLuminosityMinHSL"
static const std::string kParamOutputLuminosityMaxHSL = "outputLuminosityMaxHSL"
static const std::string kParamOutputKurtosisHSL = "outputKurtosisHSL"
static const std::string kParamOutputSkewnessHSL = "outputSkewnessHSL"
static const std::string kParamChooseOutput = "chooseOutput"
static const std::string kParamChooseOutputSource = "source"
static const std::string kParamChooseOutputAverage = "average"
static const std::string kParamChooseOutputVariance = "variance"
static const std::string kParamChooseOutputChannelMin = "minValues"
static const std::string kParamChooseOutputChannelMax = "maxValues"
static const std::string kParamChooseOutputLuminosityMin = "minLuminosity"
static const std::string kParamChooseOutputLuminosityMax = "maxLuminosity"
static const bool kSupportTiles = false

Enumeration Type Documentation

Enumerator:
eParamChooseOutputSource 
eParamChooseOutputAverage 
eParamChooseOutputVariance 
eParamChooseOutputChannelMin 
eParamChooseOutputChannelMax 
eParamChooseOutputLuminosityMin 
eParamChooseOutputLuminosityMax 

Definition at line 52 of file ImageStatisticsDefinitions.hpp.

Enumerator:
eParamCoordinateSystemNormalized 
eParamCoordinateSystemCanonical 

Definition at line 14 of file ImageStatisticsDefinitions.hpp.


Function Documentation

template<typename T >
T tuttle::plugin::imageStatistics::kurtosis ( const T  v_mean,
const T  v_standard_deviation,
const T  v_sum,
const T  v_sum_p2,
const T  v_sum_p3,
const T  v_sum_p4,
const std::size_t  nb 
)

In probability theory and statistics, kurtosis is a measure of the "peakedness" of the probability distribution of a real-valued random variable.

Higher kurtosis means more of the variance is the result of infrequent extreme deviations, as opposed to frequent modestly sized deviations.

Definition at line 125 of file ImageStatisticsProcess.tcc.

Referenced by pixel_kurtosis().

tuttle::plugin::imageStatistics::mDeclarePluginFactory ( ImageStatisticsPluginFactory  )
template<typename Pixel >
Pixel tuttle::plugin::imageStatistics::pixel_kurtosis ( const Pixel &  v_mean,
const Pixel &  v_standard_deviation,
const Pixel &  v_sum,
const Pixel &  v_sum_p2,
const Pixel &  v_sum_p3,
const Pixel &  v_sum_p4,
const std::size_t  nb 
)

Definition at line 133 of file ImageStatisticsProcess.tcc.

References kurtosis().

Referenced by tuttle::plugin::imageStatistics::ComputeOutputParams< View, CType >::operator()().

Here is the call graph for this function:

template<typename Pixel >
Pixel tuttle::plugin::imageStatistics::pixel_skewness ( const Pixel &  v_mean,
const Pixel &  v_standard_deviation,
const Pixel &  v_sum,
const Pixel &  v_sum_p2,
const Pixel &  v_sum_p3,
const std::size_t  nb 
)

Definition at line 160 of file ImageStatisticsProcess.tcc.

References skewness().

Referenced by tuttle::plugin::imageStatistics::ComputeOutputParams< View, CType >::operator()().

Here is the call graph for this function:

template<typename Pixel >
Pixel tuttle::plugin::imageStatistics::pixel_standard_deviation ( const Pixel &  v_sum,
const Pixel &  v_sum_p2,
const std::size_t  nb 
)

Definition at line 106 of file ImageStatisticsProcess.tcc.

References standard_deviation().

Referenced by tuttle::plugin::imageStatistics::ComputeOutputParams< View, CType >::operator()().

Here is the call graph for this function:

template<typename OutputParamsRGBA , typename OutputParamsHSL >
void tuttle::plugin::imageStatistics::setOutputParams ( const OutputParamsRGBA &  outputParamsRGBA,
const OutputParamsHSL &  outputParamsHSL,
const OfxTime  time,
ImageStatisticsPlugin &  plugin 
)

Definition at line 324 of file ImageStatisticsProcess.tcc.

References tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputAverage, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputAverageHSL, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputChannelMax, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputChannelMaxHSL, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputChannelMin, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputChannelMinHSL, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputKurtosis, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputKurtosisHSL, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputLuminosityMax, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputLuminosityMaxHSL, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputLuminosityMin, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputLuminosityMinHSL, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputSkewness, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputSkewnessHSL, tuttle::plugin::imageStatistics::ImageStatisticsPlugin::_paramOutputVariance, tuttle::plugin::set012ParamValuesAtTime(), and tuttle::plugin::setRGBAParamValuesAtTime().

Referenced by tuttle::plugin::imageStatistics::ImageStatisticsProcess< View >::setup().

Here is the call graph for this function:

template<typename T >
T tuttle::plugin::imageStatistics::skewness ( const T  v_mean,
const T  v_standard_deviation,
const T  v_sum,
const T  v_sum_p2,
const T  v_sum_p3,
const std::size_t  nb 
)

In probability theory and statistics, skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable.

A zero value indicates that the values are relatively evenly distributed on both sides of the mean, typically but not necessarily implying a symmetric distribution.

Definition at line 153 of file ImageStatisticsProcess.tcc.

Referenced by pixel_skewness().

template<typename T >
T tuttle::plugin::imageStatistics::standard_deviation ( const T  v_sum,
const T  v_sum_p2,
const std::size_t  nb 
)

Definition at line 99 of file ImageStatisticsProcess.tcc.

Referenced by pixel_standard_deviation().


Variable Documentation

const std::string tuttle::plugin::imageStatistics::kParamChooseOutputAverage = "average" [static]

Definition at line 45 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamChooseOutputChannelMax = "maxValues" [static]

Definition at line 48 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamChooseOutputChannelMin = "minValues" [static]

Definition at line 47 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamChooseOutputLuminosityMax = "maxLuminosity" [static]

Definition at line 50 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamChooseOutputLuminosityMin = "minLuminosity" [static]

Definition at line 49 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamChooseOutputSource = "source" [static]

Definition at line 44 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamChooseOutputVariance = "variance" [static]

Definition at line 46 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamCoordinateSystemCanonical = "coordinateSystemCanonical" [static]

Definition at line 12 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamCoordinateSystemNormalized = "coordinateSystemNormalized" [static]

Definition at line 11 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamOutputGroup = "outputGroup" [static]

Definition at line 22 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamOutputGroupHSL = "outputGroupHSL" [static]

Definition at line 34 of file ImageStatisticsDefinitions.hpp.

const std::string tuttle::plugin::imageStatistics::kParamOutputGroupRGBA = "outputGroupRGBA" [static]

Definition at line 24 of file ImageStatisticsDefinitions.hpp.

Definition at line 10 of file ImageStatisticsPluginFactory.hpp.