KisUnsharpFilter Class Reference

#include <kis_unsharp_filter.h>

Inheritance diagram for KisUnsharpFilter:

Public Member Functions
QRect	changedRect (const QRect &rect, const KisFilterConfigurationSP _config, int lod) const override
KisConfigWidget *	createConfigurationWidget (QWidget *parent, const KisPaintDeviceSP dev, bool useForMasks) const override
KisFilterConfigurationSP	defaultConfiguration (KisResourcesInterfaceSP resourcesInterface) const override
	KisUnsharpFilter ()
QRect	neededRect (const QRect &rect, const KisFilterConfigurationSP _config, int lod) const override
void	processImpl (KisPaintDeviceSP device, const QRect &applyRect, const KisFilterConfigurationSP config, KoUpdater *progressUpdater) const override
Public Member Functions inherited from KisFilter
virtual bool	configurationAllowedForMask (KisFilterConfigurationSP config) const
virtual void	fixLoadedFilterConfigurationForMasks (KisFilterConfigurationSP config) const
	KisFilter (const KoID &id, const KoID &category, const QString &entry)
virtual bool	needsTransparentPixels (const KisFilterConfigurationSP config, const KoColorSpace *cs) const
void	process (const KisPaintDeviceSP src, KisPaintDeviceSP dst, KisSelectionSP selection, const QRect &applyRect, const KisFilterConfigurationSP config, KoUpdater *progressUpdater=0) const
void	process (KisPaintDeviceSP device, const QRect &applyRect, const KisFilterConfigurationSP config, KoUpdater *progressUpdater=0) const
virtual bool	supportsLevelOfDetail (const KisFilterConfigurationSP config, int lod) const
	~KisFilter () override
Public Member Functions inherited from KisBaseProcessor
KisBookmarkedConfigurationManager *	bookmarkManager ()
const KisBookmarkedConfigurationManager *	bookmarkManager () const
ColorSpaceIndependence	colorSpaceIndependence () const
virtual KisFilterConfigurationSP	factoryConfiguration (KisResourcesInterfaceSP resourcesInterface) const
QString	id () const
	KisBaseProcessor (const KoID &id, const KoID &category, const QString &entry)
KoID	menuCategory () const
QString	menuEntry () const
QString	name () const
	Private ()
QKeySequence	shortcut () const
bool	showConfigurationWidget ()
	If true, the filter wants to show a configuration widget.
bool	supportsAdjustmentLayers () const
	This filter can be used in adjustment layers.
bool	supportsPainting () const
bool	supportsThreading () const
virtual	~KisBaseProcessor ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Static Public Member Functions
static KoID	id ()

Private Member Functions
void	processLightnessOnly (KisPaintDeviceSP device, const QRect &rect, quint8 threshold, qreal weights[2], qreal factor, const QBitArray &channelFlags, KoUpdater *progressUpdater) const
void	processRaw (KisPaintDeviceSP device, const QRect &rect, quint8 threshold, qreal weights[2], qreal factor, const QBitArray &channelFlags, KoUpdater *progressUpdater) const

Additional Inherited Members
Public Attributes inherited from KisBaseProcessor
KisBookmarkedConfigurationManager *	bookmarkManager
KoID	category
ColorSpaceIndependence	colorSpaceIndependence
QString	entry
KoID	id
QKeySequence	shortcut
bool	showConfigurationWidget
bool	supportsAdjustmentLayers
bool	supportsPainting
bool	supportsThreading
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame
Protected Member Functions inherited from KisFilter
QString	configEntryGroup () const
void	setSupportsLevelOfDetail (bool value)
Protected Member Functions inherited from KisBaseProcessor
void	init (const QString &configEntryGroup)
void	setColorSpaceIndependence (ColorSpaceIndependence v)
void	setShortcut (const QKeySequence &shortcut)
void	setShowConfigurationWidget (bool v)
void	setSupportsAdjustmentLayers (bool v)
void	setSupportsPainting (bool v)
void	setSupportsThreading (bool v)
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

Definition at line 14 of file kis_unsharp_filter.h.

Constructor & Destructor Documentation

KisUnsharpFilter()

KisUnsharpFilter::KisUnsharpFilter

(

)

Officially Unsharp Mask doesn't support LoD, because it generates subtle artifacts when the unsharp radius is smaller than current zoom level. But LoD devices can still appear when the filter is used in Adjustment Layer. So the actual LoD is still counted on.

Definition at line 31 of file kis_unsharp_filter.cpp.

                                   : KisFilter(id(), FiltersCategoryEnhanceId, i18n("&Unsharp Mask..."))
{
    setSupportsPainting(true);
    setSupportsAdjustmentLayers(true);
    setSupportsThreading(true);
 
    setSupportsLevelOfDetail(false);
    setColorSpaceIndependence(FULLY_INDEPENDENT);
}

References FULLY_INDEPENDENT, KisBaseProcessor::setColorSpaceIndependence(), KisBaseProcessor::setSupportsAdjustmentLayers(), KisFilter::setSupportsLevelOfDetail(), KisBaseProcessor::setSupportsPainting(), and KisBaseProcessor::setSupportsThreading().

