Blame - www/architecture.html - platform/external/ImageMagick

<p class="navigation-index">[<a href="#overview">Architecture Overview</a> • <a href="#cache">The Pixel Cache</a> • <a href="#stream">Streaming Pixels</a> • <a href="#properties">Image Properties and Profiles</a> • <a href="#threads">Threads of Execution</a> • <a href="#coders">Custom Image Coders</a> • <a href="#filters">Custom Image Filters</a>]</p>

154

155

156

<p>The citizens of Oz were quite content with their benefactor, the all-powerful Wizard. They accepted his wisdom and benevolence without ever questioning the who, why, and where of his power. Like the citizens of Oz, if you feel comfortable that ImageMagick can help you convert, edit, or compose your images without knowing what goes on behind the curtain, feel free to skip this section. However, if you want to know more about the software and algorithms behind ImageMagick, read on. To fully benefit from this discussion, you should be comfortable with image nomenclature and be familiar with computer programming.</p>

157

</div>

158

159

<h2><a name="overview"></a>Architecture Overview</h2>

160

161

162

<p>An image typically consists of a rectangular region of pixels and metadata. To convert, edit, or compose an image in an efficient manner we need convenient access to any pixel anywhere within the region (and sometimes outside the region). And in the case of an image sequence, we need access to any pixel of any region of any image in the sequence. However, there are hundreds of image formats such JPEG, TIFF, PNG, GIF, etc., that makes it difficult to access pixels on demand. Within these formats we find differences in:</p>

163

164

<ul>

165

<li>colorspace (e.g RGB, CMYK, YUV, Lab, etc.)</li>

166

<li>bit depth (.e.g 1, 4, 8, 12, 16, etc.)</li>

167

<li>storage format (e.g. unsigned, signed, float, double, etc.)</li>

168

<li>compression (e.g. uncompressed, RLE, Zip, BZip, etc.)</li>

169

<li>orientation (i.e. top-to-bottom, right-to-left, etc.),</li>

170

<li>layout (.e.g. raw, interspersed with opcodes, etc.)</li>

171

</ul>

172

173

<p>In addition, some image pixels may require attenuation, some formats permit more than one frame, and some formats contain vector graphics that must first be rasterized (converted from vector to pixels).</p>

174

175

<p>An efficient implementation of an image processing algorithm may require we get or set:</p>

176

177

<ul>

178

<li>one pixel a time (e.g. pixel at location 10,3)</li>

179

<li>a single scanline (e.g. all pixels from row 4)</li>

180

<li>a few scanlines at once (e.g. pixel rows 4-7)</li>

181

<li>a single column or columns of pixels (e.g. all pixels from column 11)</li>

182

<li>an arbitrary region of pixels from the image (e.g. pixels defined at 10,7 to 10,19)</li>

183

<li>a pixel in random order (e.g. pixel at 14,15 and 640,480)</li>

184

<li>pixels from two different images (e.g. pixel at 5,1 from image 1 and pixel at 5,1 from image 2)</li>

185

<li>pixels outside the boundaries of the image (e.g. pixel at -1,-3)</li>

186

<li>a pixel component that is unsigned or in a floating-point representation (e.g. 0.17836)</li>

187

<li>a high-dynamic range pixel that can include negative values as well as values that exceed the quantum depth (e.g. -0.00716)</li>

188

<li>one or more pixels simultaneously in different threads of execution</li>

189

</ul>

190

191

<p>In addition, some images include a clip mask that define which pixels are eligible to be updated. Pixels outside the area defined by the clip mask remain untouched.</p>

192

193

<p>Given the varied image formats and image processing requirements, we implemented the ImageMagick <a href="#cache">pixel cache</a> to provide convenient sequential or parallel access to any pixel on demand anywhere inside the image region and from any image in a sequence. In addition, the pixel cache permits access to pixels outside the boundaries defined by the image (we call these <a href="#virtual-pixels">virtual pixels</a>).</p>

194

195

<p>In addition to pixels, images have a plethora of <a href="#properties">image properties and profiles</a>. Properties include the well known items such as width, height, depth, and colorspace. An image may have optional properties which might include the image author, a comment, a create date, and others. Some images also include profiles for color management, or EXIF, IPTC, 8BIM, or XMP informational profiles. ImageMagick provides command line options and programming methods to get, set, or view image properties or profiles or apply profiles.</p>

196

197

<p>ImageMagick consists of more than 375,000 lines of C code and optionally depends on several million lines of code in dependent libraries (e.g. JPEG, PNG, TIFF libraries). Given that, one might expect a huge architecture document. However, a great majority of image processing is simply accessing pixels and its metadata and our simple and elegant implementation makes this easy for the ImageMagick developer. We discuss the implementation of the pixel cache and getting and setting image properties and profiles in the next few sections. Next, we discuss using ImageMagick within a <a href="#threads">thread</a> of execution. In the final sections, we discuss <a href="#coders">image coders</a> to read or write a particular image format followed by a few words on creating a <a href="#filters">filter</a> to access or update pixels based on your custom requirements.</p>

</div>

<h2><a name="cache"></a>The Pixel Cache</h2>

202

203

204

<p>The ImageMagick pixel cache is a repository for image pixels with up to 5 channels. The first 4 channels are stored contiguously and an optional second area follows with 1 channel. The channels are at the depth specified when ImageMagick was built. The channel depths are 8 bits-per-pixel component for the Q8 version of ImageMagick, 16 bits-per-pixel component for the Q16 version, and 32 bits-per-pixel component for the Q32 version. By default pixel components are unsigned quantities, however, if you use the <a href="../www/high-dynamic-range.html">high dynamic-range</a> version of ImageMagick, the components are 32-bit floating point. The primary 4 channels can hold any value but typically contain red, green, blue, and alpha intensities or cyan, magenta, yellow, and alpha intensities. The optional fifth channel contains the colormap indexes for colormapped images or the black channel for CMYK images. The pixel cache storage may be heap memory, anonymous memory mapped memory, disk-backed memory mapped, or on disk. The pixel cache is reference-counted. Only the cache properties are copied when the cache is cloned. The cache pixels are subsequently copied when you signal your intention to update any of the pixels.</p>

205

206

<h3>Create the Pixel Cache</h3>

207

208

209

<p>The pixel cache is associated with an image when it is created and it is initialized when you try to get or put pixels. Here are three common methods to associate a pixel cache with an image:</p>

210

211

