From 29c42fa8496405ccf48c1b49bcd1ea12fe4fb4d1 Mon Sep 17 00:00:00 2001 From: rmagick Date: Sat, 30 Apr 2005 14:29:49 +0000 Subject: [PATCH] Document Image#sepiatone, #sigmoidal_contrast_channel, JPEG2000Compression --- ChangeLog | 3 + doc/constants.html | 29 ++++++---- doc/image1.html | 94 +++++++++++++++++++++---------- doc/image3.html | 137 ++++++++++++++++++++++++++++++++++++++++++--- doc/info.html | 3 +- doc/usage.html | 15 ++++- 6 files changed, 227 insertions(+), 54 deletions(-) diff --git a/ChangeLog b/ChangeLog index 9921af69a..f8182b33d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,8 +1,11 @@ RMagick 1.8.0 o Added Image#shadow (ImageMagick 6.1.7) o Added Image::Info#undefine, #[], #[]= + o Added sigmoidal_contrast_channel, sepiatone to Image class (ImageMagick 6.2.1) + o Added JPEG2000Compression constant (ImageMagick 6.2.2) o Incorporated RVG classes o Added RVG documentation, examples, updated installer + o Tested with ImageMagick 6.2.2-0, latest GraphicsMagick 1.2 RMagick 1.7.4 o Fix bug #1727 diff --git a/doc/constants.html b/doc/constants.html index 0785e7ff9..e477e0289 100644 --- a/doc/constants.html +++ b/doc/constants.html @@ -4,7 +4,7 @@ + "HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" /> RMagick: Constants - - + @@ -65,8 +65,8 @@
« Prev | Contents | - Next » + "index.html">Contents | Next »

Constants

@@ -148,7 +148,7 @@

Constants

An extended form of the Version constant with the format shown here:
- This is RMagick 1.4.0 ($Date: 2005/03/12 17:02:42 $) + This is RMagick 1.4.0 ($Date: 2005/04/30 14:29:49 $) Copyright (C) 2005 by Timothy P. Hunter
Built with ImageMagick 6.0.0 02/25/04 Q8 http://www.imagemagick.org
@@ -708,6 +708,11 @@

CompressionType

"http://www.faqs.org/faqs/jpeg-faq/part1/">The JPEG image compression FAQ.
+
JPEG2000Compression
+ +
JPEG2000 compression for compressed PDF images. (Introduced + in ImageMagick 6.2.2.)
+
LosslessJPEGCompression
This compression format is almost never used.
@@ -1187,9 +1192,9 @@

WeightType

 

- « Prev | Contents | - Next » -
+ « Prev | Contents | Next » + diff --git a/doc/image1.html b/doc/image1.html index f4f31cb7f..89733748d 100644 --- a/doc/image1.html +++ b/doc/image1.html @@ -1,10 +1,10 @@ - + + "HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" /> RMagick: class Image (class and instance methods, part 1) @@ -437,7 +437,9 @@

Example

} -

See also

See also + +

ImageList.new_image

Magick API

@@ -609,8 +611,10 @@

Example

mom['Label'] = 'My Mother' -

See also

[ ]=, - properties

+

See also

+ +

[ ]=, properties

Magick API

@@ -862,8 +866,10 @@

Example

"ex/images/spin.gif" alt="" class="spin" style="left:237px;" title="Mouse over the example to see the original image" />

-

See also

rotate, - shear

+

See also

+ +

rotate, shear

Magick API

@@ -1080,9 +1086,10 @@

Returns

A new image

-

See also

white_threshold, channel_threshold

+

See also

+ +

white_threshold, + channel_threshold

Magick API

@@ -1140,7 +1147,9 @@

Example

"left: 224px;" title= "Mouse over the example to see the original image" />

-

See also

border!, See also + +

border!, frame

Magick API

@@ -1305,7 +1314,9 @@

Returns

The maximum depth

-

See also

See also + +

set_channel_depth

Magick API

@@ -1439,9 +1450,10 @@

Example

"ex/images/spin.gif" alt="" class="spin" style="left: 446px" title="Mouse over the example to see the original image" />

-

See also

adaptive_threshold, black_threshold, See also + +

adaptive_threshold, + black_threshold, random_channel_threshold, threshold, white_threshold

@@ -1637,7 +1649,9 @@

Example

"margin-bottom: 182px; margin-left: 4px;" title= "Mouse over the example to see the original image" />

-

See also

color_floodfill

+

See also

+ +

color_floodfill

Magick API

@@ -1692,9 +1706,10 @@

Example

"margin-bottom: 182px;" title= "Mouse over the example to see the original image" />

-

See also

color_fill_to_border, opaque

+

See also

+ +

color_fill_to_border, + opaque

Magick API

@@ -1792,6 +1807,10 @@

Example

"ex/images/spin.gif" alt="" class="spin" title= "Mouse over the example to see the original image" />

+

See also

+ +

sepiatone

+

Magick API

ColorizeImage

@@ -1879,8 +1898,9 @@

Example

f.color_point(50,50, 'red') -

See also

pixel_color, See also + +

pixel_color, Draw#point

Magick API

@@ -1911,7 +1931,9 @@

Example

f.color_reset!(red) -

See also

erase!

+

See also

+ +

erase!

