Functions

annotate

Adds text to an image

Looks like...

{
    "name":"annotate",
    "params":{
        "text":"my_text",
        "color":"#ffffff"
    }
}

PARAMS: Required / Optional

Name	Description
"text"	Text to be placed on image
"x"	X offset (defaults to 0)
"y"	Y offset (defaults to 0)
"color"	Color of text (defaults to '#ffffff')
"style"	"normal" or "italic" or "oblique" (defaults to "normal")
"kerning"	Distance between letters (defaults based on font)
"font_weight"	"bold" or "normal" (defaults to "bold")
"font_family"	Font of text (defaults to 'Helvetica') <br>Need an Open Source font added? Write us at support@blitline.com
"point_size"	Size of text (defaults to 32)
"stroke"	Color of stroke (defaults to "transparent")
"dropshadow _color"	Adds a dropshadow of a specified color
"dropshadow _offet"	Pixels down/right for dropshadow, if dropshadow_color is set. <br>(defaults to 3)
"gravity"	Placement of text (defaults to 'CenterGravity')

Example

append

Appends images together either vertically or horizontally

Looks like...

{
    "name":"append",
    "params":{
        "vertical":false
    }
}

PARAMS: Required / Optional

Name	Description
"vertical"	Whether images are appended vertically(true) or horizontally(false)
"other_images"	Comma separated list of urls to other images

Example

blur

Blurs an image

Looks like...

{
    "name":"blur"
}

PARAMS: Required / Optional

Name	Description
"sigma"	Gaussian sigma of blur (defaults to 1.0)
"radius"	Gaussian radius of blur (defaults to 0.0)}

background color

Sets a transparent background color to be a solid (useful when converting pngs to jpgs)

Looks like...

