doc/image2.html in rmagick-1.14.1 vs doc/image2.html in rmagick-1.15.0

- old
+ new

@@ -4,11 +4,11 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta name="generator" content= "HTML Tidy for Linux/x86 (vers 1st December 2004), see www.w3.org" /> - <title>RMagick: class Image (instance methods, part 2)</title> + <title>RMagick 1.15.0: class Image (instance methods, part 2)</title> <meta http-equiv="Content-Type" content= "text/html; charset=us-ascii" /> <meta name="GENERATOR" content="Quanta Plus" /> <meta name="Copyright" content= "Copyright (C) 2006 by Timothy P. Hunter" /> @@ -45,11 +45,11 @@ /*]]>*/ </style> </head> <body> - <h6 id="header">RMagick User's Guide and Reference</h6> + <h6 id="header">RMagick 1.15.0 User's Guide and Reference</h6> <div class="nav"> &laquo;&nbsp;<a href="image1.html">Prev</a> | <a href= "index.html">Contents</a> | <a href= "image3.html">Next</a>&nbsp;&raquo; @@ -131,10 +131,12 @@ <li><a href="#level">level</a></li> <li><a href="#level_channel">level_channel</a></li> + <li><a href="#linear_stretch">linear_stretch</a></li> + <li><a href="#magnify">magnify</a></li> <li><a href="#magnify_bang">magnify!</a></li> <li><a href="#map">map</a></li> @@ -145,17 +147,17 @@ <li><a href="#matte_floodfill">matte_floodfill</a></li> <li><a href="#matte_point">matte_point</a></li> <li><a href="#matte_replace">matte_replace</a></li> - - <li><a href="#matte_reset_bang">matte_reset!</a></li> </ul> </div> <div class="toccol"> <ul> + <li><a href="#matte_reset_bang">matte_reset!</a></li> + <li><a href="#median_filter">median_filter</a></li> <li><a href="#minify">minify</a></li> <li><a href="#minify_bang">minify!</a></li> @@ -185,10 +187,12 @@ <li><a href="#palette_q">palette?</a></li> <li><a href="#pixel_color">pixel_color</a></li> + <li><a href="#polaroid">polaroid</a></li> + <li><a href="#posterize">posterize</a></li> </ul> </div> </div> </div> @@ -985,502 +989,503 @@ <th>Record:DataSet</th> </tr> <tr> - <td> - Envelope::Model_Version</td> + <td>Envelope::Model_Version</td> - <td class="ds">1:00</td> + <td class="ds">1:00</td> </tr> + <tr> - <td> - Envelope::Destination</td> + <td>Envelope::Destination</td> - <td class="ds">1:05</td> + <td class="ds">1:05</td> </tr> + <tr> - <td> - Envelope::UNO</td> + <td>Envelope::UNO</td> - <td class="ds">1:100</td> + <td class="ds">1:100</td> </tr> + <tr> - <td> - Envelope::Unique_Name_of_Object</td> + <td>Envelope::Unique_Name_of_Object</td> - <td class="ds">1:100</td> + <td class="ds">1:100</td> </tr> + <tr> - <td> - Envelope::ARM_Identifier</td> + <td>Envelope::ARM_Identifier</td> - <td class="ds">1:120</td> + <td class="ds">1:120</td> </tr> + <tr> - <td> - Envelope::ARM_Version</td> + <td>Envelope::ARM_Version</td> - <td class="ds">1:122</td> + <td class="ds">1:122</td> </tr> + <tr> - <td> - Envelope::File_Format</td> + <td>Envelope::File_Format</td> - <td class="ds">1:20</td> + <td class="ds">1:20</td> </tr> + <tr> - <td> - Envelope::File_Format_Version</td> + <td>Envelope::File_Format_Version</td> - <td class="ds">1:22</td> + <td class="ds">1:22</td> </tr> + <tr> - <td> - Envelope::Service_Identifier</td> + <td>Envelope::Service_Identifier</td> - <td class="ds">1:30</td> + <td class="ds">1:30</td> </tr> + <tr> - <td> - Envelope::Envelope_Number</td> + <td>Envelope::Envelope_Number</td> - <td class="ds">1:40</td> + <td class="ds">1:40</td> </tr> + <tr> - <td> - Envelope::Product_ID</td> + <td>Envelope::Product_ID</td> - <td class="ds">1:50</td> + <td class="ds">1:50</td> </tr> + <tr> - <td> - Envelope::Envelope_Priority</td> + <td>Envelope::Envelope_Priority</td> - <td class="ds">1:60</td> + <td class="ds">1:60</td> </tr> + <tr> - <td> - Envelope::Date_Sent</td> + <td>Envelope::Date_Sent</td> - <td class="ds">1:70</td> + <td class="ds">1:70</td> </tr> + <tr> - <td> - Envelope::Time_Sent</td> + <td>Envelope::Time_Sent</td> - <td class="ds">1:80</td> + <td class="ds">1:80</td> </tr> + <tr> - <td> - Envelope::Coded_Character_Set</td> + <td>Envelope::Coded_Character_Set</td> - <td class="ds">1:90</td> + <td class="ds">1:90</td> </tr> + <tr> - <td> - Application::Object_Type_Reference</td> + <td>Application::Object_Type_Reference</td> - <td class="ds">2:03</td> + <td class="ds">2:03</td> </tr> + <tr> - <td> - Application::Object_Name</td> + <td>Application::Object_Name</td> - <td class="ds">2:05</td> + <td class="ds">2:05</td> </tr> + <tr> - <td> - Application::Title</td> + <td>Application::Title</td> - <td class="ds">2:05</td> + <td class="ds">2:05</td> </tr> + <tr> - <td> - Application::Edit_Status</td> + <td>Application::Edit_Status</td> - <td class="ds">2:07</td> + <td class="ds">2:07</td> </tr> + <tr> - <td> - Application::Editorial_Update</td> + <td>Application::Editorial_Update</td> - <td class="ds">2:08</td> + <td class="ds">2:08</td> </tr> + <tr> - <td> - Application::Urgency</td> + <td>Application::Urgency</td> - <td class="ds">2:10</td> + <td class="ds">2:10</td> </tr> + <tr> - <td> - Application::Country_Primary_Location_Code</td> + <td>Application::Country_Primary_Location_Code</td> - <td class="ds">2:100</td> + <td class="ds">2:100</td> </tr> + <tr> - <td> - Application::Country_Primary_Location_Name</td> + <td>Application::Country_Primary_Location_Name</td> - <td class="ds">2:101</td> + <td class="ds">2:101</td> </tr> + <tr> - <td> - Application::Original_Transmission_Reference</td> + <td>Application::Original_Transmission_Reference</td> - <td class="ds">2:103</td> + <td class="ds">2:103</td> </tr> + <tr> - <td> - Application::Headline</td> + <td>Application::Headline</td> - <td class="ds">2:105</td> + <td class="ds">2:105</td> </tr> + <tr> - <td> - Application::Credit</td> + <td>Application::Credit</td> - <td class="ds">2:110</td> + <td class="ds">2:110</td> </tr> + <tr> - <td> - Application::Source</td> + <td>Application::Source</td> - <td class="ds">2:115</td> + <td class="ds">2:115</td> </tr> + <tr> - <td> - Application::Copyright_Notice</td> + <td>Application::Copyright_Notice</td> - <td class="ds">2:116</td> + <td class="ds">2:116</td> </tr> + <tr> - <td> - Application::Contact</td> + <td>Application::Contact</td> - <td class="ds">2:118</td> + <td class="ds">2:118</td> </tr> + <tr> - <td> - Application::Subject_Reference</td> + <td>Application::Subject_Reference</td> - <td class="ds">2:12</td> + <td class="ds">2:12</td> </tr> + <tr> - <td> - Application::Abstract</td> + <td>Application::Abstract</td> - <td class="ds">2:120</td> + <td class="ds">2:120</td> </tr> + <tr> - <td> - Application::Caption</td> + <td>Application::Caption</td> - <td class="ds">2:120</td> + <td class="ds">2:120</td> </tr> + <tr> - <td> - Application::Caption_Writer</td> + <td>Application::Caption_Writer</td> - <td class="ds">2:122</td> + <td class="ds">2:122</td> </tr> + <tr> - <td> - Application::Editor</td> + <td>Application::Editor</td> - <td class="ds">2:122</td> + <td class="ds">2:122</td> </tr> + <tr> - <td> - Application::Rasterized_Caption</td> + <td>Application::Rasterized_Caption</td> - <td class="ds">2:125</td> + <td class="ds">2:125</td> </tr> + <tr> - <td> - Application::Image_Type</td> + <td>Application::Image_Type</td> - <td class="ds">2:130</td> + <td class="ds">2:130</td> </tr> + <tr> - <td> - Application::Image_Orientation</td> + <td>Application::Image_Orientation</td> - <td class="ds">2:131</td> + <td class="ds">2:131</td> </tr> + <tr> - <td> - Application::Language_Identifier</td> + <td>Application::Language_Identifier</td> - <td class="ds">2:135</td> + <td class="ds">2:135</td> </tr> + <tr> - <td> - Application::Category</td> + <td>Application::Category</td> - <td class="ds">2:15</td> + <td class="ds">2:15</td> </tr> + <tr> - <td> - Application::Audio_Type</td> + <td>Application::Audio_Type</td> - <td class="ds">2:150</td> + <td class="ds">2:150</td> </tr> + <tr> - <td> - Application::Audio_Sampling_Rate</td> + <td>Application::Audio_Sampling_Rate</td> - <td class="ds">2:151</td> + <td class="ds">2:151</td> </tr> + <tr> - <td> - Application::Audio_Sampling_Resolution</td> + <td>Application::Audio_Sampling_Resolution</td> - <td class="ds">2:152</td> + <td class="ds">2:152</td> </tr> + <tr> - <td> - Application::Audio_Duration</td> + <td>Application::Audio_Duration</td> - <td class="ds">2:153</td> + <td class="ds">2:153</td> </tr> + <tr> - <td> - Application::Audio_Outcue</td> + <td>Application::Audio_Outcue</td> - <td class="ds">2:154</td> + <td class="ds">2:154</td> </tr> + <tr> - <td> - Application::Supplemental_Category</td> + <td>Application::Supplemental_Category</td> - <td class="ds">2:20</td> + <td class="ds">2:20</td> </tr> + <tr> - <td> - Application::ObjectData_Preview_File_Format</td> + <td>Application::ObjectData_Preview_File_Format</td> - <td class="ds">2:200</td> + <td class="ds">2:200</td> </tr> + <tr> - <td> - Application::ObjectData_Preview_File_Format_Version</td> + <td> + Application::ObjectData_Preview_File_Format_Version</td> - <td class="ds">2:201</td> + <td class="ds">2:201</td> </tr> + <tr> - <td> - Application::ObjectData_Preview_Data</td> + <td>Application::ObjectData_Preview_Data</td> - <td class="ds">2:202</td> + <td class="ds">2:202</td> </tr> + <tr> - <td> - Application::Fixture_Identifier</td> + <td>Application::Fixture_Identifier</td> - <td class="ds">2:22</td> + <td class="ds">2:22</td> </tr> + <tr> - <td> - Application::Keywords</td> + <td>Application::Keywords</td> - <td class="ds">2:25</td> + <td class="ds">2:25</td> </tr> + <tr> - <td> - Application::Content_Location_Code</td> + <td>Application::Content_Location_Code</td> - <td class="ds">2:26</td> + <td class="ds">2:26</td> </tr> + <tr> - <td> - Application::Content_Location_Name</td> + <td>Application::Content_Location_Name</td> - <td class="ds">2:27</td> + <td class="ds">2:27</td> </tr> + <tr> - <td> - Application::Release_Date</td> + <td>Application::Release_Date</td> - <td class="ds">2:30</td> + <td class="ds">2:30</td> </tr> + <tr> - <td> - Application::Release_Time</td> + <td>Application::Release_Time</td> - <td class="ds">2:35</td> + <td class="ds">2:35</td> </tr> + <tr> - <td> - Application::Expiration_Time</td> + <td>Application::Expiration_Time</td> - <td class="ds">2:35</td> + <td class="ds">2:35</td> </tr> + <tr> - <td> - Application::Expiration_Date</td> + <td>Application::Expiration_Date</td> - <td class="ds">2:37</td> + <td class="ds">2:37</td> </tr> + <tr> - <td> - Application::Special_Instructions</td> + <td>Application::Special_Instructions</td> - <td class="ds">2:40</td> + <td class="ds">2:40</td> </tr> + <tr> - <td> - Application::Action_Advised</td> + <td>Application::Action_Advised</td> - <td class="ds">2:42</td> + <td class="ds">2:42</td> </tr> + <tr> - <td> - Application::Reference_Service</td> + <td>Application::Reference_Service</td> - <td class="ds">2:45</td> + <td class="ds">2:45</td> </tr> + <tr> - <td> - Application::Reference_Date</td> + <td>Application::Reference_Date</td> - <td class="ds">2:47</td> + <td class="ds">2:47</td> </tr> + <tr> - <td> - Application::Reference_Number</td> + <td>Application::Reference_Number</td> - <td class="ds">2:50</td> + <td class="ds">2:50</td> </tr> + <tr> - <td> - Application::Date_Created</td> + <td>Application::Date_Created</td> - <td class="ds">2:55</td> + <td class="ds">2:55</td> </tr> + <tr> - <td> - Application::Time_Created</td> + <td>Application::Time_Created</td> - <td class="ds">2:60</td> + <td class="ds">2:60</td> </tr> + <tr> - <td> - Application::Digital_Creation_Date</td> + <td>Application::Digital_Creation_Date</td> - <td class="ds">2:62</td> + <td class="ds">2:62</td> </tr> + <tr> - <td> - Application::Digital_Creation_Time</td> + <td>Application::Digital_Creation_Time</td> - <td class="ds">2:63</td> + <td class="ds">2:63</td> </tr> + <tr> - <td> - Application::Originating_Program</td> + <td>Application::Originating_Program</td> - <td class="ds">2:65</td> + <td class="ds">2:65</td> </tr> + <tr> - <td> - Application::Program_Version</td> + <td>Application::Program_Version</td> - <td class="ds">2:70</td> + <td class="ds">2:70</td> </tr> + <tr> - <td> - Application::Object_Cycle</td> + <td>Application::Object_Cycle</td> - <td class="ds">2:75</td> + <td class="ds">2:75</td> </tr> + <tr> - <td> - Application::Author</td> + <td>Application::Author</td> - <td class="ds">2:80</td> + <td class="ds">2:80</td> </tr> + <tr> - <td> - Application::By_Line</td> + <td>Application::By_Line</td> - <td class="ds">2:80</td> + <td class="ds">2:80</td> </tr> + <tr> - <td> - Application::Author_Position</td> + <td>Application::Author_Position</td> - <td class="ds">2:85</td> + <td class="ds">2:85</td> </tr> + <tr> - <td> - Application::By_Line_Title</td> + <td>Application::By_Line_Title</td> - <td class="ds">2:85</td> + <td class="ds">2:85</td> </tr> + <tr> - <td> - Application::City</td> + <td>Application::City</td> - <td class="ds">2:90</td> + <td class="ds">2:90</td> </tr> + <tr> - <td> - Application::Sub_Location</td> + <td>Application::Sub_Location</td> - <td class="ds">2:92</td> + <td class="ds">2:92</td> </tr> + <tr> - <td> - Application::Province</td> + <td>Application::Province</td> - <td class="ds">2:95</td> + <td class="ds">2:95</td> </tr> + <tr> - <td> - Application::State</td> + <td>Application::State</td> - <td class="ds">2:95</td> + <td class="ds">2:95</td> </tr> + <tr> - <td> - Pre_ObjectData_Descriptor::Size_Mode</td> + <td>Pre_ObjectData_Descriptor::Size_Mode</td> - <td class="ds">7:10</td> + <td class="ds">7:10</td> </tr> + <tr> - <td> - Pre_ObjectData_Descriptor::Max_Subfile_Size</td> + <td>Pre_ObjectData_Descriptor::Max_Subfile_Size</td> - <td class="ds">7:20</td> + <td class="ds">7:20</td> </tr> + <tr> - <td> - Pre_ObjectData_Descriptor::ObjectData_Size_Announced</td> + <td> + Pre_ObjectData_Descriptor::ObjectData_Size_Announced</td> - <td class="ds">7:90</td> + <td class="ds">7:90</td> </tr> + <tr> - <td> - Pre_ObjectData_Descriptor::Maximum_ObjectData_Size</td> + <td>Pre_ObjectData_Descriptor::Maximum_ObjectData_Size</td> - <td class="ds">7:95</td> + <td class="ds">7:95</td> </tr> + <tr> - <td> - ObjectData::Subfile</td> + <td>ObjectData::Subfile</td> - <td class="ds">8:10</td> + <td class="ds">8:10</td> </tr> + <tr> - <td> - Post_ObjectData_Descriptor::Confirmed_ObjectData_Size</td> + <td> + Post_ObjectData_Descriptor::Confirmed_ObjectData_Size</td> - <td class="ds">9:10</td> + <td class="ds">9:10</td> </tr> - </table> <h4>Example</h4> <pre> img.get_iptc_dataset(Magick::IPTC::Application::Keywords) @@ -2010,10 +2015,50 @@ <p>LevelImageChannel</p> </div> <div class="sig"> + <h3 id="linear_stretch">linear_stretch</h3> + + <p><span class="arg">image</span>.linear_stretch(<span class= + "arg">black_point</span>[, <span class= + "arg">white_point</span>]) -&gt; <em>anImage</em></p> + </div> + + <div class="desc"> + <h4>Description</h4> + + <p class="imquote">Linear with saturation stretch.</p> + + <h4>Arguments</h4> + + <dl> + <dt>black_point</dt> + + <dd>black out at most this many pixels. Specify an absolute + number of pixels as a numeric value, or a percentage as a + string in the form 'NN%'.</dd> + + <dt>white_point</dt> + + <dd>burn at most this many pixels. Specify an absolute number + of pixels as a numeric value, or a percentage as a string in + the form 'NN%'. This argument is optional. If not specified + the default is <code>all pixels - black_point + pixels</code>.</dd> + </dl> + + <h4>Returns</h4> + + <p>A new image</p> + + <h4>Magick API</h4> + + <p>LinearStretchImage</p> + </div> + + <div class="sig"> <h3 id="magnify">magnify</h3> <p><span class="arg">image</span>.magnify -&gt; <em>anImage</em></p> </div> @@ -2336,14 +2381,16 @@ <h4>Example</h4> <p>The left side of the image has been modified by <a href= "image1.html#add_noise">add_noise</a>. The right side has been - filtered by median_filter(0.05).</p><a href= - "javascript:popup('median_filter.rb.html')"><img src= - "ex/median_filter.jpg" alt="median_filter example" /></a> + filtered by median_filter(0.05).</p> + <p><a href= + "javascript:popup('median_filter.rb.html')"><img src="ex/median_filter.jpg" + alt="median_filter example" /></a></p> + <h4>See also</h4> <p><a href="#enhance">enhance</a>, <a href= "image3.html#reduce_noise">reduce_noise</a>, <a href= "image3.html#unsharp_mask">unsharp_mask</a></p> @@ -2807,28 +2854,34 @@ <div class="sig"> <h3 id="ordered_dither">ordered_dither</h3> <p><span class="arg">image</span>.ordered_dither(<span class= - "arg">order</span>=2) -&gt; <em>anImage</em></p> + "arg">threshold_map</span>='2x2') -&gt; <em>anImage</em></p> </div> <div class="desc"> <h4>Description</h4> - <p class="imquote">Uses the ordered dithering technique of - reducing color images to monochrome using positional - information to retain as much information as possible.</p> + <p>DIthers the image to a predefined pattern. The <span class= + "arg">threshold_map</span> argument defines the pattern to + use.</p> <h4>Arguments</h4> - <dl> - <dt>order</dt> + <p>The <span class="arg">threshold_map</span> argument can be + any of the strings listed by this command:</p> + <pre> +convert -list Thresholds +</pre> - <dd>The dither order. Must be one of the integers 2, 3, or - 4.</dd> - </dl> + <p>GraphicsMagick and older releases of ImageMagick do not + accept threshold map strings and will not respond to that + command. In these cases <span class="arg">threshold_map</span> + should be one of the numbers 2, 3, or 4. These numbers + correspond to the threshold maps "o2x2", "o3x3", and "o4x4", + respectively.</p> <h4>Returns</h4> <p>A new image</p> @@ -2848,11 +2901,11 @@ <p><a href="#posterize">posterize</a>, <a href= "image3.html#quantize">quantize</a></p> <h4>Magick API</h4> - <p>RandomThresholdImageChannel</p> + <p>OrderedPosterizeImage</p> </div> <div class="sig"> <h3 id="palette_q">palette?</h3> @@ -2902,12 +2955,12 @@ <dd>The x- and y-coordinates of the pixel.</dd> <dt>new_color</dt> <dd>If specified, the pixel is set to this color. May be - either a color name or a <a href= - "struct.html#Pixel">Pixel</a>.</dd> + either a <a href="imusage.html#color_names">color name</a> or + a <a href="struct.html#Pixel">Pixel</a>.</dd> </dl> <h4>Returns</h4>A <a href="struct.html#Pixel">Pixel</a> having the RGB values of the specified pixel. @@ -2917,9 +2970,85 @@ </pre> <h4>Magick API</h4> <p>AcquireImagePixels</p> + </div> + + <div class="sig"> + <h3 id="polaroid">polaroid</h3> + + <p>image.polaroid(angle=-5.0) [ <span class="arg">{ optional + arguments }</span> ] -&gt; anImage</p> + </div> + + <div class="desc"> + <h4>Description</h4> + + <p>Produce an image that looks like a Polaroid&reg; instant + picture. If the image has a "Caption" <a href= + "image1.html#aset">property</a>, the value is used as a + caption.</p> + + <p>Optional arguments may be specified in a block associated + with the method. These arguments control the shadow color and + how the label is rendered. By default the shadow color is + gray75. To specify a different shadow color, use + <code>self.shadow_color</code>. The argument can be either a + <a href="imusage.html#color_names">color name</a> or a <a href= + "struct.html#Pixel">Pixel</a>.</p> + + <p>The following <a href="draw.html#annotate">annotate</a> + attributes control the label rendering: <a href= + "draw.html#align_eq">align</a>, <a href= + "draw.html#decorate_eq">decorate</a>, <a href= + "draw.html#density_eq">density</a>, <a href= + "draw.html#encoding_eq">encoding</a>, <a href= + "draw.html#fill_eq">fill</a>, <a href= + "draw.html#font_eq">font</a>, <a href= + "draw.html#font_family_eq">font_family</a>, <a href= + "draw.html#font_stretch_eq">font_stretch</a>, <a href= + "draw.html#font_style_eq">font_style</a>, <a href= + "draw.html#font_weight_eq">font_weight</a>, <a href= + "draw.html#gravity_eq">gravity</a>, <a href= + "draw.html#pointsize_eq">pointsize</a>, <a href= + "draw.html#stroke_eq">stroke</a>, <a href= + "draw.html#stroke_width_eq">stroke_width</a>, <a href= + "draw.html#text_antialias_eq">text_antialias</a>, <a href= + "draw.html#undercolor_eq">undercolor</a>.</p> + <pre> +img.polaroid do + self.shadow_color = "gray40" + self.pointsize = 12 +end +</pre> + + <p>Polaroid is a registered trademark of the Polaroid + Corporation.</p> + + <h4>Arguments</h4> + + <dl> + <dt>angle</dt> + + <dd>The resulting image is rotated by this amount, measured + in degrees. The default is -5.0.</dd> + </dl> + + <h4>Example</h4> + + <p><a href="javascript:popup('polaroid.rb.html')"><img src= + "ex/polaroid.jpg" alt="polaroid example" /></a></p> + + <h4>Magick API</h4> + + <p>PolaroidImage (introduced in ImageMagick 6.3.1)</p> + + <h4>See also</h4> + + <p><a href= + "http://rmagick.rubyforge.org/Polaroid/polaroid.html">The + Polaroid Effect</a></p> </div> <div class="sig"> <h3 id="posterize">posterize</h3>