Magick API

SetImage @@ -1972,7 +1994,9 @@

Returns

second is a the value of the computed distortion represented as a Float.

-

See also

difference, See also + +

difference, <=>

Magick API

@@ -2224,7 +2248,9 @@

Returns

A new image

-

See also

composite, See also + +

composite, affine_transform

Magick API

@@ -2294,6 +2320,11 @@

Example

"ex/contrast.jpg" alt="contrast example" title= "Click the image to see the example script" /> +

See also

+ +

sigmoidal_contrast_channel

+

Magick API

ContrastImage

@@ -2588,8 +2619,9 @@

Example 2

crop_with_gravity.rb

-

See also

crop!, chop

+

See also

+ +

crop!, chop

Notes

@@ -2752,7 +2784,9 @@

Returns

"imageattrs.html#normalized_maximum_error">normalized_maximum_error attributes.

-

See also

<=>

+

See also

+ +

<=>

Magick API

IsImagesEqual @@ -2875,7 +2909,9 @@

Returns

self

Note

-

The display method is not supported on native MS Windows.

+ +

The display method is not supported on native MS + Windows.

Magick API

diff --git a/doc/image3.html b/doc/image3.html index 46675eda6..662dde7f0 100644 --- a/doc/image3.html +++ b/doc/image3.html @@ -1,10 +1,10 @@ - + + "HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" /> RMagick: class Image (instance methods, part 3) instance methods
  • sample!
  • scale
    • + +
  • scale!
    • +
    +

    sepiatone

    + +

    image.sepiatone(threshold=MaxRGB) -> anImage

    +
    + +
    +

    Description

    + +

    Applies a special effect to the image, + similar to the effect achieved in a photo darkroom by sepia + toning.

    + +

    Arguments

    + +
    +
    threshold
    + +
    Threshold ranges + from 0 to MaxRGB and is a measure of the extent + of the sepia toning. A threshold of 80% is a good starting + point for a reasonable tone. The default is MaxRGB.
    +
    + +

    Returns

    + +

    self

    + +

    Example

    + +

    sepiatone example

    + +

    See also

    + +

    colorize

    + +

    Magick API

    + +

    SepiaToneImage (available in ImageMagick 6.2.1)

    +
    +

    set_channel_depth

    @@ -1587,6 +1642,69 @@

    Magick API

    ShearImage

    +
    +

    + sigmoidal_contrast_channel

    + +


    + image.sigmoidal_contrast_channel(contrast=3.0, midpoint=50.0, sharpen=false[,channel, channel...] -> anImage

    +
    + +
    +

    Description

    + +

    Adjusts the contrast of an image channel + with a non-linear sigmoidal contrast algorithm. Increases the + contrast of the image using a sigmoidal transfer function + without saturating highlights or shadows.

    + +

    Arguments

    + +
    +
    contrast
    + +
    indicates how much to increase the + contrast (0 is none; 3 is typical; 20 is pushing it)
    + +
    midpoint
    + +
    indicates where midtones fall in the + resultant image (0 is white; 50% is middle-gray; 100% is + black)
    + +
    sharpen
    + +
    Set sharpen to + true to increase the image contrast otherwise + the contrast is reduced.
    + +
    channel...
    + +
    0 or more ChannelType arguments. If no + channels are specified, all the channels are adjusted.
    +
    + +

    Returns

    + +

    A new image

    + +

    See also

    + +

    contrast

    + +

    Magick API

    + +

    SigmoidalContrastImageChannel (available in ImageMagick + 6.2.1)

    +
    +

    signature

    @@ -1987,7 +2105,8 @@

    Example

    See also

    -

    constitute, get_pixels, constitute, get_pixels, view

    Magick API

    @@ -2804,7 +2923,7 @@

    Example

    "padding-top:25px; padding-bottom:25px; display:none" id= "nowave" title="Click to see the example script" onmouseout= "this.style.display='none'; waved.style.display='';" src= - "ex/images/Flower_Hat.jpg" alt="wave example" name="nowave" /> + "ex/images/Flower_Hat.jpg" alt="wave example" name="nowave" /> Description or define. This is not the same as setting the option to a null value. The undefine method removes the option name from the list of options for the - specified format. Raises ArgumentError if the - option does not exist.

    + specified format.

    Arguments

    diff --git a/doc/usage.html b/doc/usage.html index fc28c4904..23cf8217e 100644 --- a/doc/usage.html +++ b/doc/usage.html @@ -4,7 +4,7 @@ + "HTML Tidy for Linux/x86 (vers 1st March 2005), see www.w3.org" /> RMagick: How to use RMagick Enhance "image3.html#unsharp_mask_channel">unsharp_mask_channel
    Sharpen the image
    + +
    sigmoidal_contrast_channel
    + +
    Adjusts the contrast of an image channel with a + non-linear sigmoidal contrast algorithm

    Add effects

    @@ -956,6 +962,11 @@

    Add special effects

    Add an oil paint effect
    +
    sepiatone
    + +
    Applies an effect similar to the effect achieved in a + photo darkroom by sepia toning.
    +
    shade
    Shine a distant light on an image to create a @@ -1311,7 +1322,7 @@
    Footnotes
    use radians instead of degrees.

    -

    +

     

    « Prev |