Monkeybread Xojo plugin - IMImage7MBS methods

Platforms to show: All Mac Windows Linux Cross-Platform

IMImage7MBS.Constructor(Pic as Picture)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new picture based on Xojo picture.

Creates a new image and uses SetPicture method to fill it.

See NewMagickImage function in ImageMagick documentation.

See also:

Constructor(columns as Integer, Rows as Integer, map as String, StorageType as Integer, Pixels as MemoryBlock)
Constructor(info as IMImageInfo7MBS)
Constructor(info as IMImageInfo7MBS, width as integer, height as integer, background as IMPixelInfo7MBS)

IMImage7MBS.Contrast(sharpen as boolean) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Enhances the intensity differences between the lighter and darker elements of the image.

Set sharpen to a True to increase the image contrast otherwise the contrast is reduced.

sharpen: Increase or decrease image contrast.

See ContrastImage function in ImageMagick documentation.

IMImage7MBS.ContrastStretch(BlackPoint as double, WhitePoint as double) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Is a simple image enhancement technique that attempts to improve the contrast in an image by 'stretching' the range of intensity values it contains to span a desired range of values.

It differs from the more sophisticated histogram equalization in that it can only apply a linear scaling function to the image pixel values. As a result the 'enhancement' is less harsh.

BlackPoint: the black point.
WhitePoint: the white point.

See ContrastStretchImage function in ImageMagick documentation.

IMImage7MBS.Convolve(kernelInfo as IMKernelInfo7MBS) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Applies a custom convolution kernel to the image.

See ConvolveImage function in ImageMagick documentation.

IMImage7MBS.CopyPicture as Picture

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Copies RGB or gray pixels into a new Xojo picture.

You must make sure you have the right color space to make this work well with colorspaces.
Xojo on Mac uses Generic RGB, while Windows may use the colorspace of the display.

As conversion between various quantum depths can be slow, please use rarely.

See also ExportPixels and ImportPixels to read/write pixel data to/from memory blocks.
See GetAuthenticPixels function in ImageMagick documentation.

IMImage7MBS.CreateHBITMAP as Ptr

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a Windows HBITMAP from an image.

See ImageToHBITMAP function in ImageMagick documentation.

IMImage7MBS.Crop(rect as IMRectangleInfo7MBS) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Extracts a region of the image starting at the offset defined by geometry.

Region must be fully defined, and no special handling of geometry flags is performed.

See CropImage function in ImageMagick documentation.

IMImage7MBS.CropToTiles(CropGeometry as string) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Crops a single image, into a possible list of tiles.

This may include a single sub-region of the image. This basically applies all the normal geometry flags for Crop.

CropGeometry: A crop geometry string.

See CropImageToTiles function in ImageMagick documentation.

IMImage7MBS.CycleColormap(displace as Integer) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Displaces an image's colormap by a given number of positions.

If you cycle the colormap a number of times you can produce a psychodelic effect.

WARNING: this assumes an images colormap is in a well know and defined order. Currently Imagemagick has no way of setting that order.

displace: displace the colormap this amount.

See CycleColormap function in ImageMagick documentation.