<h4>Create an image canvas initialized to the background color:</h4>

212

213

image=AllocateImage(image_info);

214

if (SetImageExtent(image,640,480) == MagickFalse)

215

{ /* an exception was thrown */ }

216

(void) QueryMagickColor("red",&image->background_color,&image->exception);

217

SetImageBackgroundColor(image);

218

</p>

219

220

<h4>Create an image from a JPEG image on disk:</h4>

221

<p class="code"> (void) strcpy(image_info->filename,"image.jpg"):

222

image=ReadImage(image_info,exception);

223

if (image == (Image *) NULL)

224

{ /* an exception was thrown */ }

225

</p>

226

<h4>Create an image from a memory based image:</h4>

227

228

image=BlobToImage(blob_info,blob,extent,exception);

229

if (image == (Image *) NULL)

230

{ /* an exception was thrown */ }

231

</p>

232

233

<p>In our discussion of the pixel cache we use the <a href="../www/magick-core.html">MagickCore API</a> to illustrate our points, however, the principles are the same for other program interfaces to ImageMagick.</p>

234

235

<p>When the pixel cache is initialized, pixels are scaled from whatever bit depth they originated from to that required by the pixel cache. For example, a 1-channel 1-bit monochrome PBM image is scaled to a 4 channel 8-bit RGBA image, if you are using the Q8 version of ImageMagick, and 16-bit RGBA for the Q16 version. You can determine which version you have using the <a href="../www/command-line-options.html#version">‑version</a> option, as with this command: </p>

236

cristy

d3ef010

2009-09-12 18:11:06 +0000

[diff] [blame]

237

<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>identify -version</span><span class='crtout'>Version: ImageMagick 6.5.5-10 2009-09-10 Q16 http://www.imagemagick.org</span></p>

cristy

3ed852e

2009-09-05 21:47:34 +0000

[diff] [blame]

238

<p>As you can see, the convenience of the pixel cache sometimes comes with a trade-off in storage (e.g. storing a 1-bit monochrome image as 16-bit RGBA is wasteful) and speed (i.e. storing the entire image in memory is generally slower than accessing one scanline of pixels at a time).</p>

239

</div>

240

241

<h3>Access the Pixel Cache</h3>

242

243

244

<p>Once the pixel cache is associated with an image, you typically want to get, update, or put pixels into it. We refer to pixels inside the image region as <em>authentic pixels</em> and outside the region as <em>virtual pixels</em>. Use these methods to access the pixels in the cache:</p>

245

<ul>

246

<li><a href="../www/api/cache.html#GetVirtualPixels">GetVirtualPixels()</a> gets pixels that you do not intend to modify</li>

247

<li><a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> gets pixels that you intend to modify</li>

248

<li><a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> queue pixels that you intend to modify</li>

249

<li><a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> update the pixel cache with any modified pixels</li>

250

</ul>

251

252

<p>Here is a typical <a href="../www/magick-core.html">MagickCore</a> code snippet for manipulating pixels in the pixel cache. In our example we copy pixels from the input image to the output image and decrease the intensity by 10%:</p>

long

x,

y;

const PixelPacket

*p;

PixelPacket

*q;

destination=CloneImage(source,source->columns,source->rows,MagickTrue,exception);

267

if (destination == (Image *) NULL)

268

{ /* an exception was thrown */ }

269

for (y=0; y < (long) source->rows; y++)

270

{

271

p=GetVirtualPixels(source,0,y,source->columns,1,exception);

272

q=GetAuthenticPixels(destination,0,y,destination->columns,1,exception);

273

if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL)

274

break;

275

for (x=0; x < (long) source->columns; x++)

276

{

277

q->red=90*p->red/100;

278

q->green=90*p->green/100;

279

q->blue=90*p->blue/100;

280

q->opacity=90*p->opacity/100;

p++;

q++;

}

if (SyncAuthenticPixels(destination,exception) == MagickFalse)

285

break;

286

}

287

if (y < (long) source->rows)

288

{ /* an exception was thrown */ }

</pre>

</div>

<p>When we first create the destination image by cloning the source image, the pixel cache pixels are not copied. They are only copied when you signal your intentions to modify the pixel cache by calling <a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> or <a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a>. Use <a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> if you want to set new pixel values rather than update existing ones. Finally, use <a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> to ensure any updated pixels are pushed to the pixel cache.</p>

293

294

<p>Recall how we mentioned that the indexes of a colormapped image or the black channel of a CMYK image are stored separately. Use <a href="../www/api/cache.html#GetVirtualIndexes">GetVirtualIndexes()</a> (to read the indexes) or <a href="../www/api/cache.html#GetAuthenticIndexes">GetAuthenticIndexes()</a> (to update the indexes) to gain access to this channel. For example, to print the colormap indexes, use:</p>

const IndexPacket

*indexes;

for (y=0; y < (long) source->rows; y++)

301