{
    "name":"background_color",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"color"	Color you want for the background color (defaults to '#ffffff')

composite

Composites one image onto another

Looks like...

{
    "name":"composite",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"src"	Url of image you wants composited with original image
"as_mask"	"true" or "false" to use src as a greyscale mask (defaults to false)
"x"	X offset of where to place image on original image
"y"	Y offset of where to place image on original image
"gravity"	Instead of x,y you could use gravity. (Gravity param overrides x,y values)
"composite_op"	How composite is to be applied. Defaults to "OverCompositeOp" (which means it will just be layed on top of original image). See "Composite Ops" section below for more options

Example

contrast

Adjusts contrasts within the image.

Looks like...

{
    "name":"contrast",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"sharpen"	Contrast is increased if true (defaults to false)

contrast stretch channel

Adjusts contrasts within the image.

Looks like...

{
    "name":"contrast_stretch_channel",
    "params":{
        "black_point":10
    }
}

PARAMS: Required / Optional

Name	Description
"black_point"	Burn at most this many pixels. Specify an absolute number of pixels as a numeric value
"white_point"	Burn at most this many pixels. Specify an absolute number of pixels as a numeric value. If not given defaults to all_points-black_point

convert command (beta)

Advanced function with direct access to IM's convert command.

Looks like...

{
    "name":"convert_command",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"<Convert Options>"	Each param is an option. If the option has a value, set the value, otherwise leave as empty string.

Example

crop

Crop an image to a specific size.

Note: This is not used very often. You are probably looking for "resize_to_fill".

Looks like...

{
    "name":"crop",
    "params":{
        "x":0,
        "y":0,
        "width":10,
        "height":10
    }
}

PARAMS: Required / Optional

Name	Description
"width"	Width of resulting image
"height"	Height of resulting image
"x"	X offset
"y"	Y offset
"preserve_aspect_if_smaller"	If source image is smaller than target size, crop smaller image to still be same aspect ratio (default false)
"gravity"	Sets the starting gravity of where the x,y will offset from

Example

crop to square

Crop an image to a sqaure, based on height vs width. Square side length will be the smaller of the 2.

Looks like...

{
    "name":"crop_to_square",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"gravity"	Gravity of resulting crop (default CenterGravity)

Example

delete profile

Deletes color profile information.

Looks like...

{
    "name":"delete_profile",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"name"	Name of the profile to remove (or * to remove wildcard)

deskew

Tries to relalign a slightly distorted image. (Typically used in scanning and OCR)

Looks like...

{
    "name":"deskew",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"threshold"	Maximum threshold percentage for deskewing (Default = 0.40)

density

Sets the DPI of an image

Looks like...

{
    "name":"density",
    "params":{
        "dpi":"200"
    }
}

PARAMS: Required / Optional

Name	Description
"dpi"	Sets the DPI of the image

despeckle

Reduces the speckle noise while preserving the edges

Looks like...

{
    "name":"despeckle",
    "params":{}
}

enhance

Reduces noise in the image

Looks like...

{
    "name":"enhance",
    "params":{}
}

equalize

Equalizes an image (Auto-adjust image).

Looks like...

{
    "name":"equalize",
    "params":{}
}

gamma channel

Adjusts contrasts within the image.

Looks like...

{
    "name":"gamma_channel",
    "params":{
        "gamma":1.0
    }
}

PARAMS: Required / Optional

Name	Description
"gamma"	Gamma adjustent (Usually 0.8 to 2.3)

imagga smart crop

Uses Imagga image analysis tools to determine the best crop for you photo. This requires a Blitline+Imagga subscription.

Looks like...

{
  "name":"imagga_smart_crop",
  "params":{
    "resolution" : "150x150"
   }
}

PARAMS: Required / Optional

Name	Description
"resolution"	The height and width of the desired cropped image. (Height and width are separated by a lower case 'x')
"no_scaling"	Optional setting to not autoscale image, but to crop the raw original to the target area. Defaults to false

Example

line

Draws a linear line between two points.

Looks like...

{
    "name":"line",
    "params":{
        "x":10,
        "y":10,
        "x1":50,
        "y1":50,
        "width":1,
        "color":"#ffffff",
        "opacity":1.0,
        "line_cap":"butt"
    }
}

PARAMS: Required / Optional

Name	Description
"x"	Starting X coordinate
"y"	Starting Y coordinate
"x1"	Ending X coordinate
"y1"	Ending Y coordinate
"width"	Width of line (default 1)
"color"	Color of line (default "#ffffff")
"opacity"	Opacity of line (default 1.0)
"line_cap"	How the line ends. Only relevant for widths > 1. Two possible options are "butt"(default) and "round"(rounds ends).

median filter

Applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.

Looks like...

{
    "name":"median_filter",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"radius"	Radius of blur (defaults to 1.0)

modulate

Changes the brightness, saturation, and hue.

Looks like...

{
    "name":"modulate",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"Brightness"	Brightness adjustment (defaults to 1.0)
"Saturation"	Brightness adjustment(defaults to 1.0)
"Hue"	Hue adjustment (defaults to 1.0)

no op

Simple noop(no operation). No function performed on image. (If you are using this to move your original, please see 'move original' HERE instead)

Looks like...

{
    "name":"no_op",
    "params":{}
}

normalize

Changes the contrast of a color image by adjusting the pixel color to span the entire range of colors available.

Looks like...

{
    "name":"normalize",
    "params":{}
}

pad

Add empty space to one side or all sides of image (Useful for centering an image on a new canvas color)

Looks like...

{
    "name":"pad",
    "params":{
        "size":30
    }
}

PARAMS: Required / Optional

Name	Description
"size"	Thickness of padding
"gravity"	Location of padding (default "CenterGravity")
"color"	Color of padding (default "#ffffff")

Example

pad resize to fit

Resize to fit, but will pad to keep the aspect ratio. So for example, if you are going from a 3:4 aspect ratio to a 3:2 aspect ratio, this method will assure the result the desired output size, and pad the filled in area with a specified color.

Looks like...

{
    "name":"pad_resize_to_fit",
    "params":{
        "width":"300",
        "height":"200"
    }
}

PARAMS: Required / Optional

Name	Description
"width"	Output width
"height"	Output height
"color"	Color for the padding (defaults to "#ffffff")
"gravity"	Location of output relative to padding (defaults to center)

Example

photograph

Creates an image that has a white border, with a slight curl, that appears like a photograph

Looks like...

{
    "name":"photograph",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"angle"	Angle of rotation

quantize

Analyzes the colors within a reference image and chooses a fixed number of colors to represent the image

Looks like...

{
    "name":"quantize",
    "params":{
        "number_colors":8
    }
}

PARAMS: Required / Optional

Name	Description
"number_colors"	Number of colors to reduce to
"color_space"	The colorspace to quantize in (defaults to "RGBColorspace")
"dither"	Whether or not to use dithering on the resulting image (defaults to "false")

resize

Resize the image to a specific height and width.

Note: This is not used very often. You are probably looking for "resize_to_fit".

Looks like...

{
    "name":"resize",
    "params":{
        "width":10,
        "height":10
    }
}

PARAMS: Required / Optional

Name	Description
"width"	The new width of the image
"height"	The new height of the image
"scale_factor"	Instead of height and width you can set a scale factor. (eg 0.5 = 50%)

resize to fill

Resize the image to fit within the specified dimensions while retaining the aspect ratio of the original image. If necessary, crop the image in the larger dimension

Common English Translation: This is probably the crop you want if you want to cut a center piece out of a photo and use it as a thumbnail. This will cut out the center (by default) to your defined size.

Looks like...

{
    "name":"resize_to_fill",
    "params":{
        "width":40,
        "height":40
    }
}

PARAMS: Required / Optional

Name	Description
"width"	Width of desired image
"height"	Height of desired image
"gravity"	Location of crop (defaults to 'CenterGravity')
"only_shrink_larger"	Don't upsize image (defaults to false)

Example

resize to fit

Resize the image to fit within the specified dimensions while retaining the original aspect ratio. The image may be shorter or narrower than specified in the smaller dimension but will not be larger than the specified values

Common English Translation: This is probably the crop you want if you need to rescale a photo down to a smaller size while keeping the same height to width ratio.

Looks like...

{
    "name":"resize_to_fit",
    "params":{
        "width":40,
        "height":40
    }
}

PARAMS: Required / Optional

Name	Description
"width"	Width of desired image (optional if height defined)
"height"	Height of desired image (optional if width defined)
"only_shrink_larger"	Don't upsize image (defaults to false)

rotate

Rotates the image.

Looks like...

{
    "name":"rotate",
    "params":{
        "amount":25
    }
}

PARAMS: Required / Optional

Name	Description
"amount"	The number of degrees to rotate the image.

scale

Resize the image to a specific height and width.

Note: This is not used very often. You are probably looking for "resize_to_fit".

Looks like...

{
    "name":"scale",
    "params":{
        "width":10,
        "height":10
    }
}

PARAMS: Required / Optional

Name	Description
"width"	The new width of the image
"height"	The new height of the image
"scale_factor"	Instead of height and width you can set a scale factor. (eg 0.5 = 50%)

sepia tone

Applies sepia filter

Looks like...

{
    "name":"sepia_tone",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"threshold"	Threshold for quantizing sepia tone

sharpen

Sharpens the image

Looks like...

{
    "name":"sharpen",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"sigma"	Gaussian sigma of sharpen (defaults to 1.0)
"radius"	Gaussian radius of shapen (defaults to 0.0)

sketch

Simulates a pencil sketch.

Looks like...

{
    "name":"sketch",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"sigma"	Gaussian operator (defaults to 0.0)
"radius"	Gaussian operator (defaults to 0.0)
"angle"	Angle of sketch (defaults to 0.0)}

trim

Makes a 'best guess' crop to upper-left and lower-right corners. For example, if you have an image with a bunch of white border around it, and you want it cropped to only where there something other than the border color.

Looks like...

{
    "name":"trim",
    "params":{}
}

unsharp mask

Sharpens an image

Looks like...

{
    "name":"unsharp_mask",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"sigma"	Gaussian operator (defaults to 1.0)
"radius"	Gaussian operator (defaults to 0.0)
"amount"	The percentage of the blurred image to be added to the receiver, specified as a fraction between 0 and 1.0 (defaults to 1.0)
"threshold"	The threshold needed to apply the amount, specified as a fraction between 0 and 1.0 (defaults to 0.05)}

vignette

Gradually shades the edges of the image by transforming the pixels into the background color.

Looks like...

{
    "name":"vignette",
    "params":{}
}

PARAMS: Required / Optional

Name	Description
"color"	Background color to fade to (default is '#000000')
"x"	Influences the amount of background color in the horizontal dimension. (default = 10)
"y"	Influences the amount of background color in the vertical dimension. (default = 10)
"threshold"	The threshold needed to apply the amount, specified as a fraction between 0 and 1.0 (defaults to 0.05)
"sigma"	Gaussian operator (defaults to 10.0)
"radius"	Gaussian operator (defaults to 0.0)

watermark

Adds a text watermark to an image. For more control use 'annotate'

Looks like...

{
    "name":"watermark",
    "params":{
        "text":"Image processing by Blitline"
    }
}

PARAMS: Required / Optional

Name	Description
"text"	Text to add to image
"gravity"	Relative positioning of text (default is 'CenterGravity')
"point_size"	Point size of text. (default = 94)
"font_family"	Font family of text. (default = 'Helvetica')
"opacity"	The opacity of the text on the image (defaults to 0.45)

Example

Param Options

Gravity
options for placement on some functions

"gravity" : "EastGravity"

"gravity" : "WestGravity"

"gravity" : "NorthGravity"

"gravity" : "SouthGravity"

"gravity" : "NorthWestGravity"

"gravity" : "NorthEastGravity"

"gravity" : "SouthWestGravity"

"gravity" : "SouthEastGravity"

"gravity" : "CenterGravity"}

Interlace Type
options for saving interlance option

"type" : "UndefinedInterlace"

"type" : "NoInterlace"

"type" : "LineInterlace"

"type" : "PlaneInterlace"

"type" : "PartitionInterlace"}

Composite Ops
options for compositing

"composite_op" : "UndefinedCompositeOp"(No composite operator has been specified.)

"composite_op" : "AddCompositeOp" (The result of composite image + image, with overflow wrapping around (mod 256))

"composite_op" : "AtopCompositeOp" (The result is the same shape as image, with composite image obscuring image where the image shapes overlap. Note that this differs from OverCompositeOp because the portion of composite image outside of image’s shape does not appear in the result.

"composite_op" : "BumpmapCompositeOp" (The result image shaded by composite image.)

"composite_op" : "ColorBurnCompositeOp" (Darkens the destination color to reflect the source color. Painting with white produces no change.)

"composite_op" : "ColorDodgeCompositeOp" (Brightens the destination color to reflect the source color. Painting with black produces no change.)

"composite_op" : "ColorizeCompositeOp" (Each pixel in the result image is the combination of the brightness of the target image and the saturation and hue of the composite image. This is the opposite of LuminizeCompositeOp.)

"composite_op" : "CopyCompositeOp" (Replace the target image with the composite image.)

"composite_op" : "CopyBlackCompositeOp" (Copy the black channel from the composite image to the target image.)

"composite_op" : "CopyBlueCompositeOp" (Copy the blue channel from the composite image to the target image.)

"composite_op" : "CopyCyanCompositeOp" (Copy the cyan channel from the composite image to the target image.)

"composite_op" : "CopyGreenCompositeOp" (Copy the green channel from the composite image to the target image.)

"composite_op" : "CopyMagentaCompositeOp" (Copy the magenta channel from the composite image to the target image.)

"composite_op" : "CopyOpacityCompositeOp" (If the composite image’s matte attribute is true, copy the opacity channel from the composite image to the target image. Otherwise, set the target image pixel’s opacity to the intensity of the corresponding pixel in the composite image.)

"composite_op" : "CopyRedCompositeOp" (Copy the red channel from the composite image to the target image.)

"composite_op" : "CopyYellowCompositeOp" (Copy the yellow channel from the composite image to the target image.)

"composite_op" : "DarkenCompositeOp" (Replace target image pixels with darker pixels from the composite image.)

"composite_op" : "DifferenceCompositeOp" (The result of abs(composite image - image). This is useful for comparing two very similar images.)

"composite_op" : "DisplaceCompositeOp" (Displace target image pixels as defined by a displacement map. The operator used by the displace method.)

"composite_op" : "DissolveCompositeOp" (The operator used in the dissolve method.)

"composite_op" : "DstAtopCompositeOp" (The part of the destination lying inside of the source is composited over the source and replaces the destination.)

"composite_op" : "DstInCompositeOp" (The part of the destination lying inside of the source replaces the destination.)

"composite_op" : "DstOutCompositeOp" (The part of the destination lying outside of the source replaces the destination.)

"composite_op" : "DstOverCompositeOp" (The destination is composited over the source and the result replaces the destination.)

"composite_op" : "ExclusionCompositeOp" (Produces an effect similar to that of ’difference’, but appears as lower contrast. Painting with white inverts the destination color. Painting with black produces no change.)

"composite_op" : "HardLightCompositeOp" (Multiplies or screens the colors, dependent on the source color value. If the source color is lighter than 0.5, the destination is lightened as if it were screened. If the source color is darker than 0.5, the destination is darkened, as if it were multiplied. The degree of lightening or darkening is proportional to the difference between the source color and 0.5. If it is equal to 0.5 the destination is unchanged. Painting with pure black or white produces black or white.)

"composite_op" : "HueCompositeOp" (Each pixel in the result image is the combination of the hue of the target image and the saturation and brightness of the composite image.)

"composite_op" : "InCompositeOp" (The result is simply composite image cut by the shape of image. None of the image data of image is included in the result.)

"composite_op" : "LightenCompositeOp" (Replace target image pixels with lighter pixels from the composite image.)

"composite_op" : "LinearBurnCompositeOp" (Same as LinearDodgeCompositeOp, but also subtract one from the result. Sort of a additive ’Screen’ of the images.)

"composite_op" : "LinearDodgeCompositeOp" (This is equivelent to PlusCompositeOp in that the color channels are simply added, however it does not "plus" the alpha channel, but uses the normal OverCompositeOp alpha blending, which transparencies are involved. Produces a sort of additive multiply-like result.)

"composite_op" : "LinearLightCompositeOp" (Increase contrast slightly with an impact on the foreground’s tonal values.)

"composite_op" : "LuminizeCompositeOp" (Each pixel in the result image is the combination of the brightness of the composite image and the saturation and hue of the target image. This is the opposite of ColorizeCompositeOp.)

"composite_op" : "MinusCompositeOp" (The result of composite image - image, with overflow cropped to zero. The matte chanel is ignored (set to 255, full coverage).)

"composite_op" : "MultiplyCompositeOp" (Multiplies the color of each target image pixel by the color of the corresponding composite image pixel. The result color is always darker.)

"composite_op" : "NoCompositeOp" (No composite operator has been specified.)

"composite_op" : "OutCompositeOp" (The resulting image is composite image with the shape of image cut out.)

"composite_op" : "OverCompositeOp" (The result is the union of the the two image shapes with composite image obscuring image in the region of overlap. The matte channel of the composite image is respected, so that if the composite pixel is part or all transparent, the corresponding image pixel will show through.)

"composite_op" : "OverlayCompositeOp" (Multiplies or screens the colors, dependent on the destination color. Source colors overlay the destination whilst preserving its highlights and shadows. The destination color is not replaced, but is mixed with the source color to reflect the lightness or darkness of the destination.)

"composite_op" : "PinLightCompositeOp" (Similar to HardLightCompositeOp, but using sharp linear shadings, to similate the effects of a strong ’pinhole’ light source.)

"composite_op" : "PlusCompositeOp" (The result is just the sum of the image data. Output values are cropped to 255 (no overflow). This operation is independent of the matte channels.)

"composite_op" : "ReplaceCompositeOp" (The resulting image is image replaced with composite image. Here the matte information is ignored.)

"composite_op" : "SaturateCompositeOp" (Each pixel in the result image is the combination of the saturation of the target image and the hue and brightness of the composite image.)

"composite_op" : "ScreenCompositeOp" (Multiplies the inverse of each image’s color information.)

"composite_op" : "SoftLightCompositeOp" (Darkens or lightens the colors, dependent on the source color value. If the source color is lighter than 0.5, the destination is lightened. If the source color is darker than 0.5, the destination is darkened, as if it were burned in. The degree of darkening or lightening is proportional to the difference between the source color and 0.5. If it is equal to 0.5, the destination is unchanged. Painting with pure black or white produces a distinctly darker or lighter area, but does not result in pure black or white.)

"composite_op" : "SrcAtopCompositeOp" (The part of the source lying inside of the destination is composited onto the destination.)

"composite_op" : "SrcCompositeOp" (The source is copied to the destination. The destination is not used as input.)

"composite_op" : "SrcInCompositeOp" (The part of the source lying inside of the destination replaces the destination.)

"composite_op" : "SrcOutCompositeOp" (The part of the source lying outside of the destination replaces the destination.)

"composite_op" : "SrcOverCompositeOp" (The source is composited over the destination.)

"composite_op" : "SubtractCompositeOp" (The result of composite image - image, with underflow wrapping around (mod 256). The add and subtract operators can be used to perform reversable transformations.)

"composite_op" : "XorCompositeOp" (The result is the image data from both composite image and image that is outside the overlap region. The overlap region will be blank.)

Functions

annotate

append

blur

background color

composite

contrast

contrast stretch channel

convert command (beta)

crop

crop to square

delete profile

deskew

density

despeckle

enhance

equalize

gamma channel

imagga smart crop

line

median filter

modulate

no op

normalize

pad

pad resize to fit

photograph

quantize

resize

resize to fill

resize to fit

rotate

scale

sepia tone

sharpen

sketch

trim

unsharp mask

vignette

watermark

Param Options

Gravity options for placement on some functions

Interlace Type options for saving interlance option

Composite Ops options for compositing

Gravity
options for placement on some functions

Interlace Type
options for saving interlance option

Composite Ops
options for compositing