Class: Magick::KernelInfo
- Inherits:
-
Object
- Object
- Magick::KernelInfo
- Defined in:
- ext/RMagick/rmmain.c
Class Method Summary collapse
-
.builtin(what, geometry) ⇒ Magick::KernelInfo
Create new instance of KernelInfo with one of the ‘named’ built-in types of kernels used for special purposes such as gaussian blurring, skeleton pruning, and edge distance determination.
Instance Method Summary collapse
-
#clone ⇒ Magick::KernelInfo
Creates a new clone of the object so that its can be modified without effecting the original.
-
#dup ⇒ Magick::KernelInfo
Creates a new clone of the object so that its can be modified without effecting the original.
-
#initialize(kernel_string) ⇒ Magick::KernelInfo
constructor
KernelInfo object constructor.
-
#scale(scale, flags) ⇒ Object
Scales the given kernel list by the given amount, with or without normalization of the sum of the kernel values (as per given flags).
-
#scale_geometry(geometry) ⇒ Object
Takes a geometry argument string, typically provided as a -set option:convolve:scale {geometry} user setting, and modifies the kernel according to the parsed arguments of that setting.
-
#unity_add(scale) ⇒ Object
Adds a given amount of the ‘Unity’ Convolution Kernel to the given pre-scaled and normalized Kernel.
Constructor Details
#initialize(kernel_string) ⇒ Magick::KernelInfo
KernelInfo object constructor
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'ext/RMagick/rmkinfo.c', line 78
VALUE
KernelInfo_initialize(VALUE self, VALUE kernel_string)
{
KernelInfo *kernel;
#if defined(IMAGEMAGICK_7)
ExceptionInfo *exception;
#endif
Check_Type(kernel_string, T_STRING);
#if defined(IMAGEMAGICK_7)
exception = AcquireExceptionInfo();
kernel = AcquireKernelInfo(StringValueCStr(kernel_string), exception);
if (rm_should_raise_exception(exception, DestroyExceptionRetention))
{
if (kernel != (KernelInfo *) NULL)
{
DestroyKernelInfo(kernel);
}
rm_raise_exception(exception);
}
#else
kernel = AcquireKernelInfo(StringValueCStr(kernel_string));
#endif
if (!kernel)
{
rb_raise(rb_eRuntimeError, "failed to parse kernel string");
}
DATA_PTR(self) = kernel;
return self;
}
|
Class Method Details
.builtin(what, geometry) ⇒ Magick::KernelInfo
Create new instance of KernelInfo with one of the ‘named’ built-in types of kernels used for special purposes such as gaussian blurring, skeleton pruning, and edge distance determination.
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'ext/RMagick/rmkinfo.c', line 193
VALUE
KernelInfo_builtin(VALUE self, VALUE what, VALUE geometry)
{
KernelInfo *kernel;
KernelInfoType kernel_type;
GeometryInfo info;
#if defined(IMAGEMAGICK_7)
ExceptionInfo *exception;
#endif
Check_Type(geometry, T_STRING);
VALUE_TO_ENUM(what, kernel_type, KernelInfoType);
ParseGeometry(StringValueCStr(geometry), &info);
#if defined(IMAGEMAGICK_7)
exception = AcquireExceptionInfo();
kernel = AcquireKernelBuiltIn(kernel_type, &info, exception);
if (rm_should_raise_exception(exception, DestroyExceptionRetention))
{
if (kernel != (KernelInfo *) NULL)
{
DestroyKernelInfo(kernel);
}
rm_raise_exception(exception);
}
#else
kernel = AcquireKernelBuiltIn(kernel_type, &info);
#endif
if (!kernel)
{
rb_raise(rb_eRuntimeError, "failed to acquire builtin kernel");
}
return TypedData_Wrap_Struct(self, &rm_kernel_info_data_type, kernel);
}
|
Instance Method Details
#clone ⇒ Magick::KernelInfo
Creates a new clone of the object so that its can be modified without effecting the original.
177 178 179 180 181 182 |
# File 'ext/RMagick/rmkinfo.c', line 177
VALUE
KernelInfo_clone(VALUE self)
{
KernelInfo *kernel = CloneKernelInfo((KernelInfo*)DATA_PTR(self));
return TypedData_Wrap_Struct(Class_KernelInfo, &rm_kernel_info_data_type, kernel);
}
|
#dup ⇒ Magick::KernelInfo
Creates a new clone of the object so that its can be modified without effecting the original.
177 178 179 180 181 182 |
# File 'ext/RMagick/rmkinfo.c', line 177
VALUE
KernelInfo_clone(VALUE self)
{
KernelInfo *kernel = CloneKernelInfo((KernelInfo*)DATA_PTR(self));
return TypedData_Wrap_Struct(Class_KernelInfo, &rm_kernel_info_data_type, kernel);
}
|
#scale(scale, flags) ⇒ Object
Scales the given kernel list by the given amount, with or without normalization of the sum of the kernel values (as per given flags).
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'ext/RMagick/rmkinfo.c', line 139
VALUE
KernelInfo_scale(VALUE self, VALUE scale, VALUE flags)
{
GeometryFlags geoflags;
if (!FIXNUM_P(scale))
Check_Type(scale, T_FLOAT);
if (rb_obj_is_instance_of(flags, Class_GeometryFlags))
VALUE_TO_ENUM(flags, geoflags, GeometryFlags);
else
rb_raise(rb_eArgError, "expected Integer or Magick::GeometryFlags to specify flags");
GVL_STRUCT_TYPE(ScaleKernelInfo) args = { (KernelInfo*)DATA_PTR(self), NUM2DBL(scale), geoflags };
CALL_FUNC_WITHOUT_GVL(GVL_FUNC(ScaleKernelInfo), &args);
return Qnil;
}
|
#scale_geometry(geometry) ⇒ Object
Takes a geometry argument string, typically provided as a -set option:convolve:scale {geometry} user setting, and modifies the kernel according to the parsed arguments of that setting.
163 164 165 166 167 168 169 170 |
# File 'ext/RMagick/rmkinfo.c', line 163
VALUE
KernelInfo_scale_geometry(VALUE self, VALUE geometry)
{
Check_Type(geometry, T_STRING);
GVL_STRUCT_TYPE(ScaleGeometryKernelInfo) args = { (KernelInfo*)DATA_PTR(self), StringValueCStr(geometry) };
CALL_FUNC_WITHOUT_GVL(GVL_FUNC(ScaleGeometryKernelInfo), &args);
return Qnil;
}
|
#unity_add(scale) ⇒ Object
Adds a given amount of the ‘Unity’ Convolution Kernel to the given pre-scaled and normalized Kernel.
119 120 121 122 123 124 125 126 127 128 |
# File 'ext/RMagick/rmkinfo.c', line 119
VALUE
KernelInfo_unity_add(VALUE self, VALUE scale)
{
if (!FIXNUM_P(scale))
Check_Type(scale, T_FLOAT);
GVL_STRUCT_TYPE(UnityAddKernelInfo) args = { (KernelInfo*)DATA_PTR(self), NUM2DBL(scale) };
CALL_FUNC_WITHOUT_GVL(GVL_FUNC(UnityAddKernelInfo), &args);
return Qnil;
}
|