{

302

p=GetVirtualPixels(source,0,y,source->columns,1);

303

if (p == (const PixelPacket *) NULL)

304

break;

305

indexes=GetVirtualIndexes(source);

306

for (x=0; x < (long) source->columns; x++)

307

(void) printf("%d\n",indexes[x];

308

}

309

if (y < (long) source->rows)

310

/* an exception was thrown */

311

</pre>

312

313

<p>The pixel cache manager decides whether to give you direct or indirect access to the image pixels. In some cases the pixels are staged to an intermediate buffer-- and that is why you must call SyncAuthenticPixels() to ensure this buffer is <em>pushed</em> out to the pixel cache to guarantee the corresponding pixels in the cache are updated. For this reason we recommend that you only read or update a scanline or a few scanlines of pixels at a time. However, you can get any rectangular region of pixels you want. GetAuthenticPixels() requires that the region you request is within the bounds of the image area. For a 640 by 480 image, you can get a scanline of 640 pixels but if you ask for 641 pixels, an exception is returned. GetVirtualPixels() does not have this constraint. For example,</p>

314

315

316

p=GetVirtualPixels(source,-3,3,source->columns+7,7,exception);

317

</pre>

318

319

<p>gives you the pixels you asked for without complaint, even though some are not within the confines of the image region.</p>

320

</div>

321

322

<h3><a name="virtual-pixels"></a>Virtual Pixels</h3>

323

324

325

<p>Access to the virtual pixels are controlled by the <a href="../www/api/cache.html#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod()</a> method from the MagickCore API or the <a href="../www/command-line-options.html#virtual-pixel">‑virtual‑pixel</a> option from the command line. The methods include:</p>

326

327

328

background: the area surrounding the image is the background color

329

black: the area surrounding the image is black

330

checker-tile: alternate squares with image and background color

331

dither: non-random 32x32 dithered pattern

332

edge: extend the edge pixel toward infinity

333

gray: the area surrounding the image is gray

334

horizontal-tile: horizontally tile the image, background color above/below

335

horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels

336

mirror: mirror tile the image

337

random: choose a random pixel from the image

338

tile: tile the image (default)

339

transparent: the area surrounding the image is transparent blackness

340

vertical-tile: vertically tile the image, sides are background color

341

vertical-tile-edge: vertically tile the image and replicate the side edge pixels

342

white: the area surrounding the image is white

343

</pre>

344

345

<p>There is a plethora of image processing algorithms that require a neighborhood of pixels about a pixel of interest. There is typically a caveat concerning how to handle pixels around the image boundaries, known as edge pixels. With virtual pixels, you do not need to concern yourself about special edge processing other than choosing which virtual pixel method is most appropriate for your algorithm.</p>

346

</div>

347

348

<h3>Cache Storage and Resource Requirements</h3>

349

350

351

<p>We mentioned previously that this simple and elegant design of the ImageMagick pixel cache comes at a cost in terms of storage and processing speed. The pixel cache storage requirements scales with the area of the image and the bit depth of the pixel components. For example, if we have a 640 by 480 image and we're using the Q16 version of ImageMagick, the pixel cache consumes image <em>width * height * bit-depth / 8 * channels</em> bytes or approximately 2.3 megabytes (i.e. 640 * 480 * 2 * 4). Not too bad, but what if your image is 25000 by 25000 pixels? The pixel cache requires approximately 4.7 gigabytes of storage. Ouch. ImageMagick accounts for possible huge storage requirements by caching large images to disk rather than memory. Typically the pixel cache is stored in memory using heap memory. If heap memory is exhausted, pixels are stored in in an anonymous map; if the anonymous memory map is exhausted, we create the pixel cache on disk and attempt to memory-map it; and if memory-map memory is exhausted, we simply use standard disk I/O. Disk storage is cheap but it is also very slow, upwards of 1000 times slower than memory. We can get some speed improvements, up to 5 times, if we use memory mapping to the disk-based cache. These decisions about storage are made <em>automagically</em> by the pixel cache manager negotiating with the operating system. However, you can influence how the pixel cache manager allocates the pixel cache with <em>cache resource limits</em>. The limits include:</p>

352

353

354

<dt class="doc">files</dt>

355

<dd>maximum number of open pixel cache files. When this limit is exceeded, any subsequent pixels cached to disk are closed and reopened on demand. This behavior permits a large number of images to be accessed simultaneously on disk, but with a speed penalty due to repeated open/close calls.</dd>

356

357

<dd>maximum area in bytes of any one image that can reside in the pixel cache memory. If this limit is exceeded, the image is automagically cached to disk.</dd>

358

<dt class="doc">memory</dt>

359

<dd>maximum amount of memory in bytes to allocate for the pixel cache from the anonymous mapped memory or the heap.</dd>

360

361

<dd>maximum amount of memory map in bytes to allocate for the pixel cache.</dd>

362

363

<dd>maximum amount of disk space in bytes permitted for use by the pixel cache. If this limit is exceeded, the pixel cache is not created and a fatal exception is thrown.</dd>

364

</dl>

365

366

<p>To determine the current setting of these limits, use this command:</p>

367

368

<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>identify -list resource</span><span class='crtout'><pre>File Area Memory Map Disk Thread Time

369

-------------------------------------------------------------------

370

768 3.8187gb 2.864gb 7.6375gb 16eb 2 unlimited</pre></span></p>

371

<p>You can set these limits either with <a href="../www/resources.html#environment">environment variables</a>, the <a href="../www/command-line-options.html#limit">-limit</a> command line option, or the <a href="../www/api/resource.html#SetMagickResourceLimit">SetMagickResourceLimit()</a> MagickCore API method. As an example, our online web interface to ImageMagick, <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">ImageMagick Studio</a>, has an area limit of 64 megabytes, a memory limit of 128 megabytes and a map limit of 256 megabytes and a disk limit of 1 gigabytes. Since we process multiple simultaneous sessions, we don't want any one session consuming all the available memory. Instead large images are cached to disk. If the image is too large and exceeds the pixel cache disk limit, the program exits. In addition, we place a 60 second time limit to prevent any run-away processing tasks.</p>

372

373

<p>Note, the cache limits are global, meaning if you create several images, the combined resource requirements are compared to the limit to determine the pixel cache storage disposition.</p>

</div>

<h3>Cache Views</h3>

<p>GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), and SyncAuthenticPixels() from the MagickCore API can only deal with one pixel cache area per image at a time. Suppose you want to access the first and last scanline from the same image at the same time? The solution is to use a <em>cache view</em>. A cache view permits you to access as many areas simultaneously in the pixel cache as you require. The cache view <a href="../www/api/cache-view.html">methods</a> behave like the previous methods except you must first open a view and close it when you are finished with it. Here is a snippet of MagickCore code that permits us to access two areas of an image simultaneously:</p>

CacheView

*view_1,

*view_2;

view_1=OpenCacheView(source);

387

view_2=OpenCacheView(source);

388

for (y=0; y < (long) source->rows; y++)

389

{

390

u=GetCacheViewVirtualPixels(view_1,0,y,source->columns,1,exception);

391

v=GetCacheViewVirtualPixels(view_2,0,source->rows-y-1,source->columns,1,exception);

392

if ((u == (const PixelPacket *) NULL) || (v == (const PixelPacket *) NULL))

393

break;

394

for (x=0; x < (long) source->columns; x++)

395

{

396

/* do something with u & v here */

397

}

398

}

399

view_1=CloseCacheView(view_1);

400

view_2=CloseCacheView(view_2);

401

if (y < (long) source->rows)

402

{ /* an exception was thrown */ }

</pre>

</div>

<h3>Magick Persistent Cache Format</h3>

407

408

409

