steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

images.normalization: added documentation

db4
Keith Lazuka 2009-10-07 14:23:08 -04:00
parent bf42c83690
commit 3763ea29d0
2 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
extra/images/normalization/normalization-docs.factor Normal file
View File

@ -0,0 +1,29 @@
! Copyright (C) 2009 Keith Lazuka.
! See http://factorcode.org/license.txt for BSD license.
USING: help.markup help.syntax kernel images ;
IN: images.normalization
HELP: normalize-image
{ $values
{ "image" image }
{ "image" image }
}
{ $description "Converts the image to RGBA with ubyte-components. If the image is upside-down, it will be flipped right side up such that the 1st byte in the bitmap slot's byte array corresponds to the first color component of the pixel in the upper-left corner of the image." } ;
HELP: reorder-colors
{ $values
{ "image" image } { "component-order" component-order }
{ "image" image }
}
{ $description "Convert the bitmap in " { $snippet "image" } " such that the pixel sample layout corresponds to " { $snippet "component-order" } ". If the destination layout cannot find a corresponding value from the source layout, the value " { $snippet "255" } " will be substituted for that byte." }
{ $warning "The image's " { $snippet "component-type" } " will be changed to " { $snippet "ubyte-components" } " if it is not already in that format." } ;
ARTICLE: "images.normalization" "Image normalization"
"The " { $vocab-link "images.normalization" } " vocab can be used to convert between " { $link image } " representations."
$nl
"You can normalize any image to RGBA with ubyte-components:"
{ $subsections normalize-image }
"Convert an image's pixel layout to match an arbitrary " { $link component-order } ":"
{ $subsections reorder-colors } ;
ABOUT: "images.normalization"

3
extra/images/normalization/normalization-tests.factor
View File

@ -1,4 +1,5 @@
! BSD License. Copyright 2009 Keith Lazuka
! Copyright (C) 2009 Keith Lazuka.
! See http://factorcode.org/license.txt for BSD license.
USING: images images.normalization images.normalization.private
sequences tools.test ;
IN: images.normalization.tests