IMImage7MBS.Decipher(passkey as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Converts cipher pixels to plain pixels.

See xx function in ImageMagick documentation.

IMImage7MBS.DefineProperty(PropertyKeyValue as String) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Associates an assignment string of the form "key=value" with an artifact or options.

It is equivelent to SetProperty().
See DefineImageProperty function in ImageMagick documentation.

IMImage7MBS.DeleteImageProfile(Name as String) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Deletes a profile from the image by its name.

See xx function in ImageMagick documentation.

IMImage7MBS.DeleteProperty(Key as String) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Deletes an image property.

key: the image property.
See DeleteImageProperty function in ImageMagick documentation.

IMImage7MBS.Deskew(x as double) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Removes skew from the image.

Skew is an artifact that occurs in scanned images because of the camera being misaligned, imperfections in the scanning or surface, or simply because the paper was not placed completely flat when scanned.

The result will be auto-croped if the artifact "deskew:auto-crop" is defined, while the amount the image is to be deskewed, in degrees is also saved as the artifact "deskew:angle".

threshold: separate background from foreground.

See DeskewImage function in ImageMagick documentation.

IMImage7MBS.Despeckle as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reduces the speckle noise in an image while perserving the edges of the original image.

A speckle removing filter uses a complementary hulling technique (raising pixels that are darker than their surrounding neighbors, then complementarily lowering pixels that are brighter than their surrounding neighbors) to reduce the speckle index of that image (reference Crimmins speckle removal).

See DespeckleImage function in ImageMagick documentation.

IMImage7MBS.DestroyImageList

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Destroys an image list.

See DestroyImageList function in ImageMagick documentation.

IMImage7MBS.DestroyImageProfiles

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Releases memory associated with an image profile map.

See xx function in ImageMagick documentation.

IMImage7MBS.DestroyProperties

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Destroys all properties and associated memory attached to the given image.

See DestroyImageProperties function in ImageMagick documentation.

IMImage7MBS.DisposeImages as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns the coalesced frames of a GIF animation as it would appear after the GIF dispose method of that frame has been applied.

That is it returned the appearance of each frame before the next is overlaid.

See DisposeImages function in ImageMagick documentation.

IMImage7MBS.Distort(DistortImageMethod as integer, values() as double, bestfit as boolean) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Distorts an image using various distortion methods, by mapping color lookups of the source image to a new destination image usally of the same size as the source image, unless 'bestfit' is set to true.

If 'bestfit' is enabled, and distortion allows it, the destination image is adjusted to ensure the whole source 'image' will just fit within the final destination image, which will be sized and offset accordingly. Also in many cases the virtual offset of the source image will be taken into account in the mapping.

If the '-verbose' control option has been set print to standard error the equicelent '-fx' formula with coefficients for the function, if practical.

method: the method of image distortion.
ArcDistortion always ignores source image offset, and always 'bestfit' the destination image with the top left corner offset relative to the polar mapping center.
Affine, Perspective, and Bilinear, do least squares fitting of the distrotion when more than the minimum number of control point pairs are provided.
Perspective, and Bilinear, fall back to a Affine distortion when less than 4 control point pairs are provided. While Affine distortions let you use any number of control point pairs, that is Zero pairs is a No-Op (viewport only) distortion, one pair is a translation and two pairs of control points do a scale-rotate-translate, without any shearing.

values: an array of floating point arguments for this method.

bestfit: Attempt to 'bestfit' the size of the resulting image. This also forces the resulting image to be a 'layered' virtual canvas image. Can be overridden using 'distort:viewport' setting.

Extra Controls from Image meta-data (artifacts)...

"verbose" Output to stderr alternatives, internal coefficents, and FX equivalents for the distortion operation (if feasible). This forms an extra check of the distortion method, and allows users access to the internal constants IM calculates for the distortion.
"distort:viewport" Directly set the output image canvas area and offest to use for the resulting image, rather than use the original images canvas, or a calculated 'bestfit' canvas.
"distort:scale" Scale the size of the output canvas by this amount to provide a method of Zooming, and for super-sampling the results.

Other settings that can effect results include

'interpolate' For source image lookups (scale enlargements)
'filter' Set filter to use for area-resampling (scale shrinking). Set to 'point' to turn off and use 'interpolate' lookup instead

See DistortImage function in ImageMagick documentation.

IMImage7MBS.DistortResize(x as Integer, y as Integer) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Resize image using the equivalent but slower image distortion operator.

The filter is applied using a EWA cylindrical resampling. But like resize the final image size is limited to whole pixels with no effects by virtual-pixels on the result.

Note that images containing a transparency channel will be twice as slow to resize as images one without transparency.

See DistortResizeImage function in ImageMagick documentation.

IMImage7MBS.Edge(radius as double) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Finds edges in an image.

Radius defines the radius of the convolution filter. Use a radius of 0 and Edge selects a suitable radius for you.

radius: the radius of the pixel neighborhood.

See EdgeImage function in ImageMagick documentation.

IMImage7MBS.Emboss(radius as double, sigma as double) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns a grayscale image with a three-dimensional effect.

We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Emboss() selects a suitable radius for you.

radius: the radius of the pixel neighborhood.
sigma: the standard deviation of the Gaussian, in pixels.

See EmbossImage function in ImageMagick documentation.

IMImage7MBS.Encipher(passkey as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Converts pixels to cipher-pixels.

See xx function in ImageMagick documentation.

IMImage7MBS.Enhance as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Applies a digital filter that improves the quality of a noisy image.

See xx function in ImageMagick documentation.

IMImage7MBS.Equalize as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Applies a histogram equalization to the image.

See xx function in ImageMagick documentation.

IMImage7MBS.Excerpt(rect as IMRectangleInfo7MBS) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns a excerpt of the image as defined by the geometry.

geometry: Define the region of the image to extend with members x, y, width, and height.

See ExcerptImage function in ImageMagick documentation.

IMImage7MBS.ExportPixels(x as integer, y as integer, width as integer, height as integer, map as string, storageType as integer, data as Ptr) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Extracts pixel data from an image and returns it to you.

The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, Quantum, unsigned int, unsigned long long, float, or double in the order specified by map.

Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:

image.ExportImagePixels(0, 0, 640, 480, "RGB", kCharPixel, pixels)

x,y,width,height: These values define the perimeter of a region of pixels you want to extract.
map: This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.
type: Define the data type of the pixels. Float and double types are normalized to [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel (char *), DoublePixel (double *), FloatPixel (float *), LongPixel (unsigned int *), LongLongPixel (unsigned long long *), QuantumPixel (Quantum *), or ShortPixel (unsigned short *).

pixels: This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.

See ExportImagePixels function in ImageMagick documentation.

IMImage7MBS.Extent(rect as IMRectangleInfo7MBS) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Extends the image as defined by the geometry, gravity, and image background color.

Set the (x,y) offset of the geometry to move the original image relative to the extended image.

rect: Define the region of the image to extend with members x, y, width, and height.

See ExtentImage function in ImageMagick documentation.

See also:

Gamma as Double

IMImage7MBS.GaussianBlur(radius as double, sigma as double) as IMImage7MBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Blurs an image.

We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and GaussianBlur selects a suitable radius for you

radius: the radius of the Gaussian, in pixels, not counting the center pixel.
sigma: the standard deviation of the Gaussian, in pixels.

See GaussianBlurImage function in ImageMagick documentation.

IMImage7MBS.GetImageDynamicThreshold(clusterThreshold as Double, smoothThreshold as Double, byref pixelinfo as IMPixelInfo7MBS) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns the dynamic threshold for an image.

clusterThreshold: This double represents the minimum number of pixels contained in a hexahedra before it can be considered valid (expressed as a percentage).
smoothThreshold: the smoothing threshold eliminates noise in the second derivative of the histogram. As the value is increased, you can expect a smoother second derivative.
pixelinfo: return the dynamic threshold here.

Returns true on success.
See GetImageDynamicThreshold function in ImageMagick documentation.

IMImage7MBS.GetImageProfile(name as string) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets a profile associated with an image by name.

See xx function in ImageMagick documentation.

IMImage7MBS.GetImageQuantizeError as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Measures the difference between the original and quantized images.

This difference is the total quantization error.
The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value. These values are computed:

mean_error_per_pixel: This value is the mean error for any single pixel in the image.
normalized_mean_square_error: This value is the normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.
normalized_maximum_square_error: This value is the normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.

See GetImageQuantizeError function in ImageMagick documentation.

IMImage7MBS.GetMagickProperty(ImageInfo as IMImageInfo7MBS = nil, embedText as String) as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets attributes or calculated values that is associated with a fixed known property name, or single letter property.

It may be called if no image is defined (IMv7), in which case only global ImageInfo values are available:

\n newline
\r carriage return
< less-than character.
> greater-than character.
& ampersand character.
%% a percent sign
%b file size of image read in
%c comment meta-data property
%d directory component of path
%e filename extension or suffix
%f filename (including suffix)
%g layer canvas page geometry (equivalent to "%Wx%H%X%Y")
%h current image height in pixels
%i image filename (note: becomes output filename for "info:")
%k CALCULATED: number of unique colors
%l label meta-data property
%m image file format (file magic)
%n number of images in current image sequence
%o output filename (used for delegates)
%p index of image in current image list
%q quantum depth (compile-time constant)
%r image class and colorspace
%s scene number (from input unless re-assigned)
%t filename without directory or extension (suffix)
%u unique temporary filename (used for delegates)
%w current width in pixels
%x x resolution (density)
%y y resolution (density)
%z image depth (as read in unless modified, image save depth)
%A image transparency channel enabled (true/false)
%B file size of image in bytes
%C image compression type
%D image GIF dispose method
%G original image size (%wx%h; before any resizes)
%H page (canvas) height
%M Magick filename (original file exactly as given, including read mods)
%O page (canvas) offset ( = %X%Y )
%P page (canvas) size ( = %Wx%H )
%Q image compression quality ( 0 = default )
%S ?? scenes ??
%T image time delay (in centi-seconds)
%U image resolution units
%W page (canvas) width
%X page (canvas) x offset (including sign)
%Y page (canvas) y offset (including sign)
%Z unique filename (used for delegates)
%@ CALCULATED: trim bounding box (without actually trimming)
%# CALCULATED: 'signature' hash of image values

This routine only handles specifically known properties. It does not handle special prefixed properties, profiles, or expressions. Nor does it return any free-form property strings.

The returned string is stored in a structure somewhere, and should not be directly freed. If the string was generated (common) the string will be stored as as either as artifact or option 'get-property'. These may be deleted (cleaned up) when no longer required, but neither artifact or option is guranteed to exist.
See GetMagickProperty function in ImageMagick documentation.

IMImage7MBS.GetNextImageProfile as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	ImageMagick7	MBS GraphicsMagick Plugin	20.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets the next profile name for an image.

See xx function in ImageMagick documentation.

Previous items Next items

The items on this page are in the following plugins: MBS GraphicsMagick Plugin.

💬 Ask a question or report a problem