<p>Recall that each image format is decoded by ImageMagick and the pixels are deposited in the pixel cache. If you write an image, the pixels are read from the pixel cache and encoded as required by the format you are writing (e.g. GIF, PNG, etc.). The Magick Persistent Cache (MPC) format is designed to eliminate the overhead of decoding and encoding pixels to and from an image format. MPC writes two files. One, with the extension <kbd>.mpc</kbd>, retains all the properties associated with the image or image sequence (e.g. width, height, colorspace, etc.) and the second, with the extension <kbd>.cache</kbd>, is the pixel cache in the native format. When reading an MPC image file, ImageMagick reads the image properties and memory maps the pixel cache on disk eliminating the need for decoding the image pixels. The tradeoff is in disk space. MPC is generally larger in file size than most other image formats.</p>

410

</div>

411

412

<h3>Best Practices</h3>

413

414

415

<p>Although you can request any pixel from the pixel cache, any block of pixels, any scanline, multiple scanlines, any row, or multiple rows with the GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels, GetCacheViewVirtualPixels(), GetCacheViewAuthenticPixels(), and QueueCacheViewAuthenticPixels() methods, ImageMagick is optimized to return a few pixels or a few pixels rows at time. There are additional optimizations if you request a single scanline or a few scanlines at a time. These methods also permit random access to the pixel cache, however, ImageMagick is optimized for sequential access.</p>

416

417

<p>If you update pixels returned from GetAuthenticPixels() or GetCacheViewAuthenticPixels(), don't forget to call SyncAuthenticPixels() or SyncCacheViewAuthenticPixels() respectively to ensure your changes are synchronized with the pixel cache.</p>

418

419

<p>Use QueueAuthenticPixels() or QueueCacheViewAuthenticPixels() if you are setting an initial pixel value. The GetAuthenticPixels() or GetCacheViewAuthenticPixels() method reads pixels from the cache and if you are setting an initial pixel value, this read is unnecessary. Don't forget to call SyncAuthenticPixels() or SyncCacheViewAuthenticPixels() respectively to push your updates to the pixel cache.</p>

420

421

<p>GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), and SyncAuthenticPixels() are slightly more efficient than their cache view counter-parts. However, cache views are required if you need access to more than one region of the image simultaneously or if more than one <a href="#threads">thread of execution</a> is accessing the image.</p>

422

423

<p>You can request pixels outside the bounds of the image with GetVirtualPixels() or GetCacheViewVirtualPixels(), however, it is more efficient to request pixels within the confines of the image region.</p>

424

425

<p>Although you can force the pixel cache to disk using appropriate resource limits, disk access can be upwards of 1000 times slower than memory access. For fast, efficient, access to the pixel cache, try to keep the pixel cache in heap memory or anonymous mapped memory.</p>

426

427

<p>The ImageMagick Q16 version of ImageMagick permits you to read and write 16 bit images without scaling but the pixel cache consumes twice as much resources as the Q8 version. If your system has constrained memory or disk resources, consider the Q8 version of ImageMagick. In addition, the Q8 version typically executes faster than the Q16 version.</p>

428

429

<p>A great majority of image formats and algorithms restrict themselves to a fixed range of pixel values from 0 to some maximum value, for example, the Q16 version of ImageMagick permit intensities from 0 to 65535. High dynamic-range imaging (HDRI), however, permits a far greater dynamic range of exposures (i.e. a large difference between light and dark areas) than standard digital imaging techniques. HDRI accurately represents the wide range of intensity levels found in real scenes ranging from the brightest direct sunlight to the deepest darkest shadows. Enable <a href="../www/high-dynamic-range.html">HDRI</a> at ImageMagick build time to deal with high dynamic-range images, but be mindful that each pixel component is a 32-bit floating point value. In addition pixel values are not clamped so some algorithms may perform differently than the non-HDRI version.</p>

430

431

<p>If you are dealing with large images, make sure the pixel cache is written to a disk area with plenty of free space. Under Unix, this is typically <kbd>/tmp</kbd> and for Windows, <kbd>c:/temp</kbd>. You can tell ImageMagick to write the pixel cache to an alternate location with the MAGICK_TMPDIR environment variable. For example,</p>

432

433

<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>export MAGICK_TMPDIR=/data/magick</span></p>

434

435

<p>If you plan on processing the same image many times, consider the MPC format. Reading a MPC image has near-zero overhead because its in the native pixel cache format eliminating the need for decoding the image pixels. Here is an example:</p>

436

437

<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.tif image.mpc</span><span class='crtout'></span><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.mpc -crop 100x100+0+0 +repage 1.png</span><span class='crtout'></span><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.mpc -crop 100x100+100+0 +repage 2.png</span><span class='crtout'></span><span class="crtprompt"> $magick> </span><span class='crtin'>convert image.mpc -crop 100x100+200+0 +repage 3.png</span></p>

438

<p>MPC is ideal for web sites. It reduces the overhead of reading and writing an image. We use it exclusively at our <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">online image studio</a>.</p>

</div>

</div>

<h2><a name="stream"></a>Streaming Pixels</h2>

444

445

446

<p>ImageMagick provides for streaming pixels as they are read from or written to an image. This has several advantages over the pixel cache. The time and resources consumed by the pixel cache scale with the area of an image, whereas the pixel stream resources scale with the width of an image. The disadvantage is the pixels must be consumed as they are streamed so there is no persistence.</p>

447

448

<p>Use <a href="../www/api/stream.html#ReadStream">ReadStream()</a> or <a href="../www/api/stream.html#WriteStream">WriteStream()</a> with an appropriate callback method in your MagickCore program to consume the pixels as they are streaming. Here's an abbreviated example of using ReadStream:</p>

449

450

451

static size_t StreamHandler(const Image *image,const void *pixels,

452

const size_t columns)

453

{

454

/* process pixels here */

return(columns);

}

...

/* invoke the pixel stream here */

460

image=ReadStream(image_info,&StreamHandler,exception);

461

</pre>

462

463

<p>We also provide a lightweight tool, <a name="stream"></a><a href="../www/stream.html">stream</a>, to stream one or more pixel components of the image or portion of the image to your choice of storage formats. It writes the pixel components as they are read from the input image a row at a time making <a name="stream"></a><a href="../www/stream.html">stream</a> desirable when working with large images or when you require raw pixel components.</p>

</div>

<h2><a name="properties"></a>Image Properties and Profiles</h2>

468

469

470

<p>Images have metadata associated with them in the form of properties (e.g. width, height, description, etc.) and profiles (e.g. EXIF, IPTC, color management). ImageMagick provides convenient methods to get, set, or update image properties and get, set, update, or apply profiles. Some of the more popular image properties are associated with the Image structure in the MagickCore API. For example:</p>