Member Function Documentation

changedRect()

QRect KisUnsharpFilter::changedRect ( const QRect & rect, const KisFilterConfigurationSP config, int lod ) const

overridevirtual

Similar to neededRect : some filters will alter a lot of pixels that are near to each other at the same time. So when you changed a single rectangle in a device, the actual rectangle that will feel the influence of this change might be bigger. Use this function to determine that rect.

Reimplemented from KisFilter.

Definition at line 208 of file kis_unsharp_filter.cpp.

{
    KisLodTransformScalar t(lod);
 
    QVariant value;
    const qreal halfSize = t.scale(config->getProperty("halfSize", value) ? value.toDouble() : 1.0);
 
    return rect.adjusted( -halfSize, -halfSize, halfSize, halfSize);
}

References KisLodTransformScalar::scale(), and value().

createConfigurationWidget()

KisConfigWidget * KisUnsharpFilter::createConfigurationWidget ( QWidget * parent, const KisPaintDeviceSP dev, bool useForMasks ) const

overridevirtual

Create the configuration widget for this processor.

Parameters

parent	the Qt owner widget of this widget
dev	the paintdevice this filter will act on
useForMasks	shown if the filer is going to be used in a mask. Some filters may provide limited options when applied as a mask (e.g. Gaussian Blur)

Reimplemented from KisBaseProcessor.

Definition at line 48 of file kis_unsharp_filter.cpp.

{
    return new KisWdgUnsharp(parent);
}

defaultConfiguration()

KisFilterConfigurationSP KisUnsharpFilter::defaultConfiguration ( KisResourcesInterfaceSP resourcesInterface ) const

overridevirtual

Return the configuration set as the default by the user or the default configuration from the filter writer as returned by factoryConfiguration.

This configuration is used by default for the configuration widget and given to the process function if there is no configuration widget.

Returns

the default configuration of this widget

Reimplemented from KisBaseProcessor.

Definition at line 53 of file kis_unsharp_filter.cpp.

{
    KisFilterConfigurationSP config = factoryConfiguration(resourcesInterface);
    config->setProperty("halfSize", 1);
    config->setProperty("amount", 0.5);
    config->setProperty("threshold", 0);
    config->setProperty("lightnessOnly", true);
    return config;
}

References KisBaseProcessor::factoryConfiguration().

id()

static KoID KisUnsharpFilter::id ( )

inlinestatic

Definition at line 26 of file kis_unsharp_filter.h.

                            {
        return KoID("unsharp", i18n("Unsharp Mask"));
    }

neededRect()

QRect KisUnsharpFilter::neededRect ( const QRect & rect, const KisFilterConfigurationSP config, int lod ) const

overridevirtual

Some filters need pixels outside the current processing rect to compute the new value (for instance, convolution filters)

Reimplemented from KisFilter.

Definition at line 198 of file kis_unsharp_filter.cpp.

{
    KisLodTransformScalar t(lod);
 
    QVariant value;
    const qreal halfSize = t.scale(config->getProperty("halfSize", value) ? value.toDouble() : 1.0);
 
    return rect.adjusted(-halfSize * 2, -halfSize * 2, halfSize * 2, halfSize * 2);
}

References KisLodTransformScalar::scale(), and value().

processImpl()

void KisUnsharpFilter::processImpl ( KisPaintDeviceSP device, const QRect & applyRect, const KisFilterConfigurationSP config, KoUpdater * progressUpdater ) const

overridevirtual

Override this function with the implementation of your filter.

This is a low level function that expects all the conditions for the

Parameters

device	be met. Use usual process() methods instead.
device	the paint device to filter
applyRect	the rectangle where the filter is applied
config	the parameters of the filter
progressUpdater	to pass on the progress the filter is making

Implements KisFilter.

Definition at line 63 of file kis_unsharp_filter.cpp.

{
 
    QPointer<KoUpdater> filterUpdater = 0;
    QPointer<KoUpdater> convolutionUpdater = 0;
    QScopedPointer<KoProgressUpdater> updater;
 
    if (progressUpdater) {
        updater.reset(new KoProgressUpdater(progressUpdater));
        updater->start(100, i18n("Unsharp Mask"));
        // Two sub-sub tasks that each go from 0 to 100.
        convolutionUpdater = updater->startSubtask();
        filterUpdater = updater->startSubtask();
    }
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(config);
 
    QVariant value;
 
    KisLodTransformScalar t(device);
 
    const qreal halfSize = t.scale(config->getProperty("halfSize", value) ? value.toDouble() : 1.0);
    const qreal amount = (config->getProperty("amount", value)) ? value.toDouble() : 0.5;
    const uint threshold = (config->getProperty("threshold", value)) ? value.toUInt() : 0;
    const uint lightnessOnly = (config->getProperty("lightnessOnly", value)) ? value.toBool() : true;
 
    QBitArray channelFlags = config->channelFlags();
    KisGaussianKernel::applyGaussian(device, applyRect,
                                     halfSize, halfSize,
                                     channelFlags,
                                     convolutionUpdater);
 
    qreal weights[2];
    qreal factor = 128;
 
    weights[0] = factor * (1. + amount);
    weights[1] = -factor * amount;
 
    if (lightnessOnly) {
        processLightnessOnly(device, applyRect, threshold, weights, factor, channelFlags, filterUpdater);
    } else {
        processRaw(device, applyRect, threshold, weights, factor, channelFlags, filterUpdater);
    }
}

