Spinning Topp Logo BlackTopp Studios
inc
sharpenmodifier.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 /*
41  -----------------------------------------------------------------------------
42  This source file is part of ogre-procedural
43 
44  For the latest info, see http://code.google.com/p/ogre-procedural/
45 
46  Copyright (c) 2010-2013 Michael Broutin
47 
48  Permission is hereby granted, free of charge, to any person obtaining a copy
49  of this software and associated documentation files (the "Software"), to deal
50  in the Software without restriction, including without limitation the rights
51  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
52  copies of the Software, and to permit persons to whom the Software is
53  furnished to do so, subject to the following conditions:
54 
55  The above copyright notice and this permission notice shall be included in
56  all copies or substantial portions of the Software.
57 
58  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
59  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
60  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
61  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
62  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
63  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
64  THE SOFTWARE.
65  -----------------------------------------------------------------------------
66  */
67 #ifndef _graphicsproceduralsharpenmodifier_cpp
68 #define _graphicsproceduralsharpenmodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/sharpenmodifier.h"
71 #include "Graphics/Procedural/Texture/convolutionmodifier.h"
72 
73 #include "MathTools/mathtools.h"
74 
75 namespace Mezzanine
76 {
77  namespace Graphics
78  {
79  namespace Procedural
80  {
82  Type(ST_Normal),
83  SharpenBlockSize(5),
84  SharpenSigma(92)
85  { }
86 
88  { }
89 
90  ///////////////////////////////////////////////////////////////////////////////
91  // Utility
92 
94  {
95  ConvolutionModifier Filter;
96  switch(this->Type)
97  {
98  default:
99  case ST_Normal:
100  {
101  Filter.SetKernel( Matrix3x3(0.0f,-1.0f,0.0f,-1.0f,5.0f,-1.0f,0.0f,-1.0f,0.0f) ).CalculateDivisor();
102  break;
103  }
104  case ST_Gaussian:
105  {
106  Real fSigma = 0.5f + ( (5.0f - 0.5f) / 255.0f ) * static_cast<Real>(this->SharpenSigma);
107  Integer Radius = static_cast<Integer>(this->SharpenBlockSize) / 2;
108  Real Min = MathTools::Exp( static_cast<Real>(2 * Radius * Radius) / (-2.0 * fSigma * fSigma) ) / (MathTools::GetTwoPi() * fSigma * fSigma);
109  Integer* Kernel = new Integer[ this->SharpenBlockSize * this->SharpenBlockSize ];
110  Integer Sum = 0;
111  Integer Y = -Radius;
112  Integer X = -Radius;
113  for( Integer i = 0 ; i < this->SharpenBlockSize ; i++ )
114  {
115  for( Integer j = 0 ; j < this->SharpenBlockSize ; j++ )
116  {
117  Kernel[ i * this->SharpenBlockSize + j ] = static_cast<Integer>( ( MathTools::Exp( static_cast<Real>( X * X + Y * Y ) / ( -2.0 * fSigma * fSigma ) ) / ( MathTools::GetTwoPi() * fSigma * fSigma ) ) / Min );
118  Sum += Kernel[ i * this->SharpenBlockSize + j ];
119  X++;
120  }
121  Y++;
122  }
123  Integer c = static_cast<Integer>(this->SharpenBlockSize) >> 1;
124  Integer Divisor = 0;
125  for( Integer i = 0 ; i < this->SharpenBlockSize ; i++ )
126  {
127  for( Integer j = 0 ; j < this->SharpenBlockSize ; j++ )
128  {
129  if( (i == c) && (j == c) ) {
130  Kernel[ i * this->SharpenBlockSize + j ] = 2 * Sum - Kernel[ i * this->SharpenBlockSize + j ];
131  }else{
132  Kernel[ i * this->SharpenBlockSize + j ] = -Kernel[ i * this->SharpenBlockSize + j ];
133  }
134  Divisor += Kernel[ i * this->SharpenBlockSize + j ];
135  }
136  }
137  Filter.SetKernel(this->SharpenBlockSize,Kernel).SetDivisor( static_cast<Real>(Divisor) );
138  delete[] Kernel;
139  break;
140  }
141  }
142  Filter.SetIncludeAlphaChannel(true).Modify(Buffer);
143  }
144 
146  { return "SharpenModifier"; }
147 
148  ///////////////////////////////////////////////////////////////////////////////
149  // Configuration
150 
152  { this->Type = Sharpen; return *this; }
153 
155  { this->SharpenBlockSize = Size; return *this; }
156 
158  { this->SharpenSigma = Sigma; return *this; }
159  }//Procedural
160  }//Graphics
161 }//Mezzanine
162 
163 #endif
This is a 3x3 Matrix class used for representing rotations and scaling in an object.
Definition: matrix3x3.h:62
virtual String GetName() const
Gets the name of this modifier.
int Integer
A datatype used to represent any integer close to.
Definition: datatypes.h:154
UInt8 SharpenSigma
The weight surrounding pixels of the processing pixel have, with further pixels in the sample block g...
uint8_t UInt8
An 8-bit unsigned integer.
Definition: datatypes.h:118
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
A modifier that will attempt to add detail to a texture.
UInt8 SharpenBlockSize
The size of the block of pixels around each pixel to be processed that will be sampled.
SharpenType Type
The type of Sharpening operation that will be performed.
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
ConvolutionModifier & SetIncludeAlphaChannel(const Boole IncludeAlpha)
Sets if the alpha channel of each pixel should be processed.
ConvolutionModifier & SetDivisor(const Real Div)
Sets a custom divisor that will be applied to the result of the pixel to help keep the value within a...
SharpenModifier & SetSharpenType(const SharpenType Sharpen)
Sets the type of sharpening operation to be used.
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
ConvolutionModifier & CalculateDivisor()
Automatically generates a sane divisor for pixel processing.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
A modifier that will calculate each pixel in an image to be a weighed sum of itself and it's neighbor...
Use a gaussian filter to sharpen the image.
ConvolutionModifier & SetKernel(const UInt8 Size, Real *Data)
Sets the matrix that determines how each pixel neighbor is to be weighed when processing each pixel...
SharpenModifier & SetSigma(const UInt8 Sigma)
Sets the sigma for each each pixel to be processed.
SharpenModifier & SetBlockSize(const UInt8 Size)
Sets the sample size for each pixel to be processed.
Use a simple block filter to sharpen the image.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
SharpenType
An enum used to describe the type of sharpening operation to be performed.