471

472

473

(void) printf("image width: %lu, height: %lu\n",image->columns,image->rows);

474

</pre>

475

476

<p>For a great majority of image properties, such as an image comment or description, we use the <a href="../www/api/property.html#GetImageProperty">GetImageProperty()</a> and <a href="../www/api/property.html#SetImageProperty">SetImageProperty()</a> methods. Here we set a property and fetch it right back:</p>

const char

*comment;

(void) SetImageProperty(image,"comment","This space for rent");

483

comment=GetImageProperty(image,"comment");

484

if (comment == (const char *) NULL)

485

(void) printf("Image comment: %s\n",comment);

486

</pre>

487

488

<p>Image profiles are handled with <a href="../www/api/profile.html#GetImageProfile">GetImageProfile()</a>, <a href="../www/api/profile.html#SetImageProfile">SetImageProfile()</a>, and <a href="../www/api/profile.html#ProfileImage">ProfileImage()</a> methods. Here we set a profile and fetch it right back:</p>

StringInfo

*profile;

profile=AcquireStringInfo(length);

495

SetStringInfoDatum(profile,my_exif_profile);

496

(void) SetImageProfile(image,"EXIF",profile);

497

DestroyStringInfo(profile);

498

profile=GetImageProfile(image,"EXIF");

499

if (profile != (StringInfo *) NULL)

500

(void) PrintStringInfo(stdout,"EXIF",profile);

</pre>

</div>

<h2><a name="threads"></a>Threads of Execution</h2>

506

507

508

<p>Many of ImageMagick's internal algorithms are threaded to take advantage of speed-ups offered by the dual and quad-core processor technologies. However, you are welcome to use ImageMagick algorithms in your threads of execution with the exception of the MagickCore's GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), or SyncAuthenticPixels() pixel cache methods. These methods are intended for one thread of execution only. To access the pixel cache with more than one thread of execution, use a cache view. We do this for the <a href="../www/api/composite.html#CompositeImage">CompositeImage()</a> method, for example. Suppose we want to composite a single image over a different image in each thread of execution. If we use GetVirtualPixels(), the results are unpredictable because multiple threads would likely be asking for different areas of the pixel cache simultaneously. Instead we use GetCacheViewVirtualPixels() which creates a unique view for each thread of execution ensuring our program behaves properly regardless of how many threads are invoked. The other program interfaces, such as the <a href="../www/magick-wand.html">MagickWand API</a>, are completely thread safe so there are no special precautions for threads of execution.</p>

509

510

<p>Here is an example of how ImageMagick can take advantage of threads of execution with the OpenMP programming paradigm:</p>

{

CacheView

*image_view;

long

y;

MagickBooleanType

status;

status=MagickTrue;

image_view=AcquireCacheView(image);

526

#pragma omp parallel for schedule(dynamic,4) shared(status)

527

for (y=0; y < (long) image->rows; y++)

{

register IndexPacket

*indexes;

register long

x;

register PixelPacket

*q;

if (status == MagickFalse)

539

continue;

540

q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);

541

if (q == (PixelPacket *) NULL)

{

status=MagickFalse;

continue;

}

indexes=GetCacheViewAuthenticIndexQueue(image_view);

547

for (x=0; x < (long) image->columns; x++)

{

q->red= ...

q->green= ...

q->blue= ...

q->opacity= ...

if (indexes != (IndexPacket *) NULL)

indexes[x]= ...

q++;

}

if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)

558

status=MagickFalse;

559

}

560

image_view=DestroyCacheView(image_view);

561

if (status == MagickFalse)

562

perror("something went wrong");

}

</pre>

</div>

<p>If you call the ImageMagick API from your OpenMP-enabled application and you intend to dynamically increase the number of threads available in subsequent parallel regions, be sure to perform the increase <em>before</em> you call the API otherwise ImageMagick may fault.</p>

</div>

<h2><a name="coders"></a>Custom Image Coders</h2>

572

573

574

<p>An image coder (i.e. encoder / decoder) is responsible for registering, optionally classifying, optionally reading, optionally writing, and unregistering one image format (e.g. PNG, GIF, JPEG, etc.). Registering an image coder alerts ImageMagick a particular format is available to read or write. While unregistering tells ImageMagick the format is no longer available. The classifying method looks at the first few bytes of an image and determines if the image is in the expected format. The reader sets the image size, colorspace, and other properties and loads the pixel cache with the pixels. The reader returns a single image or an image sequence (if the format supports multiple images per file), or if an error occurs, an exception and a null image. The writer does the reverse. It takes the image properties and unloads the pixel cache and writes them as required by the image format.</p>

575

576

<p>Here is a listing of a sample <a href="../www/source/mgk.c">custom coder</a>. It reads and writes images in the MGK image format which is simply an ID followed by the image width and height followed by the RGB pixel values.</p>

/*

Include declarations.

582

*/

583

#include "magick/studio.h"

584

#include "magick/blob.h"

585

#include "magick/blob-private.h"

586

#include "magick/colorspace.h"

587

#include "magick/exception.h"

588

#include "magick/exception-private.h"

589

#include "magick/image.h"

590

#include "magick/image-private.h"

591

#include "magick/list.h"

592

#include "magick/magick.h"

593

#include "magick/memory_.h"

594

#include "magick/monitor.h"

595

#include "magick/monitor-private.h"

596

#include "magick/quantum-private.h"

597

#include "magick/static.h"

598

#include "magick/string_.h"

599

#include "magick/module.h"

600

601

/*

602

Forward declarations.

603

*/

604

static MagickBooleanType

605

WriteMGKImage(const ImageInfo *,Image *);

606

607

/*

608

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% %

% %

% %

% I s M G K %

% %

% %

% %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

617

%

618

% IsMGK() returns MagickTrue if the image format type, identified by the

619

% magick string, is MGK.

620

%

621

% The format of the IsMGK method is:

622

%

623

% MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)

624

%

625

% A description of each parameter follows:

626

%

627

% o magick: This string is generally the first few bytes of an image file

628

% or blob.

629

%

630

% o length: Specifies the length of the magick string.

631

%

632

*/

633

static MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)