References KisGaussianKernel::applyGaussian(), KIS_SAFE_ASSERT_RECOVER_RETURN, processLightnessOnly(), processRaw(), KisLodTransformScalar::scale(), and value().

processLightnessOnly()

void KisUnsharpFilter::processLightnessOnly ( KisPaintDeviceSP device, const QRect & rect, quint8 threshold, qreal weights[2], qreal factor, const QBitArray & channelFlags, KoUpdater * progressUpdater ) const

private

Definition at line 154 of file kis_unsharp_filter.cpp.

{
    const KoColorSpace *cs = device->colorSpace();
    const int pixelSize = cs->pixelSize();
 
    quint16 labColorSrc[4];
    quint16 labColorDst[4];
 
    const int posL = 0;
    const int posAlpha = 3;
 
    const qreal factorInv = 1.0 / factor;
 
    KisSequentialIteratorProgress dstIt(device, rect, progressUpdater);
 
    while (dstIt.nextPixel()) {
        quint8 diff = cs->differenceA(dstIt.oldRawData(), dstIt.rawDataConst());
        if (diff >= threshold) {
            cs->toLabA16(dstIt.oldRawData(), (quint8*)labColorSrc, 1);
            cs->toLabA16(dstIt.rawDataConst(), (quint8*)labColorDst, 1);
 
            qint32 valueL = (labColorSrc[posL] * weights[0] + labColorDst[posL] * weights[1]) * factorInv;
            labColorSrc[posL] = CLAMP(valueL,
                                      KoColorSpaceMathsTraits<quint16>::min,
                                      KoColorSpaceMathsTraits<quint16>::max);
 
            qint32 valueAlpha = (labColorSrc[posAlpha] * weights[0] + labColorDst[posAlpha] * weights[1]) * factorInv;
            labColorSrc[posAlpha] = CLAMP(valueAlpha,
                                          KoColorSpaceMathsTraits<quint16>::min,
                                          KoColorSpaceMathsTraits<quint16>::max);
 
            cs->fromLabA16((quint8*)labColorSrc, dstIt.rawData(), 1);
        } else {
            memcpy(dstIt.rawData(), dstIt.oldRawData(), pixelSize);
        }
    }
}

References CLAMP, KisPaintDevice::colorSpace(), KoColorSpace::differenceA(), KoColorSpace::fromLabA16(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixel(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::oldRawData(), KoColorSpace::pixelSize(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawData(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawDataConst(), and KoColorSpace::toLabA16().

processRaw()

void KisUnsharpFilter::processRaw ( KisPaintDeviceSP device, const QRect & rect, quint8 threshold, qreal weights[2], qreal factor, const QBitArray & channelFlags, KoUpdater * progressUpdater ) const

private

Definition at line 112 of file kis_unsharp_filter.cpp.

{
    const KoColorSpace *cs = device->colorSpace();
    const int pixelSize = cs->pixelSize();
    KoConvolutionOp * convolutionOp = cs->convolutionOp();
 
    quint8 *colors[2];
    colors[0] = new quint8[pixelSize];
    colors[1] = new quint8[pixelSize];
 
    KisSequentialIteratorProgress dstIt(device, rect, progressUpdater);
 
    while (dstIt.nextPixel()) {
        quint8 diff = 0;
        if (threshold == 1) {
            if (memcmp(dstIt.oldRawData(), dstIt.rawDataConst(), cs->pixelSize()) == 0) {
                diff = 1;
            }
        }
        else {
            diff = cs->difference(dstIt.oldRawData(), dstIt.rawDataConst());
        }
 
        if (diff >= threshold) {
            memcpy(colors[0], dstIt.oldRawData(), pixelSize);
            memcpy(colors[1], dstIt.rawDataConst(), pixelSize);
            convolutionOp->convolveColors(colors, weights, dstIt.rawData(), factor, 0, 2, channelFlags);
        } else {
            memcpy(dstIt.rawData(), dstIt.oldRawData(), pixelSize);
        }
    }
 
    delete[] colors[0];
    delete[] colors[1];
}

References KisPaintDevice::colorSpace(), KoColorSpace::convolutionOp, KoConvolutionOp::convolveColors(), KoColorSpace::difference(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixel(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::oldRawData(), KoColorSpace::pixelSize(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawData(), and KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawDataConst().

---

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

• plugins/filters/unsharp/kis_unsharp_filter.h
• plugins/filters/unsharp/kis_unsharp_filter.cpp