{

if (length < 7)

return(MagickFalse);

if (LocaleNCompare((char *) magick,"id=mgk",7) == 0)

return(MagickTrue);

return(MagickFalse);

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% %

% %

% %

% R e a d M G K I m a g e %

% %

% %

% %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

652

%

653

% ReadMGKImage() reads a MGK image file and returns it. It allocates

654

% the memory necessary for the new Image structure and returns a pointer to

655

% the new image.

656

%

657

% The format of the ReadMGKImage method is:

658

%

659

% Image *ReadMGKImage(const ImageInfo *image_info,ExceptionInfo *exception)

660

%

661

% A description of each parameter follows:

662

%

663

% o image_info: the image info.

664

%

665

% o exception: return any errors or warnings in this structure.

666

%

667

*/

668

static Image *ReadMGKImage(const ImageInfo *image_info,

669

ExceptionInfo *exception)

670

{

671

char

672

buffer[MaxTextExtent];

Image

*image;

long

y;

MagickBooleanType

status;

register long

x;

register PixelPacket

*q;

register unsigned char

*p;

ssize_t

count;

unsigned char

*pixels;

unsigned long

columns,

rows;

/*

Open image file.

*/

assert(image_info != (const ImageInfo *) NULL);

706

assert(image_info->signature == MagickSignature);

707

if (image_info->debug != MagickFalse)

708

(void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image_info->filename);

709

assert(exception != (ExceptionInfo *) NULL);

710

assert(exception->signature == MagickSignature);

711

image=AcquireImage(image_info);

712

status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);

713

if (status == MagickFalse)

714

{

715

image=DestroyImageList(image);

716

return((Image *) NULL);

}

/*

Read MGK image.

*/

(void) ReadBlobString(image,buffer); /* read magic number */

722

if (IsMGK(buffer,7) == MagickFalse)

723

ThrowReaderException(CorruptImageError,"ImproperImageHeader");

724

(void) ReadBlobString(image,buffer);

725

count=(ssize_t) sscanf(buffer,"%lu %lu\n",&columns,&rows);

726

if (count <= 0)

727

ThrowReaderException(CorruptImageError,"ImproperImageHeader");

do

{

/*

Initialize image structure.

732

*/

733

image->columns=columns;

734

image->rows=rows;

735

image->depth=8;

736

if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))

737

if (image->scene >= (image_info->scene+image_info->number_scenes-1))

738

break;

739

/*

740

Convert MGK raster image to pixel packets.

741

*/

742

if (SetImageExtent(image,0,0) == MagickFalse)

743

{

744

InheritException(exception,&image->exception);

745

return(DestroyImageList(image));

746

}

747

pixels=(unsigned char *) AcquireQuantumMemory((size_t) image->columns,3UL*sizeof(*pixels));

748

if (pixels == (unsigned char *) NULL)

749

ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");

750

for (y=0; y < (long) image->rows; y++)

751

{

752

count=(ssize_t) ReadBlob(image,(size_t) (3*image->columns),pixels);

753

if (count != (ssize_t) (3*image->columns))

754

ThrowReaderException(CorruptImageError,"UnableToReadImageData");

755

p=pixels;

756

q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);

757

if (q == (PixelPacket *) NULL)

758

break;

759

for (x=0; x < (long) image->columns; x++)

760

{

761

q->red=ScaleCharToQuantum(*p++);

762

q->green=ScaleCharToQuantum(*p++);

763

q->blue=ScaleCharToQuantum(*p++);

764

q++;

765

}

766

if (SyncAuthenticPixels(image,exception) == MagickFalse)

767

break;

768

if ((image->previous == (Image *) NULL) &&

769

(SetImageProgress(image,LoadImageTag,y,image>>rows) == MagickFalse))

770

break;

771

}

772

pixels=(unsigned char *) RelinquishMagickMemory(pixels);

773

if (EOFBlob(image) != MagickFalse)

774

{

775

ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",image->filename);

break;

}

/*

Proceed to next image.

780

*/

781

if (image_info->number_scenes != 0)

782

if (image->scene >= (image_info->scene+image_info->number_scenes-1))

783

break;

784

*buffer='\0';

785

(void) ReadBlobString(image,buffer);

786

count=(ssize_t) sscanf(buffer,"%lu %lu\n",&columns,&rows);

if (count != 0)

{

/*

Allocate next image structure.

791

*/

792

AcquireNextImage(image_info,image);

793

if (GetNextImageInList(image) == (Image *) NULL)

794

{

795

image=DestroyImageList(image);

796

return((Image *) NULL);

797

}

798

image=SyncNextImageInList(image);

799

status=SetImageProgress(image,LoadImageTag,TellBlob(image),GetBlobSize(image));

800

if (status == MagickFalse)

801

break;

802

}

803

} while (count != 0);

804

(void) CloseBlob(image);

805

return(GetFirstImageInList(image));

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% %

% %

% %

% R e g i s t e r M G K I m a g e %

% %

% %

% %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

818

%

819

% RegisterMGKImage() adds attributes for the MGK image format to

820

% the list of supported formats. The attributes include the image format

821

% tag, a method to read and/or write the format, whether the format

822

% supports the saving of more than one frame to the same file or blob,

823

% whether the format supports native in-memory I/O, and a brief

824

% description of the format.

825

%

826

% The format of the RegisterMGKImage method is:

827

%

828

% unsigned long RegisterMGKImage(void)

829

%

830

*/

831

ModuleExport unsigned long RegisterMGKImage(void)

{

MagickInfo

*entry;

entry=SetMagickInfo("MGK");

837

entry->decoder=(DecodeImageHandler *) ReadMGKImage;

838

entry->encoder=(EncodeImageHandler *) WriteMGKImage;

839

entry->magick=(IsImageFormatHandler *) IsMGK;

840

entry->description=ConstantString("MGK");

841

entry->module=ConstantString("MGK");

842

(void) RegisterMagickInfo(entry);

843

return(MagickImageCoderSignature);

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% %

% %

% %

% U n r e g i s t e r M G K I m a g e %

% %

% %

% %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

856

%

857

% UnregisterMGKImage() removes format registrations made by the

858

% MGK module from the list of supported formats.

859

%

860

% The format of the UnregisterMGKImage method is:

861

%

862

% UnregisterMGKImage(void)

863

%

864

*/

865

ModuleExport void UnregisterMGKImage(void)

866

{

867

(void) UnregisterMagickInfo("MGK");

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% %

% %

% %

% W r i t e M G K I m a g e %

% %

% %

% %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

880

%

881

% WriteMGKImage() writes an image to a file in red, green, and blue

882

% MGK rasterfile format.

883

%

884

% The format of the WriteMGKImage method is:

885

%

886

% MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)

887

%

888

% A description of each parameter follows.

889

%

890

% o image_info: the image info.

891

%

892

% o image: The image.

893

%

894

*/

895

static MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)

896

{

897

char

898

buffer[MaxTextExtent];

long

y;

MagickBooleanType

status;

MagickOffsetType

scene;

register const PixelPacket

*p;

register long

x;

register unsigned char

*q;

unsigned char

*pixels;

/*

Open output image file.

923

*/

924

assert(image_info != (const ImageInfo *) NULL);

925

assert(image_info->signature == MagickSignature);

926

assert(image != (Image *) NULL);

927

assert(image->signature == MagickSignature);

928

if (image->debug != MagickFalse)

929

(void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);

930

status=OpenBlob(image_info,image,WriteBinaryBlobMode,&image->exception);

931

if (status == MagickFalse)

return(status);

scene=0;

do

{

/*

Allocate memory for pixels.

938

*/

939

if (image->colorspace != RGBColorspace)

940

(void) SetImageColorspace(image,RGBColorspace);

941

pixels=(unsigned char *) AcquireQuantumMemory((size_t) image->columns,

942

3UL*sizeof(*pixels));

943

if (pixels == (unsigned char *) NULL)

944

ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");

945

/*

946

Initialize raster file header.

947

*/

948

(void) WriteBlobString(image,"id=mgk\n");

949

(void) FormatMagickString(buffer,MaxTextExtent,"%lu %lu\n",

950

image->columns,image->rows);

951

(void) WriteBlobString(image,buffer);

952

for (y=0; y < (long) image->rows; y++)

953

{

954

p=GetVirtualPixels(image,0,y,image->columns,1,&image->exception);

955

if (p == (const PixelPacket *) NULL)

956

break;

957

q=pixels;

958

for (x=0; x < (long) image->columns; x++)

959

{

960

*q++=ScaleQuantumToChar(p->red);

961

*q++=ScaleQuantumToChar(p->green);

962

*q++=ScaleQuantumToChar(p->blue);

963

p++;

964

}

965

(void) WriteBlob(image,(size_t) (q-pixels),pixels);

966

if ((image->previous == (Image *) NULL) &&

967

(SetImageProgress(image,SaveImageTag,y,image->rows) == MagickFalse))

968

break;

969

}

970

pixels=(unsigned char *) RelinquishMagickMemory(pixels);

971

if (GetNextImageInList(image) == (Image *) NULL)

972

break;

973

image=SyncNextImageInList(image);

974

status=SetImageProgress(image,SaveImagesTag,scene,

975

GetImageListLength(image));

976

if (status == MagickFalse)

977

break;

978

scene++;

979

} while (image_info->adjoin != MagickFalse);

980

(void) CloseBlob(image);

return(MagickTrue);

}

</pre>

</div>

<p>To invoke the custom coder from the command line, use these commands:</p>

987

988

<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: logo.mgk</span><span class='crtout'></span><span class="crtprompt"> $magick> </span><span class='crtin'>display logo.mgk</span></p>

989

<p>We provide the <a href="ftp://ftp.imagemagick.org/pub/ImageMagick/kits/MagickCoderKit-1.0.0.tar.gz">Magick Coder Kit</a> to help you get started writing your own custom coder.</p>

</div>

<h2><a name="filters"></a>Custom Image Filters</h2>

994

995

996

<p>ImageMagick provides a convenient mechanism for adding your own custom image processing algorithms. We call these image filters and they are invoked from the command line with the <a href="../www/command-line-options.html#process">-process</a> option or from the MagickCore API method <a href="../www/api/module.html#ExecuteModuleProcess">ExecuteModuleProcess()</a>.</p>

997

998

<p>Here is a listing of a sample <a href="../www/source/analyze.c">custom image filter</a>. It computes a few statistics such as the pixel brightness and saturation mean and standard-deviation.</p>

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include <time.h>

#include <assert.h>

#include <math.h>

#include "magick/MagickCore.h"

1009

1010

/*

1011

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% %

% %

% %

% a n a l y z e I m a g e %

% %

% %

% %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

1020

%

1021

% analyzeImage() computes the brightness and saturation mean, standard

1022

% deviation, kurtosis and skewness and stores these values as properties of

1023

% the image.

1024

%

1025

% The format of the analyzeImage method is:

1026

%

1027

% unsigned long analyzeImage(Image *images,const int argc,

1028

% const char **argv,ExceptionInfo *exception)

1029

%

1030

% A description of each parameter follows:

1031

%

1032

% o image: the address of a structure of type Image.

1033

%

1034

% o argc: Specifies a pointer to an integer describing the number of

1035

% elements in the argument vector.

1036

%

1037

% o argv: Specifies a pointer to a text array containing the command line

1038

% arguments.

1039

%

1040

% o exception: return any errors or warnings in this structure.

1041

%

1042

*/

1043

ModuleExport unsigned long analyzeImage(Image **images,const int argc,

1044

const char **argv,ExceptionInfo *exception)

{

CacheView

*image_view;

char

text[MaxTextExtent];

double

area,

brightness_mean,

brightness_standard_deviation,

brightness_kurtosis,

brightness_skewness,

brightness_sum_x,

brightness_sum_x2,

brightness_sum_x3,

brightness_sum_x4,

saturation_mean,

saturation_standard_deviation,

saturation_kurtosis,

saturation_skewness,

saturation_sum_x,

saturation_sum_x2,

saturation_sum_x3,

saturation_sum_x4;

double

brightness,

hue,

saturation;

Image

*image;

long

y;

register const PixelPacket

*p;

register long

x;

assert(images != (Image **) NULL);

1089

assert(*images != (Image *) NULL);

1090

assert((*images)->signature == MagickSignature);

(void) argc;

(void) argv;

image=(*images);

for ( ; image != (Image *) NULL; image=GetNextImageInList(image))

1095

{

1096

brightness_sum_x=0.0;

1097

brightness_sum_x2=0.0;

1098

brightness_sum_x3=0.0;

1099

brightness_sum_x4=0.0;

1100

brightness_mean=0.0;

1101

brightness_standard_deviation=0.0;

1102

brightness_kurtosis=0.0;

1103

brightness_skewness=0.0;

1104

saturation_sum_x=0.0;

1105

saturation_sum_x2=0.0;

1106

saturation_sum_x3=0.0;

1107

saturation_sum_x4=0.0;

1108

saturation_mean=0.0;

1109

saturation_standard_deviation=0.0;

1110

saturation_kurtosis=0.0;

1111

saturation_skewness=0.0;

1112

area=0.0;

1113

image_view=AcquireCacheView(image);

1114

for (y=0; y < (long) image->rows; y++)

1115

{

1116

p=GetCacheViewVirtualPixels(image_view,0,y,image->columns,1,exception);

1117

if (p == (const PixelPacket *) NULL)

1118

break;

1119

for (x=0; x < (long) image->columns; x++)

1120

{

1121

ConvertRGBToHSB(p->red,p->green,p->blue,&hue,&saturation,&brightness);

1122

brightness*=QuantumRange;

1123

brightness_sum_x+=brightness;

1124

brightness_sum_x2+=brightness*brightness;

1125

brightness_sum_x3+=brightness*brightness*brightness;

1126

brightness_sum_x4+=brightness*brightness*brightness*brightness;

1127

saturation*=QuantumRange;

1128

saturation_sum_x+=saturation;

1129

saturation_sum_x2+=saturation*saturation;

1130

saturation_sum_x3+=saturation*saturation*saturation;

1131

saturation_sum_x4+=saturation*saturation*saturation*saturation;

area++;

p++;

}

}

image_view=DestroyCacheView(image_view);

1137

if (area <= 0.0)

1138

break;

1139

brightness_mean=brightness_sum_x/area;

1140

(void) FormatMagickString(text,MaxTextExtent,"%g",brightness_mean);

1141

(void) SetImageProperty(image,"filter:brightness:mean",text);

1142

brightness_standard_deviation=sqrt(brightness_sum_x2/area-(brightness_sum_x/

1143

area*brightness_sum_x/area));

1144

(void) FormatMagickString(text,MaxTextExtent,"%g",

1145

brightness_standard_deviation);

1146

(void) SetImageProperty(image,"filter:brightness:standard-deviation",text);

1147

if (brightness_standard_deviation != 0)

1148

brightness_kurtosis=(brightness_sum_x4/area-4.0*brightness_mean*

1149

brightness_sum_x3/area+6.0*brightness_mean*brightness_mean*

1150

brightness_sum_x2/area-3.0*brightness_mean*brightness_mean*

1151

brightness_mean*brightness_mean)/(brightness_standard_deviation*

1152

brightness_standard_deviation*brightness_standard_deviation*

1153

brightness_standard_deviation)-3.0;

1154

(void) FormatMagickString(text,MaxTextExtent,"%g",brightness_kurtosis);

1155

(void) SetImageProperty(image,"filter:brightness:kurtosis",text);

1156

if (brightness_standard_deviation != 0)

1157

brightness_skewness=(brightness_sum_x3/area-3.0*brightness_mean*

1158

brightness_sum_x2/area+2.0*brightness_mean*brightness_mean*

1159

brightness_mean)/(brightness_standard_deviation*

1160

brightness_standard_deviation*brightness_standard_deviation);

1161

(void) FormatMagickString(text,MaxTextExtent,"%g",brightness_skewness);

1162

(void) SetImageProperty(image,"filter:brightness:skewness",text);

1163

saturation_mean=saturation_sum_x/area;

1164

(void) FormatMagickString(text,MaxTextExtent,"%g",saturation_mean);

1165

(void) SetImageProperty(image,"filter:saturation:mean",text);

1166

saturation_standard_deviation=sqrt(saturation_sum_x2/area-(saturation_sum_x/

1167

area*saturation_sum_x/area));

1168

(void) FormatMagickString(text,MaxTextExtent,"%g",

1169

saturation_standard_deviation);

1170

(void) SetImageProperty(image,"filter:saturation:standard-deviation",text);

1171

if (saturation_standard_deviation != 0)

1172

saturation_kurtosis=(saturation_sum_x4/area-4.0*saturation_mean*

1173

saturation_sum_x3/area+6.0*saturation_mean*saturation_mean*

1174

saturation_sum_x2/area-3.0*saturation_mean*saturation_mean*

1175

saturation_mean*saturation_mean)/(saturation_standard_deviation*

1176

saturation_standard_deviation*saturation_standard_deviation*

1177

saturation_standard_deviation)-3.0;

1178

(void) FormatMagickString(text,MaxTextExtent,"%g",saturation_kurtosis);

1179

(void) SetImageProperty(image,"filter:saturation:kurtosis",text);

1180

if (saturation_standard_deviation != 0)

1181

saturation_skewness=(saturation_sum_x3/area-3.0*saturation_mean*

1182

saturation_sum_x2/area+2.0*saturation_mean*saturation_mean*

1183

saturation_mean)/(saturation_standard_deviation*

1184

saturation_standard_deviation*saturation_standard_deviation);

1185

(void) FormatMagickString(text,MaxTextExtent,"%g",saturation_skewness);

1186

(void) SetImageProperty(image,"filter:saturation:skewness",text);

1187

}

1188

return(MagickImageFilterSignature);

}

</pre>

</div>

<p>To invoke the custom filter from the command line, use this command:</p>

1194

1195

<p class='crt'><span class="crtprompt"> $magick> </span><span class='crtin'>convert logo: -process analyze -verbose info:</span><span class='crtout'>Image: logo: <br/>

1196

Format: LOGO (ImageMagick Logo) <br/>

1197

Class: PseudoClass <br/>

1198

Geometry: 640x480 <br/>

1199

... <br/>

1200

filter:brightness:kurtosis: 8.98864 <br/>

1201

filter:brightness:mean: 238.096 <br/>

1202

filter:brightness:skewness: -3.04519 <br/>

1203

filter:brightness:standard-deviation: 46.3286 <br/>

1204

filter:saturation:kurtosis: 5.9137 <br/>

1205

filter:saturation:mean: 23.4635 <br/>

1206

filter:saturation:skewness: 2.71874 <br/>

1207

filter:saturation:standard-deviation: 64.7734</span></p>

1208

1209

<p>We provide the <a href="ftp://ftp.imagemagick.org/pub/ImageMagick/kits/MagickFilterKit-1.0.0.tar.gz">Magick Filter Kit</a> to help you get started writing your own custom image filter.</p>

1210

1211

</div>

cristy

f3bb478

2009-09-08 13:10:04 +0000

[diff] [blame]

</div>