Class: Vips::Image

Inherits:

Object

• Object
• GObject::GObject
• Object
• Vips::Image

Defined in:

lib/vips/image.rb,
lib/vips/methods.rb

Overview

This class represents a libvips image. See the Vips module documentation for an introduction to using this class.

Defined Under Namespace

Modules: ImageLayout Classes: ManagedStruct, Struct

Class Method Summary

• .analyzeload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load an analyze6 image.

• .arrayjoin(im, opts = {}) ⇒ Vips::Image

  Join an array of images.

• .bandrank(im, opts = {}) ⇒ Vips::Image

  Band-wise rank of a set of images.

• .black(width, height, opts = {}) ⇒ Vips::Image

  Make a black image.

• .csvload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load csv from file.

• .eye(width, height, opts = {}) ⇒ Vips::Image

  Make an image showing the eye's spatial response.

• .fitsload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load a fits image.

• .fractsurf(width, height, fractal_dimension, opts = {}) ⇒ Vips::Image

  Make a fractal surface.

• .gaussmat(sigma, min_ampl, opts = {}) ⇒ Vips::Image

  Make a gaussian image.

• .gaussnoise(width, height, opts = {}) ⇒ Vips::Image

  Make a gaussnoise image.

• .gifload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load gif with giflib.

• .gifload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load gif with giflib.

• .grey(width, height, opts = {}) ⇒ Vips::Image

  Make a grey ramp image.

• .identity(opts = {}) ⇒ Vips::Image

  Make a 1d image where pixel values are indexes.

• .jpegload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load jpeg from file.

• .jpegload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load jpeg from buffer.

• .logmat(sigma, min_ampl, opts = {}) ⇒ Vips::Image

  Make a laplacian of gaussian image.

• .magickload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load file with imagemagick.

• .magickload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load buffer with imagemagick.

• .mask_butterworth(width, height, order, frequency_cutoff, amplitude_cutoff, opts = {}) ⇒ Vips::Image

  Make a butterworth filter.

• .mask_butterworth_band(width, height, order, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {}) ⇒ Vips::Image

  Make a butterworth_band filter.

• .mask_butterworth_ring(width, height, order, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {}) ⇒ Vips::Image

  Make a butterworth ring filter.

• .mask_fractal(width, height, fractal_dimension, opts = {}) ⇒ Vips::Image

  Make fractal filter.

• .mask_gaussian(width, height, frequency_cutoff, amplitude_cutoff, opts = {}) ⇒ Vips::Image

  Make a gaussian filter.

• .mask_gaussian_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {}) ⇒ Vips::Image

  Make a gaussian filter.

• .mask_gaussian_ring(width, height, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {}) ⇒ Vips::Image

  Make a gaussian ring filter.

• .mask_ideal(width, height, frequency_cutoff, opts = {}) ⇒ Vips::Image

  Make an ideal filter.

• .mask_ideal_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, opts = {}) ⇒ Vips::Image

  Make an ideal band filter.

• .mask_ideal_ring(width, height, frequency_cutoff, ringwidth, opts = {}) ⇒ Vips::Image

  Make an ideal ring filter.

• .matload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load mat from file.

• .matrix_from_array(width, height, array) ⇒ Object
• .matrixload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load matrix from file.

• .method_missing(name, *args, **options) ⇒ Object

  Invoke a vips operation with Operation.call.

• .new_from_array(array, scale = 1, offset = 0) ⇒ Image

  Create a new Image from a 1D or 2D array.

• .new_from_buffer(data, option_string, opts = {}) ⇒ Image

  Create a new Image for an image encoded, in a format such as JPEG, in a memory string.

• .new_from_file(name, opts = {}) ⇒ Image

  Return a new Image for a file on disc.

• .openexrload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load an openexr image.

• .openslideload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load file with openslide.

• .pdfload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load pdf with libpoppler.

• .pdfload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load pdf with libpoppler.

• .perlin(width, height, opts = {}) ⇒ Vips::Image

  Make a perlin noise image.

• .pngload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load png from file.

• .pngload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load png from buffer.

• .ppmload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load ppm from file.

• .radload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load a radiance image from a file.

• .rawload(filename, width, height, bands, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load raw data from a file.

• .respond_to?(name, include_all = false) ⇒ Boolean
• .sines(width, height, opts = {}) ⇒ Vips::Image

  Make a 2d sine wave.

• .sum(im, opts = {}) ⇒ Vips::Image

  Sum an array of images.

• .svgload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load svg with rsvg.

• .svgload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load svg with rsvg.

• .system(cmd_format, opts = {}) ⇒ nil, Hash<Symbol => Object>

  Run an external command.

• .text(text, opts = {}) ⇒ Vips::Image

  Make a text image.

• .thumbnail(filename, width, opts = {}) ⇒ Vips::Image

  Generate thumbnail from file.

• .thumbnail_buffer(buffer, width, opts = {}) ⇒ Vips::Image

  Generate thumbnail from buffer.

• .tiffload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load tiff from file.

• .tiffload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load tiff from buffer.

• .tonelut(opts = {}) ⇒ Vips::Image

  Build a look-up table.

• .vipsload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load vips from file.

• .webpload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load webp from file.

• .webpload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Load webp from buffer.

• .worley(width, height, opts = {}) ⇒ Vips::Image

  Make a worley noise image.

• .xyz(width, height, opts = {}) ⇒ Vips::Image

  Make an image where pixel values are coordinates.

• .zone(width, height, opts = {}) ⇒ Vips::Image

  Make a zone plate.

Instance Method Summary

• #! ⇒ Image

  Equivalent to image ^ -1.

• #!=(other) ⇒ Image

  Compare inequality to nil, an image, constant or array.

• #%(other) ⇒ Image

  Remainder after integer division with an image, constant or array.

• #&(other) ⇒ Image

  Integer bitwise AND with an image, constant or array.

• #*(other) ⇒ Image

  Multiply an image, constant or array.

• #**(other) ⇒ Image

  Raise to power of an image, constant or array.

• #+(other) ⇒ Image

  Add an image, constant or array.

• #+@ ⇒ Image

  Image.

• #-(other) ⇒ Image

  Subtract an image, constant or array.

• #-@ ⇒ Image

  Equivalent to image * -1.

• #/(other) ⇒ Image

  Divide an image, constant or array.

• #<(other) ⇒ Image

  Relational less than with an image, constant or array.

• #<<(other) ⇒ Image

  Integer left shift with an image, constant or array.

• #<=(other) ⇒ Image

  Relational less than or equal to with an image, constant or array.

• #==(other) ⇒ Image

  Compare equality to nil, an image, constant or array.

• #>(other) ⇒ Image

  Relational more than with an image, constant or array.

• #>=(other) ⇒ Image

  Relational more than or equal to with an image, constant or array.

• #>>(other) ⇒ Image

  Integer right shift with an image, constant or array.

• #[](index) ⇒ Image

  Fetch bands using a number or a range.

• #^(other) ⇒ Image

  Integer bitwise EOR with an image, constant or array.

• #abs(opts = {}) ⇒ Vips::Image

  Absolute value of an image.

• #acos ⇒ Image

  Return the inverse cosine of an image in degrees.

• #add(right, opts = {}) ⇒ Vips::Image

  Add two images.

• #affine(matrix, opts = {}) ⇒ Vips::Image

  Affine transform of an image.

• #asin ⇒ Image

  Return the inverse sine of an image in degrees.

• #atan ⇒ Image

  Return the inverse tangent of an image in degrees.

• #autorot(opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Autorotate image by exif tag.

• #avg(opts = {}) ⇒ Float

  Find image average.

• #bandand ⇒ Image

  AND the bands of an image together.

• #bandbool(boolean, opts = {}) ⇒ Vips::Image

  Boolean operation across image bands.

• #bandeor ⇒ Image

  EOR the bands of an image together.

• #bandfold(opts = {}) ⇒ Vips::Image

  Fold up x axis into bands.

• #bandjoin(other) ⇒ Image

  Join a set of images bandwise.

• #bandjoin_const(c, opts = {}) ⇒ Vips::Image

  Append a constant band to an image.

• #bandmean(opts = {}) ⇒ Vips::Image

  Band-wise average.

• #bandor ⇒ Image

  OR the bands of an image together.

• #bands ⇒ Integer

  Get number of image bands.

• #bandsplit ⇒ Array<Image>

  Split an n-band image into n separate images.

• #bandunfold(opts = {}) ⇒ Vips::Image

  Unfold image bands into x axis.

• #boolean(right, boolean, opts = {}) ⇒ Vips::Image

  Boolean operation on two images.

• #boolean_const(boolean, c, opts = {}) ⇒ Vips::Image

  Boolean operations against a constant.

• #buildlut(opts = {}) ⇒ Vips::Image

  Build a look-up table.

• #byteswap(opts = {}) ⇒ Vips::Image

  Byteswap an image.

• #cache(opts = {}) ⇒ Vips::Image

  Cache an image.

• #cast(format, opts = {}) ⇒ Vips::Image

  Cast an image.

• #ceil ⇒ Image

  Return the smallest integral value not less than the argument.

• #CMC2LCh(opts = {}) ⇒ Vips::Image

  Transform lch to cmc.

• #coding ⇒ Symbol

  Get image coding.

• #colourspace(space, opts = {}) ⇒ Vips::Image

  Convert to a new colorspace.

• #compass(mask, opts = {}) ⇒ Vips::Image

  Convolve with rotating mask.

• #complex(cmplx, opts = {}) ⇒ Vips::Image

  Perform a complex operation on an image.

• #complex2(right, cmplx, opts = {}) ⇒ Vips::Image

  Complex binary operations on two images.

• #complexform(right, opts = {}) ⇒ Vips::Image

  Form a complex image from two real images.

• #complexget(get, opts = {}) ⇒ Vips::Image

  Get a component from a complex image.

• #conj ⇒ Image

  Return the complex conjugate of an image.

• #conv(mask, opts = {}) ⇒ Vips::Image

  Convolution operation.

• #conva(mask, opts = {}) ⇒ Vips::Image

  Approximate integer convolution.

• #convasep(mask, opts = {}) ⇒ Vips::Image

  Approximate separable integer convolution.

• #convf(mask, opts = {}) ⇒ Vips::Image

  Float convolution operation.

• #convi(mask, opts = {}) ⇒ Vips::Image

  Int convolution operation.

• #convsep(mask, opts = {}) ⇒ Vips::Image

  Seperable convolution operation.

• #copy(opts = {}) ⇒ Vips::Image

  Copy an image.

• #copy_memory ⇒ Object
• #cos ⇒ Image

  Return the cosine of an image in degrees.

• #countlines(direction, opts = {}) ⇒ Float

  Count lines in an image.

• #cross_phase(other) ⇒ Image

  Calculate the cross phase of two images.

• #csvsave(filename, opts = {}) ⇒ nil

  Save image to csv file.

• #dE00(right, opts = {}) ⇒ Vips::Image

  Calculate de00.

• #dE76(right, opts = {}) ⇒ Vips::Image

  Calculate de76.

• #dECMC(right, opts = {}) ⇒ Vips::Image

  Calculate decmc.

• #deviate(opts = {}) ⇒ Float

  Find image standard deviation.

• #dilate(mask) ⇒ Image

  Dilate with a structuring element.

• #divide(right, opts = {}) ⇒ Vips::Image

  Divide two images.

• #draw_circle(ink, cx, cy, radius, opts = {}) ⇒ Vips::Image

  Draw a circle on an image.

• #draw_flood(ink, x, y, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Flood-fill an area.

• #draw_image(sub, x, y, opts = {}) ⇒ Vips::Image

  Paint an image into another image.

• #draw_line(ink, x1, y1, x2, y2, opts = {}) ⇒ Vips::Image

  Draw a line on an image.

• #draw_mask(ink, mask, x, y, opts = {}) ⇒ Vips::Image

  Draw a mask on an image.

• #draw_rect(ink, left, top, width, height, opts = {}) ⇒ Vips::Image

  Paint a rectangle on an image.

• #draw_smudge(left, top, width, height, opts = {}) ⇒ Vips::Image

  Blur a rectangle on an image.

• #dzsave(filename, opts = {}) ⇒ nil

  Save image to deepzoom file.

• #dzsave_buffer(opts = {}) ⇒ VipsBlob

  Save image to dz buffer.

• #embed(x, y, width, height, opts = {}) ⇒ Vips::Image

  Embed an image in a larger image.

• #erode(mask) ⇒ Image

  Erode with a structuring element.

• #exp ⇒ Image

  Return e ** pixel.

• #exp10 ⇒ Image

  Return 10 ** pixel.

• #extract_area(left, top, width, height, opts = {}) ⇒ Vips::Image

  Extract an area from an image.

• #extract_band(band, opts = {}) ⇒ Vips::Image

  Extract band from an image.

• #falsecolour(opts = {}) ⇒ Vips::Image

  False-color an image.

• #fastcor(ref, opts = {}) ⇒ Vips::Image

  Fast correlation.

• #filename ⇒ String

  Get image filename, if any.

• #fitssave(filename, opts = {}) ⇒ nil

  Save image to fits file.

• #flatten(opts = {}) ⇒ Vips::Image

  Flatten alpha out of an image.

• #flip(direction, opts = {}) ⇒ Vips::Image

  Flip an image.

• #fliphor ⇒ Image

  Flip horizontally.

• #flipver ⇒ Image

  Flip vertically.

• #float2rad(opts = {}) ⇒ Vips::Image

  Transform float rgb to radiance coding.

• #floor ⇒ Image

  Return the largest integral value not greater than the argument.

• #format ⇒ Symbol

  Get image format.

• #freqmult(mask, opts = {}) ⇒ Vips::Image

  Frequency-domain filtering.

• #fwfft(opts = {}) ⇒ Vips::Image

  Forward fft.

• #gamma(opts = {}) ⇒ Vips::Image

  Gamma an image.

• #gaussblur(sigma, opts = {}) ⇒ Vips::Image

  Gaussian blur.

• #get(name) ⇒ Object

  Get a metadata item from an image.

• #get_fields ⇒ [String]

  Get the names of all fields on an image.

• #get_typeof(name) ⇒ Integer

  Fetch a GType from an image.

• #get_value(name) ⇒ Object

  compatibility: old name for get.

• #getpoint(x, y, opts = {}) ⇒ Array<Double>

  Read a point from an image.

• #globalbalance(opts = {}) ⇒ Vips::Image

  Global balance an image mosaic.

• #grid(tile_height, across, down, opts = {}) ⇒ Vips::Image

  Grid an image.

• #height ⇒ Integer

  Get image height, in pixels.

• #hist_cum(opts = {}) ⇒ Vips::Image

  Form cumulative histogram.

• #hist_entropy(opts = {}) ⇒ Float

  Estimate image entropy.

• #hist_equal(opts = {}) ⇒ Vips::Image

  Histogram equalisation.

• #hist_find(opts = {}) ⇒ Vips::Image

  Find image histogram.

• #hist_find_indexed(index, opts = {}) ⇒ Vips::Image

  Find indexed image histogram.

• #hist_find_ndim(opts = {}) ⇒ Vips::Image

  Find n-dimensional image histogram.

• #hist_ismonotonic(opts = {}) ⇒ Boolean

  Test for monotonicity.

• #hist_local(width, height, opts = {}) ⇒ Vips::Image

  Local histogram equalisation.

• #hist_match(ref, opts = {}) ⇒ Vips::Image

  Match two histograms.

• #hist_norm(opts = {}) ⇒ Vips::Image

  Normalise histogram.

• #hist_plot(opts = {}) ⇒ Vips::Image

  Plot histogram.

• #hough_circle(opts = {}) ⇒ Vips::Image

  Find hough circle transform.

• #hough_line(opts = {}) ⇒ Vips::Image

  Find hough line transform.

• #HSV2sRGB(opts = {}) ⇒ Vips::Image

  Transform hsv to srgb.

• #icc_export(opts = {}) ⇒ Vips::Image

  Output to device with icc profile.

• #icc_import(opts = {}) ⇒ Vips::Image

  Import from device with icc profile.

• #icc_transform(output_profile, opts = {}) ⇒ Vips::Image

  Transform between devices with icc profiles.

• #ifthenelse(th, el, opts = {}) ⇒ Image

  Select pixels from th if self is non-zero and from el if self is zero.

• #imag ⇒ Image

  Return the imaginary part of a complex image.

• #insert(sub, x, y, opts = {}) ⇒ Vips::Image

  Insert image @sub into @main at @x, @y.

• #inspect ⇒ Object
• #interpretation ⇒ Symbol

  Get image interpretation.

• #invert(opts = {}) ⇒ Vips::Image

  Invert an image.

• #invertlut(opts = {}) ⇒ Vips::Image

  Build an inverted look-up table.

• #invfft(opts = {}) ⇒ Vips::Image

  Inverse fft.

• #join(in2, direction, opts = {}) ⇒ Vips::Image

  Join a pair of images.

• #jpegsave(filename, opts = {}) ⇒ nil

  Save image to jpeg file.

• #jpegsave_buffer(opts = {}) ⇒ VipsBlob

  Save image to jpeg buffer.

• #jpegsave_mime(opts = {}) ⇒ nil

  Save image to jpeg mime.

• #Lab2LabQ(opts = {}) ⇒ Vips::Image

  Transform float lab to labq coding.

• #Lab2LabS(opts = {}) ⇒ Vips::Image

  Transform float lab to signed short.

• #Lab2LCh(opts = {}) ⇒ Vips::Image

  Transform lab to lch.

• #Lab2XYZ(opts = {}) ⇒ Vips::Image

  Transform cielab to xyz.

• #labelregions(opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Label regions in an image.

• #LabQ2Lab(opts = {}) ⇒ Vips::Image

  Unpack a labq image to float lab.

• #LabQ2LabS(opts = {}) ⇒ Vips::Image

  Unpack a labq image to short lab.

• #LabQ2sRGB(opts = {}) ⇒ Vips::Image

  Convert a labq image to srgb.

• #LabS2Lab(opts = {}) ⇒ Vips::Image

  Transform signed short lab to float.

• #LabS2LabQ(opts = {}) ⇒ Vips::Image

  Transform short lab to labq coding.

• #LCh2CMC(opts = {}) ⇒ Vips::Image

  Transform lch to cmc.

• #LCh2Lab(opts = {}) ⇒ Vips::Image

  Transform lch to lab.

• #linear(a, b, opts = {}) ⇒ Vips::Image

  Calculate (a * in + b).

• #linecache(opts = {}) ⇒ Vips::Image

  Cache an image as a set of lines.

• #log ⇒ Image

  Return the natural log of an image.

• #log10 ⇒ Image

  Return the log base 10 of an image.

• #mapim(index, opts = {}) ⇒ Vips::Image

  Resample with an mapim image.

• #maplut(lut, opts = {}) ⇒ Vips::Image

  Map an image though a lut.

• #match(sec, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts = {}) ⇒ Vips::Image

  First-order match of two images.

• #math(math, opts = {}) ⇒ Vips::Image

  Apply a math operation to an image.

• #math2(right, math2, opts = {}) ⇒ Vips::Image

  Binary math operations.

• #math2_const(math2, c, opts = {}) ⇒ Vips::Image

  Binary math operations with a constant.

• #matrixprint(opts = {}) ⇒ nil

  Print matrix.

• #matrixsave(filename, opts = {}) ⇒ nil

  Save image to matrix file.

• #max(opts = {}) ⇒ Float, Hash<Symbol => Object>

  Find image maximum.

• #maxpos ⇒ Real

  Return the coordinates of the image maximum.

• #measure(h, v, opts = {}) ⇒ Vips::Image

  Measure a set of patches on a color chart.

• #median(size = 3) ⇒ Image

  a median filter.

• #merge(sec, direction, dx, dy, opts = {}) ⇒ Vips::Image

  Merge two images.

• #method_missing(name, *args, **options) ⇒ Object

  Invoke a vips operation with Operation.call, using self as the first input argument.

• #min(opts = {}) ⇒ Float, Hash<Symbol => Object>

  Find image minimum.

• #minpos ⇒ Real

  Return the coordinates of the image minimum.

• #morph(mask, morph, opts = {}) ⇒ Vips::Image

  Morphology operation.

• #mosaic(sec, direction, xref, yref, xsec, ysec, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

  Mosaic two images.

• #mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts = {}) ⇒ Vips::Image

  First-order mosaic of two images.

• #msb(opts = {}) ⇒ Vips::Image

  Pick most-significant byte from an image.

• #multiply(right, opts = {}) ⇒ Vips::Image

  Multiply two images.

• #new_from_image(value) ⇒ Image

  A new image is created with the same width, height, format, interpretation, resolution and offset as self, but with every pixel set to the specified value.

• #offset ⇒ Float

  Get offset metadata.

• #parent_get_typeof ⇒ Object
• #percent(percent, opts = {}) ⇒ Integer

  Find threshold for percent of pixels.

• #phasecor(in2, opts = {}) ⇒ Vips::Image

  Calculate phase correlation.

• #pngsave(filename, opts = {}) ⇒ nil

  Save image to png file.

• #pngsave_buffer(opts = {}) ⇒ VipsBlob

  Save image to png buffer.

• #polar ⇒ Image

  Return an image with rectangular pixels converted to polar.

• #ppmsave(filename, opts = {}) ⇒ nil

  Save image to ppm file.

• #premultiply(opts = {}) ⇒ Vips::Image

  Premultiply image alpha.

• #profile(opts = {}) ⇒ Array<] First non-zero pixel in column, First non-zero pixel in row

  Find image profiles.

• #project(opts = {}) ⇒ Array<] Sums of columns, Sums of rows

  Find image projections.

• #quadratic(coeff, opts = {}) ⇒ Vips::Image

  Resample an image with a quadratic transform.

• #rad2float(opts = {}) ⇒ Vips::Image

  Unpack radiance coding to float rgb.

• #radsave(filename, opts = {}) ⇒ nil

  Save image to radiance file.

• #radsave_buffer(opts = {}) ⇒ VipsBlob

  Save image to radiance buffer.

• #rank(width, height, index, opts = {}) ⇒ Vips::Image

  Rank filter.

• #rawsave(filename, opts = {}) ⇒ nil

  Save image to raw file.

• #rawsave_fd(fd, opts = {}) ⇒ nil

  Write raw image to file descriptor.

• #real ⇒ Image

  Return the real part of a complex image.

• #recomb(m, opts = {}) ⇒ Vips::Image

  Linear recombination with matrix.

• #rect ⇒ Image

  Return an image with polar pixels converted to rectangular.

• #reduce(hshrink, vshrink, opts = {}) ⇒ Vips::Image

  Reduce an image.

• #reduceh(hshrink, opts = {}) ⇒ Vips::Image

  Shrink an image horizontally.

• #reducev(vshrink, opts = {}) ⇒ Vips::Image

  Shrink an image vertically.

• #relational(right, relational, opts = {}) ⇒ Vips::Image

  Relational operation on two images.

• #relational_const(relational, c, opts = {}) ⇒ Vips::Image

  Relational operations against a constant.

• #remainder(right, opts = {}) ⇒ Vips::Image

  Remainder after integer division of two images.

• #remainder_const(c, opts = {}) ⇒ Vips::Image

  Remainder after integer division of an image and a constant.

• #remove(name) ⇒ Object

  Remove a metadata item from an image.

• #replicate(across, down, opts = {}) ⇒ Vips::Image

  Replicate an image.

• #resize(scale, opts = {}) ⇒ Vips::Image

  Resize an image.

• #respond_to?(name, include_all = false) ⇒ Boolean
• #rint ⇒ Image

  Return the nearest integral value.

• #rot(angle, opts = {}) ⇒ Vips::Image

  Rotate an image.

• #rot180 ⇒ Image

  Rotate by 180 degrees clockwise.

• #rot270 ⇒ Image

  Rotate by 270 degrees clockwise.

• #rot45(opts = {}) ⇒ Vips::Image

  Rotate an image.

• #rot90 ⇒ Image

  Rotate by 90 degrees clockwise.

• #round(round, opts = {}) ⇒ Vips::Image

  Perform a round function on an image.

• #scale ⇒ Float

  Get scale metadata.

• #scaleimage(opts = {}) ⇒ Vips::Image

  Scale an image to uchar.

• #scRGB2BW(opts = {}) ⇒ Vips::Image

  Convert scrgb to bw.

• #scRGB2sRGB(opts = {}) ⇒ Vips::Image

  Convert an scrgb image to srgb.

• #scRGB2XYZ(opts = {}) ⇒ Vips::Image

  Transform scrgb to xyz.

• #sequential(opts = {}) ⇒ Vips::Image

  Check sequential access.

• #set(name, value) ⇒ Object

  Set the value of a metadata item on an image.

• #set_type(gtype, name, value) ⇒ Object

  Create a metadata item on an image, of the specifed type.

• #set_value(name, value) ⇒ Object

  compatibility: old name for set.

• #sharpen(opts = {}) ⇒ Vips::Image

  Unsharp masking for print.

• #shrink(hshrink, vshrink, opts = {}) ⇒ Vips::Image

  Shrink an image.

• #shrinkh(hshrink, opts = {}) ⇒ Vips::Image

  Shrink an image horizontally.

• #shrinkv(vshrink, opts = {}) ⇒ Vips::Image

  Shrink an image vertically.

• #sign(opts = {}) ⇒ Vips::Image

  Unit vector of pixel.

• #similarity(opts = {}) ⇒ Vips::Image

  Similarity transform of an image.

• #sin ⇒ Image

  Return the sine of an image in degrees.

• #size ⇒ Integer

  Get the image size.

• #smartcrop(width, height, opts = {}) ⇒ Vips::Image

  Extract an area from an image.

• #spcor(ref, opts = {}) ⇒ Vips::Image

  Spatial correlation.

• #spectrum(opts = {}) ⇒ Vips::Image

  Make displayable power spectrum.

• #sRGB2HSV(opts = {}) ⇒ Vips::Image

  Transform srgb to hsv.

• #sRGB2scRGB(opts = {}) ⇒ Vips::Image

  Convert an srgb image to scrgb.

• #stats(opts = {}) ⇒ Vips::Image

  Find image average.

• #stdif(width, height, opts = {}) ⇒ Vips::Image

  Statistical difference.

• #subsample(xfac, yfac, opts = {}) ⇒ Vips::Image

  Subsample an image.

• #subtract(right, opts = {}) ⇒ Vips::Image

  Subtract two images.

• #tan ⇒ Image

  Return the tangent of an image in degrees.

• #tiffsave(filename, opts = {}) ⇒ nil

  Save image to tiff file.

• #tiffsave_buffer(opts = {}) ⇒ VipsBlob

  Save image to tiff buffer.

• #tilecache(opts = {}) ⇒ Vips::Image

  Cache an image as a set of tiles.

• #to_a ⇒ Array

  Convert to an Array.

• #unpremultiply(opts = {}) ⇒ Vips::Image

  Unpremultiply image alpha.

• #vipssave(filename, opts = {}) ⇒ nil

  Save image to vips file.

• #webpsave(filename, opts = {}) ⇒ nil

  Save image to webp file.

• #webpsave_buffer(opts = {}) ⇒ VipsBlob

  Save image to webp buffer.

• #width ⇒ Integer

  Get image width, in pixels.

• #wrap(opts = {}) ⇒ Vips::Image

  Wrap image origin.

• #write_to_buffer(format_string, opts = {}) ⇒ String

  Write this image to a memory buffer.

• #write_to_file(name, opts = {}) ⇒ Object

  Write this image to a file.

• #write_to_memory ⇒ String

  Write this image to a large memory buffer.

• #xoffset ⇒ Integer

  Get image xoffset.

• #xres ⇒ Float

  Get image x resolution.

• #XYZ2Lab(opts = {}) ⇒ Vips::Image

  Transform xyz to lab.

• #XYZ2scRGB(opts = {}) ⇒ Vips::Image

  Transform xyz to scrgb.

• #XYZ2Yxy(opts = {}) ⇒ Vips::Image

  Transform xyz to yxy.

• #yoffset ⇒ Integer

  Get image yoffset.

• #yres ⇒ Float

  Get image y resolution.

• #Yxy2XYZ(opts = {}) ⇒ Vips::Image

  Transform yxy to xyz.

• #zoom(xfac, yfac, opts = {}) ⇒ Vips::Image

  Zoom an image.

• #|(other) ⇒ Image

  Integer bitwise OR with an image, constant or array.

• #~ ⇒ Image

  Equivalent to image ^ -1.

Methods inherited from Object

#get_pspec, #get_typeof_error, print_all

Methods inherited from GObject::GObject

ffi_managed_struct, #ffi_managed_struct, #ffi_struct, ffi_struct, #initialize

Constructor Details

This class inherits a constructor from GObject::GObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, **options) ⇒ Object

Invoke a vips operation with Operation.call, using self as the first input argument.

Parameters:

• vips operation to call

Returns:

• result of vips operation

# File 'lib/vips/image.rb', line 194

def method_missing name, *args, **options
    Vips::Operation.call name.to_s, [self, *args], options
end

Class Method Details

.analyzeload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load an analyze6 image.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 871

.arrayjoin(im, opts = {}) ⇒ Vips::Image

Join an array of images.

Parameters:

• Array of input images

• (defaults to: {})

  Set of options

Options Hash (opts):

• :across (Integer) —

  Number of images across grid

• :shim (Integer) —

  Pixels between images

• :background (Array<Double>) —

  Colour for new pixels

• :halign (Vips::Align) —

  Align on the left, centre or right

• :valign (Vips::Align) —

  Align on the top, centre or bottom

• :hspacing (Integer) —

  Horizontal spacing between images

• :vspacing (Integer) —

  Vertical spacing between images

Returns:

• Output image

# File 'lib/vips/methods.rb', line 344

.bandrank(im, opts = {}) ⇒ Vips::Image

Band-wise rank of a set of images.

Parameters:

• Array of input images

• (defaults to: {})

  Set of options

Options Hash (opts):

• :index (Integer) —

  Select this band element from sorted list

Returns:

• Output image

# File 'lib/vips/methods.rb', line 396

.black(width, height, opts = {}) ⇒ Vips::Image

Make a black image.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :bands (Integer) —

  Number of bands in image

Returns:

• Output image

# File 'lib/vips/methods.rb', line 535

.csvload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load csv from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :skip (Integer) —

  Skip this many lines at the start of the file

• :lines (Integer) —

  Read this many lines from the file

• :fail (Boolean) —

  Fail on first error

• :whitespace (String) —

  Set of whitespace characters

• :separator (String) —

  Set of separator characters

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 823

.eye(width, height, opts = {}) ⇒ Vips::Image

Make an image showing the eye's spatial response.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :factor (Float) —

  Maximum spatial frequency

Returns:

• Output image

# File 'lib/vips/methods.rb', line 591

.fitsload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load a fits image.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1130

.fractsurf(width, height, fractal_dimension, opts = {}) ⇒ Vips::Image

Make a fractal surface.

Parameters:

• Image width in pixels

• Image height in pixels

• Fractal dimension

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 798

.gaussmat(sigma, min_ampl, opts = {}) ⇒ Vips::Image

Make a gaussian image.

Parameters:

• Sigma of Gaussian

• Minimum amplitude of Gaussian

• (defaults to: {})

  Set of options

Options Hash (opts):

• :separable (Boolean) —

  Generate separable Gaussian

• :precision (Vips::Precision) —

  Generate with this precision

Returns:

• Output image

# File 'lib/vips/methods.rb', line 573

.gaussnoise(width, height, opts = {}) ⇒ Vips::Image

Make a gaussnoise image.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :sigma (Float) —

  Standard deviation of pixels in generated image

• :mean (Float) —

  Mean of pixels in generated image

Returns:

• Output image

# File 'lib/vips/methods.rb', line 543

.gifload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load gif with giflib.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :n (Integer) —

  Load this many pages

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :page (Integer) —

  Load this page from the file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 965

.gifload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load gif with giflib.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :n (Integer) —

  Load this many pages

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :page (Integer) —

  Load this page from the file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 977

.grey(width, height, opts = {}) ⇒ Vips::Image

Make a grey ramp image.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

Returns:

• Output image

# File 'lib/vips/methods.rb', line 600

.identity(opts = {}) ⇒ Vips::Image

Make a 1d image where pixel values are indexes.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :bands (Integer) —

  Number of bands in LUT

• :ushort (Boolean) —

  Create a 16-bit LUT

• :size (Integer) —

  Size of 16-bit LUT

Returns:

• Output image

# File 'lib/vips/methods.rb', line 790

.jpegload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load jpeg from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :shrink (Integer) —

  Shrink factor on load

• :fail (Boolean) —

  Fail on first error

• :autorotate (Boolean) —

  Rotate image using exif orientation

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1019

.jpegload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load jpeg from buffer.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :shrink (Integer) —

  Shrink factor on load

• :fail (Boolean) —

  Fail on first error

• :autorotate (Boolean) —

  Rotate image using exif orientation

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1031

.logmat(sigma, min_ampl, opts = {}) ⇒ Vips::Image

Make a laplacian of gaussian image.

Parameters:

• Radius of Logmatian

• Minimum amplitude of Logmatian

• (defaults to: {})

  Set of options

Options Hash (opts):

• :separable (Boolean) —

  Generate separable Logmatian

• :precision (Vips::Precision) —

  Generate with this precision

Returns:

• Output image

# File 'lib/vips/methods.rb', line 582

.magickload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load file with imagemagick.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :density (String) —

  Canvas resolution for rendering vector formats like SVG

• :page (Integer) —

  Load this page from the file

• :n (Integer) —

  Load this many pages

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1104

.magickload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load buffer with imagemagick.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :density (String) —

  Canvas resolution for rendering vector formats like SVG

• :page (Integer) —

  Load this page from the file

• :n (Integer) —

  Load this many pages

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1117

.mask_butterworth(width, height, order, frequency_cutoff, amplitude_cutoff, opts = {}) ⇒ Vips::Image

Make a butterworth filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Filter order

• Frequency cutoff

• Amplitude cutoff

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 665

.mask_butterworth_band(width, height, order, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {}) ⇒ Vips::Image

Make a butterworth_band filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Filter order

• Frequency cutoff x

• Frequency cutoff y

• radius of circle

• Amplitude cutoff

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 694

.mask_butterworth_ring(width, height, order, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {}) ⇒ Vips::Image

Make a butterworth ring filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Filter order

• Frequency cutoff

• Amplitude cutoff

• Ringwidth

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 679

.mask_fractal(width, height, fractal_dimension, opts = {}) ⇒ Vips::Image

Make fractal filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Fractal dimension

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 752

.mask_gaussian(width, height, frequency_cutoff, amplitude_cutoff, opts = {}) ⇒ Vips::Image

Make a gaussian filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Frequency cutoff

• Amplitude cutoff

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 710

.mask_gaussian_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, amplitude_cutoff, opts = {}) ⇒ Vips::Image

Make a gaussian filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Frequency cutoff x

• Frequency cutoff y

• radius of circle

• Amplitude cutoff

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 737

.mask_gaussian_ring(width, height, frequency_cutoff, amplitude_cutoff, ringwidth, opts = {}) ⇒ Vips::Image

Make a gaussian ring filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Frequency cutoff

• Amplitude cutoff

• Ringwidth

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 723

.mask_ideal(width, height, frequency_cutoff, opts = {}) ⇒ Vips::Image

Make an ideal filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Frequency cutoff

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 626

.mask_ideal_band(width, height, frequency_cutoff_x, frequency_cutoff_y, radius, opts = {}) ⇒ Vips::Image

Make an ideal band filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Frequency cutoff x

• Frequency cutoff y

• radius of circle

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 651

.mask_ideal_ring(width, height, frequency_cutoff, ringwidth, opts = {}) ⇒ Vips::Image

Make an ideal ring filter.

Parameters:

• Image width in pixels

• Image height in pixels

• Frequency cutoff

• Ringwidth

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :nodc (Boolean) —

  Remove DC component

• :reject (Boolean) —

  Invert the sense of the filter

• :optical (Boolean) —

  Rotate quadrants to optical space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 638

.matload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load mat from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1009

.matrix_from_array(width, height, array) ⇒ Object

# File 'lib/vips/image.rb', line 290

def self.matrix_from_array width, height, array
    ptr = FFI::MemoryPointer.new :double, array.length
    ptr.write_array_of_double array
    image = Vips::vips_image_new_matrix_from_array width, height, 
        ptr, array.length
    Vips::Image.new image
end

.matrixload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load matrix from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 837

.method_missing(name, *args, **options) ⇒ Object

Invoke a vips operation with Operation.call.

# File 'lib/vips/image.rb', line 199

def self.method_missing name, *args, **options
    Vips::Operation.call name.to_s, args, options
end

.new_from_array(array, scale = 1, offset = 0) ⇒ Image

Create a new Image from a 1D or 2D array. A 1D array becomes an image with height 1. Use scale and offset to set the scale and offset fields in the header. These are useful for integer convolutions.

For example:

image = Vips::new_from_array [1, 2, 3]

or

image = Vips::new_from_array [
    [-1, -1, -1],
    [-1, 16, -1],
    [-1, -1, -1]], 8

for a simple sharpening mask.

Parameters:

• the pixel data as an array of numbers

• (defaults to: 1)

  the convolution scale

• (defaults to: 0)

  the convolution offset

Returns:

• the image

Raises:

# File 'lib/vips/image.rb', line 324

def self.new_from_array array, scale = 1, offset = 0
    # we accept a 1D array and assume height == 1, or a 2D array
    # and check all lines are the same length
    if not array.is_a? Array
        raise Vips::Error, "Argument is not an array."
    end

    if array[0].is_a? Array
        height = array.length
        width = array[0].length
        if not array.all? {|x| x.is_a? Array}
            raise Vips::Error, "Not a 2D array."
        end
        if not array.all? {|x| x.length == width}
            raise Vips::Error, "Array not rectangular."
        end
        array = array.flatten
    else
        height = 1
        width = array.length
    end

    if not array.all? {|x| x.is_a? Numeric}
        raise Vips::Error, "Not all array elements are Numeric."
    end

    image = Vips::Image.matrix_from_array width, height, array
    raise Vips::Error if image == nil

    # be careful to set them as double
    image.set_type GObject::GDOUBLE_TYPE, 'scale', scale.to_f
    image.set_type GObject::GDOUBLE_TYPE, 'offset', offset.to_f

    return image
end

.new_from_buffer(data, option_string, opts = {}) ⇒ Image

Create a new Vips::Image for an image encoded, in a format such as JPEG, in a memory string. Load options may be passed as strings or appended as a hash. For example:

image = Vips::new_from_from_buffer memory_buffer, "shrink=2"

or alternatively:

image = Vips::new_from_from_buffer memory_buffer, "", shrink: 2

The options available depend on the file format. Try something like:

$ vips jpegload_buffer

at the command-line to see the available options. Not all loaders support load from buffer, but at least JPEG, PNG and TIFF images will work.

Loading is fast: only enough of the image is loaded to be able to fill out the header. Pixels will only be decompressed when they are needed.

Parameters:

• the data to load from

• load options as a string

• (defaults to: {})

  set of options

Options Hash (opts):

• :disc (Boolean) — default: true —

  Open large images via a temporary disc file

• :access (Vips::Access) — default: :random —

  Access mode for file

Returns:

• the loaded image

Raises:

# File 'lib/vips/image.rb', line 283

def self.new_from_buffer data, option_string, opts = {}
    loader = Vips::vips_foreign_find_load_buffer data, data.length
    raise Vips::Error if loader == nil

    Vips::Operation.call loader, [data], opts, option_string
end

.new_from_file(name, opts = {}) ⇒ Image

Return a new Vips::Image for a file on disc. This method can load images in any format supported by vips. The filename can include load options, for example:

image = Vips::new_from_file "fred.jpg[shrink=2]"

You can also supply options as a hash, for example:

image = Vips::new_from_file "fred.jpg", shrink: 2

The full set of options available depend upon the load operation that will be executed. Try something like:

$ vips jpegload

at the command-line to see a summary of the available options for the JPEG loader.

Loading is fast: only enough of the image is loaded to be able to fill out the header. Pixels will only be decompressed when they are needed.

Parameters:

• the filename to load from

• (defaults to: {})

  set of options

Options Hash (opts):

• :disc (Boolean) — default: true —

  Open large images via a temporary disc file

• :access (Vips::Access) — default: :random —

  Access mode for file

Returns:

• the loaded image

Raises:

# File 'lib/vips/image.rb', line 239

def self.new_from_file name, opts = {}
    # very common, and Vips::vips_filename_get_filename will segv if we 
    # pass this
    raise Vips::Error, "filename is nil" if name == nil

    filename = Vips::vips_filename_get_filename name
    option_string = Vips::vips_filename_get_options name
    loader = Vips::vips_foreign_find_load filename
    raise Vips::Error if loader == nil

    Operation.call loader, [filename], opts, option_string
end

.openexrload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load an openexr image.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1140

.openslideload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load file with openslide.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :level (Integer) —

  Load this level from the file

• :autocrop (Boolean) —

  Crop to image bounds

• :fail (Boolean) —

  Fail on first error

• :associated (String) —

  Load this associated image

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1091

.pdfload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load pdf with libpoppler.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :page (Integer) —

  Load this page from the file

• :n (Integer) —

  Load this many pages

• :fail (Boolean) —

  Fail on first error

• :dpi (Float) —

  Render at this DPI

• :scale (Float) —

  Scale output by this factor

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 901

.pdfload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load pdf with libpoppler.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :page (Integer) —

  Load this page from the file

• :n (Integer) —

  Load this many pages

• :fail (Boolean) —

  Fail on first error

• :dpi (Float) —

  Render at this DPI

• :scale (Float) —

  Scale output by this factor

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 915

.perlin(width, height, opts = {}) ⇒ Vips::Image

Make a perlin noise image.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :cell_size (Integer) —

  Size of Perlin cells

• :uchar (Boolean) —

  Output an unsigned char image

Returns:

• Output image

# File 'lib/vips/methods.rb', line 814

.pngload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load png from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 989

.pngload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load png from buffer.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 999

.ppmload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load ppm from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 881

.radload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load a radiance image from a file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 891

.rawload(filename, width, height, bands, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load raw data from a file.

Parameters:

• Filename to load from

• Image width in pixels

• Image height in pixels

• Number of bands in image

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :offset (guint64) —

  Offset in bytes from start of file

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 847

.respond_to?(name, include_all = false) ⇒ Boolean

Returns:

# File 'lib/vips/image.rb', line 182

def self.respond_to? name, include_all = false
    # respond to all vips operations by nickname
    return true if Vips::type_find("VipsOperation", name.to_s) != 0

    super
end

.sines(width, height, opts = {}) ⇒ Vips::Image

Make a 2d sine wave.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

• :hfreq (Float) —

  Horizontal spatial frequency

• :vfreq (Float) —

  Vertical spatial frequency

Returns:

• Output image

# File 'lib/vips/methods.rb', line 616

.sum(im, opts = {}) ⇒ Vips::Image

Sum an array of images.

Parameters:

• Array of input images

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 79

.svgload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load svg with rsvg.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :dpi (Float) —

  Render at this DPI

• :fail (Boolean) —

  Fail on first error

• :scale (Float) —

  Scale output by this factor

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 929

.svgload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load svg with rsvg.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :dpi (Float) —

  Render at this DPI

• :fail (Boolean) —

  Fail on first error

• :scale (Float) —

  Scale output by this factor

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 953

.system(cmd_format, opts = {}) ⇒ nil, Hash<Symbol => Object>

Run an external command.

Parameters:

• Command to run

• (defaults to: {})

  Set of options

Options Hash (opts):

• :im (Array<Image>) —

  Array of input images

• :out_format (String) —

  Format for output filename

• :in_format (String) —

  Format for input filename

• :out (Vips::Image) —

  Output Output image

• :log (String) —

  Output Command log

Returns:

• Hash of optional output items

# File 'lib/vips/methods.rb', line 4

.text(text, opts = {}) ⇒ Vips::Image

Make a text image.

Parameters:

• Text to render

• (defaults to: {})

  Set of options

Options Hash (opts):

• :font (String) —

  Font to render with

• :width (Integer) —

  Maximum image width in pixels

• :align (Vips::Align) —

  Align on the low, centre or high edge

• :dpi (Integer) —

  DPI to render at

• :spacing (Integer) —

  Line spacing

Returns:

• Output image

# File 'lib/vips/methods.rb', line 552

.thumbnail(filename, width, opts = {}) ⇒ Vips::Image

Generate thumbnail from file.

Parameters:

• Filename to read from

• Size to this width

• (defaults to: {})

  Set of options

Options Hash (opts):

• :height (Integer) —

  Size to this height

• :size (Vips::Size) —

  Only upsize, only downsize, or both

• :auto_rotate (Boolean) —

  Use orientation tags to rotate image upright

• :crop (Vips::Interesting) —

  Reduce to fill target rectangle, then crop

• :linear (Boolean) —

  Reduce in linear light

• :import_profile (String) —

  Fallback import profile

• :export_profile (String) —

  Fallback export profile

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1412

.thumbnail_buffer(buffer, width, opts = {}) ⇒ Vips::Image

Generate thumbnail from buffer.

Parameters:

• Buffer to load from

• Size to this width

• (defaults to: {})

  Set of options

Options Hash (opts):

• :height (Integer) —

  Size to this height

• :size (Vips::Size) —

  Only upsize, only downsize, or both

• :auto_rotate (Boolean) —

  Use orientation tags to rotate image upright

• :crop (Vips::Interesting) —

  Reduce to fill target rectangle, then crop

• :linear (Boolean) —

  Reduce in linear light

• :import_profile (String) —

  Fallback import profile

• :export_profile (String) —

  Fallback export profile

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1426

.tiffload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load tiff from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :page (Integer) —

  Load this page from the image

• :n (Integer) —

  Load this many pages

• :fail (Boolean) —

  Fail on first error

• :autorotate (Boolean) —

  Rotate image using orientation tag

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1065

.tiffload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load tiff from buffer.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :page (Integer) —

  Load this page from the image

• :n (Integer) —

  Load this many pages

• :fail (Boolean) —

  Fail on first error

• :autorotate (Boolean) —

  Rotate image using orientation tag

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1078

.tonelut(opts = {}) ⇒ Vips::Image

Build a look-up table.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :in_max (Integer) —

  Size of LUT to build

• :out_max (Integer) —

  Maximum value in output LUT

• :Lb (Float) —

  Lowest value in output

• :Lw (Float) —

  Highest value in output

• :Ps (Float) —

  Position of shadow

• :Pm (Float) —

  Position of mid-tones

• :Ph (Float) —

  Position of highlights

• :S (Float) —

  Adjust shadows by this much

• :M (Float) —

  Adjust mid-tones by this much

• :H (Float) —

  Adjust highlights by this much

Returns:

• Output image

# File 'lib/vips/methods.rb', line 775

.vipsload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load vips from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 861

.webpload(filename, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load webp from file.

Parameters:

• Filename to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :shrink (Integer) —

  Shrink factor on load

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1043

.webpload_buffer(buffer, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Load webp from buffer.

Parameters:

• Buffer to load from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :disc (Boolean) —

  Open to disc

• :access (Vips::Access) —

  Required access pattern for this file

• :shrink (Integer) —

  Shrink factor on load

• :fail (Boolean) —

  Fail on first error

• :flags (Vips::ForeignFlags) —

  Output Flags for this file

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 1054

.worley(width, height, opts = {}) ⇒ Vips::Image

Make a worley noise image.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :cell_size (Integer) —

  Size of Worley cells

Returns:

• Output image

# File 'lib/vips/methods.rb', line 806

.xyz(width, height, opts = {}) ⇒ Vips::Image

Make an image where pixel values are coordinates.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :csize (Integer) —

  Size of third dimension

• :dsize (Integer) —

  Size of fourth dimension

• :esize (Integer) —

  Size of fifth dimension

Returns:

• Output image

# File 'lib/vips/methods.rb', line 563

.zone(width, height, opts = {}) ⇒ Vips::Image

Make a zone plate.

Parameters:

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output an unsigned char image

Returns:

• Output image

# File 'lib/vips/methods.rb', line 608

Instance Method Details

#! ⇒ Image

Equivalent to image ^ -1

Returns:

• image with bits flipped

# File 'lib/vips/image.rb', line 799

def !
    self ^ -1
end

#!=(other) ⇒ Image

Compare inequality to nil, an image, constant or array.

Parameters:

• test inequality to this

Returns:

• result of inequality

# File 'lib/vips/image.rb', line 873

def != other
    # for equality, we must allow tests against nil
    if other == nil
        true
    else
        call_enum "relational", other, :noteq
    end
end

#%(other) ⇒ Image

Remainder after integer division with an image, constant or array.

Parameters:

• self modulo this

Returns:

• result of modulo

# File 'lib/vips/image.rb', line 743

def % other
    other.is_a?(Vips::Image) ? 
        remainder(other) : remainder_const(other)
end

#&(other) ⇒ Image

Integer bitwise AND with an image, constant or array.

Parameters:

• bitwise AND with this

Returns:

• result of bitwise AND

# File 'lib/vips/image.rb', line 784

def & other
    call_enum "boolean", other, :and
end

#*(other) ⇒ Image

Multiply an image, constant or array.

Parameters:

• Thing to multiply by self

Returns:

• result of multiplication

# File 'lib/vips/image.rb', line 725

def * other
    other.is_a?(Vips::Image) ? 
        multiply(other) : linear(other, 0)
end

#**(other) ⇒ Image

Raise to power of an image, constant or array.

Parameters:

• self to the power of this

Returns:

• result of power

# File 'lib/vips/image.rb', line 752

def ** other
    call_enum "math2", other, :pow
end

#+(other) ⇒ Image

Add an image, constant or array.

Parameters:

• Thing to add to self

Returns:

• result of addition

# File 'lib/vips/image.rb', line 707

def + other 
    other.is_a?(Vips::Image) ? 
        add(other) : linear(1, other)
end

#+@ ⇒ Image

Returns image.

Returns:

• image

# File 'lib/vips/image.rb', line 811

def +@
    self
end

#-(other) ⇒ Image

Subtract an image, constant or array.

Parameters:

• Thing to subtract from self

Returns:

• result of subtraction

# File 'lib/vips/image.rb', line 716

def - other
    other.is_a?(Vips::Image) ? 
        subtract(other) : linear(1, Image::smap(other) {|x| x * -1})
end

#-@ ⇒ Image

Equivalent to image * -1

Returns:

• negative of image

# File 'lib/vips/image.rb', line 818

def -@
    self * -1
end

#/(other) ⇒ Image

Divide an image, constant or array.

Parameters:

• Thing to divide self by

Returns:

• result of division

# File 'lib/vips/image.rb', line 734

def / other
    other.is_a?(Vips::Image) ? 
        divide(other) : linear(Image::smap(other) {|x| 1.0 / x}, 0)
end

#<(other) ⇒ Image

Relational less than with an image, constant or array.

Parameters:

• relational less than with this

Returns:

• result of less than

# File 'lib/vips/image.rb', line 826

def < other
    call_enum "relational", other, :less
end

#<<(other) ⇒ Image

Integer left shift with an image, constant or array.

Parameters:

• shift left by this much

Returns:

• result of left shift

# File 'lib/vips/image.rb', line 760

def << other
    call_enum "boolean", other, :lshift
end

#<=(other) ⇒ Image

Relational less than or equal to with an image, constant or array.

Parameters:

• relational less than or equal to with this

Returns:

• result of less than or equal to

# File 'lib/vips/image.rb', line 835

def <= other
    call_enum "relational", other, :lesseq
end

#==(other) ⇒ Image

Compare equality to nil, an image, constant or array.

Parameters:

• test equality to this

Returns:

• result of equality

# File 'lib/vips/image.rb', line 860

def == other
    # for equality, we must allow tests against nil
    if other == nil
        false
    else
        call_enum "relational", other, :equal
    end
end

#>(other) ⇒ Image

Relational more than with an image, constant or array.

Parameters:

• relational more than with this

Returns:

• result of more than

# File 'lib/vips/image.rb', line 843

def > other
    call_enum "relational", other, :more
end

#>=(other) ⇒ Image

Relational more than or equal to with an image, constant or array.

Parameters:

• relational more than or equal to with this

Returns:

• result of more than or equal to

# File 'lib/vips/image.rb', line 852

def >= other
    call_enum "relational", other, :moreeq
end

#>>(other) ⇒ Image

Integer right shift with an image, constant or array.

Parameters:

• shift right by this much

Returns:

• result of right shift

# File 'lib/vips/image.rb', line 768

def >> other
    call_enum "boolean", other, :rshift
end

#[](index) ⇒ Image

Fetch bands using a number or a range

Parameters:

• extract these band(s)

Returns:

• extracted band(s)

# File 'lib/vips/image.rb', line 886

def [] index
    if index.is_a? Range
        n = index.end - index.begin
        n += 1 if not index.exclude_end?
        extract_band index.begin, n: n
    elsif index.is_a? Numeric
        extract_band index 
    else
        raise Vips::Error, "[] index is not range or numeric."
    end
end

#^(other) ⇒ Image

Integer bitwise EOR with an image, constant or array.

Parameters:

• bitwise EOR with this

Returns:

• result of bitwise EOR

# File 'lib/vips/image.rb', line 792

def ^ other
    call_enum "boolean", other, :eor
end

#abs(opts = {}) ⇒ Vips::Image

Absolute value of an image.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 104

#acos ⇒ Image

Return the inverse cosine of an image in degrees.

Returns:

• inverse cosine of each pixel

# File 'lib/vips/image.rb', line 1137

def acos
    math :acos
end

#add(right, opts = {}) ⇒ Vips::Image

Add two images.

Parameters:

• Right-hand image argument

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 15

#affine(matrix, opts = {}) ⇒ Vips::Image

Affine transform of an image.

Parameters:

• Transformation matrix

• (defaults to: {})

  Set of options

Options Hash (opts):

• :interpolate (Vips::Interpolate) —

  Interpolate pixels with this

• :oarea (Array<Integer>) —

  Area of output to generate

• :odx (Float) —

  Horizontal output displacement

• :ody (Float) —

  Vertical output displacement

• :idx (Float) —

  Horizontal input displacement

• :idy (Float) —

  Vertical input displacement

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1498

#asin ⇒ Image

Return the inverse sine of an image in degrees.

Returns:

• inverse sine of each pixel

# File 'lib/vips/image.rb', line 1130

def asin
    math :asin
end

#atan ⇒ Image

Return the inverse tangent of an image in degrees.

Returns:

• inverse tangent of each pixel

# File 'lib/vips/image.rb', line 1144

def atan
    math :atan
end

#autorot(opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Autorotate image by exif tag.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :angle (Vips::Angle) —

  Output Angle image was rotated by

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 440

#avg(opts = {}) ⇒ Float

Find image average.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output value

# File 'lib/vips/methods.rb', line 159

#bandand ⇒ Image

AND the bands of an image together

Returns:

• all bands ANDed together

# File 'lib/vips/image.rb', line 958

def bandand
    bandbool :and
end

#bandbool(boolean, opts = {}) ⇒ Vips::Image

Boolean operation across image bands.

Parameters:

• boolean to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 408

#bandeor ⇒ Image

EOR the bands of an image together

Returns:

• all bands EORed together

# File 'lib/vips/image.rb', line 972

def bandeor
    bandbool :eor
end

#bandfold(opts = {}) ⇒ Vips::Image

Fold up x axis into bands.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :factor (Integer) —

  Fold by this factor

Returns:

• Output image

# File 'lib/vips/methods.rb', line 452

#bandjoin(other) ⇒ Image

Join a set of images bandwise.

Parameters:

• bands to append

Returns:

• many band image

# File 'lib/vips/image.rb', line 987

def bandjoin other
    if not other.is_a? Array
        other = [other]
    end

    # if other is just Numeric, we can use bandjoin_const
    not_all_real = (other.map {|x| not x.is_a?(Numeric)}).include?(true)

    if not_all_real
        Vips::Image.bandjoin([self] + other)
    else
        bandjoin_const(other)
    end
end

#bandjoin_const(c, opts = {}) ⇒ Vips::Image

Append a constant band to an image.

Parameters:

• Array of constants to add

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 390

#bandmean(opts = {}) ⇒ Vips::Image

Band-wise average.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 403

#bandor ⇒ Image

OR the bands of an image together

Returns:

• all bands ORed together

# File 'lib/vips/image.rb', line 965

def bandor
    bandbool :or
end

#bands ⇒ Integer

Get number of image bands.

Returns:

• number of image bands

# File 'lib/vips/image.rb', line 613

def bands
    get "bands"
end

#bandsplit ⇒ Array<Image>

Split an n-band image into n separate images.

Returns:

• Array of n one-band images

# File 'lib/vips/image.rb', line 979

def bandsplit
    (0...bands).map {|i| extract_band(i)}
end

#bandunfold(opts = {}) ⇒ Vips::Image

Unfold image bands into x axis.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :factor (Integer) —

  Unfold by this factor

Returns:

• Output image

# File 'lib/vips/methods.rb', line 458

#boolean(right, boolean, opts = {}) ⇒ Vips::Image

Boolean operation on two images.

Parameters:

• Right-hand image argument

• boolean to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 52

#boolean_const(boolean, c, opts = {}) ⇒ Vips::Image

Boolean operations against a constant.

Parameters:

• boolean to perform

• Array of constants

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 133

#buildlut(opts = {}) ⇒ Vips::Image

Build a look-up table.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 764

#byteswap(opts = {}) ⇒ Vips::Image

Byteswap an image.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 519

#cache(opts = {}) ⇒ Vips::Image

Cache an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :max_tiles (Integer) —

  Maximum number of tiles to cache

• :tile_height (Integer) —

  Tile height in pixels

• :tile_width (Integer) —

  Tile width in pixels

Returns:

• Output image

# File 'lib/vips/methods.rb', line 298

#cast(format, opts = {}) ⇒ Vips::Image

Cast an image.

Parameters:

• Format to cast to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :shift (Boolean) —

  Shift integer values up and down

Returns:

• Output image

# File 'lib/vips/methods.rb', line 421

#ceil ⇒ Image

Return the smallest integral value not less than the argument.

Returns:

• ceil of image

# File 'lib/vips/image.rb', line 944

def ceil
    round :ceil
end

#CMC2LCh(opts = {}) ⇒ Vips::Image

Transform lch to cmc.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1565

#coding ⇒ Symbol

Get image coding.

Returns:

• image coding

# File 'lib/vips/image.rb', line 634

def coding
    get "coding"
end

#colourspace(space, opts = {}) ⇒ Vips::Image

Convert to a new colorspace.

Parameters:

• Destination color space

• (defaults to: {})

  Set of options

Options Hash (opts):

• :source_space (Vips::Interpretation) —

  Source color space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1531

#compass(mask, opts = {}) ⇒ Vips::Image

Convolve with rotating mask.

Parameters:

• Input matrix image

• (defaults to: {})

  Set of options

Options Hash (opts):

• :times (Integer) —

  Rotate and convolve this many times

• :angle (Vips::Angle45) —

  Rotate mask by this much between convolutions

• :combine (Vips::Combine) —

  Combine convolution results like this

• :precision (Vips::Precision) —

  Convolve with this precision

• :layers (Integer) —

  Use this many layers in approximation

• :cluster (Integer) —

  Cluster lines closer than this in approximation

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1807

#complex(cmplx, opts = {}) ⇒ Vips::Image

Perform a complex operation on an image.

Parameters:

• complex to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 147

#complex2(right, cmplx, opts = {}) ⇒ Vips::Image

Complex binary operations on two images.

Parameters:

• Right-hand image argument

• binary complex operation to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 66

#complexform(right, opts = {}) ⇒ Vips::Image

Form a complex image from two real images.

Parameters:

• Right-hand image argument

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 73

#complexget(get, opts = {}) ⇒ Vips::Image

Get a component from a complex image.

Parameters:

• complex to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 153

#conj ⇒ Image

Return the complex conjugate of an image.

The image can be complex, in which case the return image will also be complex, or must have an even number of bands, in which case pairs of bands are treated as (x, y) coordinates.

Returns:

• complex conjugate

# File 'lib/vips/image.rb', line 1094

def conj
    Image::run_cmplx(self) {|x| x.complex :conj}
end

#conv(mask, opts = {}) ⇒ Vips::Image

Convolution operation.

Parameters:

• Input matrix image

• (defaults to: {})

  Set of options

Options Hash (opts):

• :precision (Vips::Precision) —

  Convolve with this precision

• :layers (Integer) —

  Use this many layers in approximation

• :cluster (Integer) —

  Cluster lines closer than this in approximation

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1778

#conva(mask, opts = {}) ⇒ Vips::Image

Approximate integer convolution.

Parameters:

• Input matrix image

• (defaults to: {})

  Set of options

Options Hash (opts):

• :layers (Integer) —

  Use this many layers in approximation

• :cluster (Integer) —

  Cluster lines closer than this in approximation

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1787

#convasep(mask, opts = {}) ⇒ Vips::Image

Approximate separable integer convolution.

Parameters:

• Input matrix image

• (defaults to: {})

  Set of options

Options Hash (opts):

• :layers (Integer) —

  Use this many layers in approximation

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1828

#convf(mask, opts = {}) ⇒ Vips::Image

Float convolution operation.

Parameters:

• Input matrix image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1795

#convi(mask, opts = {}) ⇒ Vips::Image

Int convolution operation.

Parameters:

• Input matrix image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1801

#convsep(mask, opts = {}) ⇒ Vips::Image

Seperable convolution operation.

Parameters:

• Input matrix image

• (defaults to: {})

  Set of options

Options Hash (opts):

• :precision (Vips::Precision) —

  Convolve with this precision

• :layers (Integer) —

  Use this many layers in approximation

• :cluster (Integer) —

  Cluster lines closer than this in approximation

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1819

#copy(opts = {}) ⇒ Vips::Image

Copy an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :width (Integer) —

  Image width in pixels

• :height (Integer) —

  Image height in pixels

• :bands (Integer) —

  Number of bands in image

• :format (Vips::BandFormat) —

  Pixel format in image

• :coding (Vips::Coding) —

  Pixel coding

• :interpretation (Vips::Interpretation) —

  Pixel interpretation

• :xres (Float) —

  Horizontal resolution in pixels/mm

• :yres (Float) —

  Vertical resolution in pixels/mm

• :xoffset (Integer) —

  Horizontal offset of origin

• :yoffset (Integer) —

  Vertical offset of origin

Returns:

• Output image

# File 'lib/vips/methods.rb', line 257

#copy_memory ⇒ Object

# File 'lib/vips/image.rb', line 698

def copy_memory
    new_image = Vips::vips_image_copy_memory self
    Vips::Image.new new_image
end

#cos ⇒ Image

Return the cosine of an image in degrees.

Returns:

• cosine of each pixel

# File 'lib/vips/image.rb', line 1116

def cos
    math :cos
end

#countlines(direction, opts = {}) ⇒ Float

Count lines in an image.

Parameters:

• Countlines left-right or up-down

• (defaults to: {})

  Set of options

Returns:

• Number of lines

# File 'lib/vips/methods.rb', line 1909

#cross_phase(other) ⇒ Image

Calculate the cross phase of two images.

Parameters:

• cross phase with this

Returns:

• cross phase

# File 'lib/vips/image.rb', line 1102

def cross_phase other
    complex2 other, :cross_phase
end

#csvsave(filename, opts = {}) ⇒ nil

Save image to csv file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :separator (String) —

  Separator characters

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1150

#dE00(right, opts = {}) ⇒ Vips::Image

Calculate de00.

Parameters:

• Right-hand input image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1680

#dE76(right, opts = {}) ⇒ Vips::Image

Calculate de76.

Parameters:

• Right-hand input image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1674

#dECMC(right, opts = {}) ⇒ Vips::Image

Calculate decmc.

Parameters:

• Right-hand input image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1686

#deviate(opts = {}) ⇒ Float

Find image standard deviation.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output value

# File 'lib/vips/methods.rb', line 186

#dilate(mask) ⇒ Image

Dilate with a structuring element.

The structuring element must be an array with 0 for black, 255 for white and 128 for don't care.

Parameters:

• structuring element

Returns:

• dilated image

# File 'lib/vips/image.rb', line 1210

def dilate mask
    morph mask, :dilate
end

#divide(right, opts = {}) ⇒ Vips::Image

Divide two images.

Parameters:

• Right-hand image argument

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 33

#draw_circle(ink, cx, cy, radius, opts = {}) ⇒ Vips::Image

Draw a circle on an image.

Parameters:

• Color for pixels

• Centre of draw_circle

• Centre of draw_circle

• Radius in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :fill (Boolean) —

  Draw a solid object

Returns:

• Image to draw on

# File 'lib/vips/methods.rb', line 1951

#draw_flood(ink, x, y, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Flood-fill an area.

Parameters:

• Color for pixels

• DrawFlood start point

• DrawFlood start point

• (defaults to: {})

  Set of options

Options Hash (opts):

• :test (Vips::Image) —

  Test pixels in this image

• :equal (Boolean) —

  DrawFlood while equal to edge

• :left (Integer) —

  Output Left edge of modified area

• :top (Integer) —

  Output top edge of modified area

• :width (Integer) —

  Output width of modified area

• :height (Integer) —

  Output height of modified area

Returns:

• Image to draw on, Hash of optional output items

# File 'lib/vips/methods.rb', line 1961

#draw_image(sub, x, y, opts = {}) ⇒ Vips::Image

Paint an image into another image.

Parameters:

• Sub-image to insert into main image

• Draw image here

• Draw image here

• (defaults to: {})

  Set of options

Options Hash (opts):

• :mode (Vips::CombineMode) —

  Combining mode

Returns:

• Image to draw on

# File 'lib/vips/methods.rb', line 1975

#draw_line(ink, x1, y1, x2, y2, opts = {}) ⇒ Vips::Image

Draw a line on an image.

Parameters:

• Color for pixels

• Start of draw_line

• Start of draw_line

• End of draw_line

• End of draw_line

• (defaults to: {})

  Set of options

Returns:

• Image to draw on

# File 'lib/vips/methods.rb', line 1941

#draw_mask(ink, mask, x, y, opts = {}) ⇒ Vips::Image

Draw a mask on an image.

Parameters:

• Color for pixels

• Mask of pixels to draw

• Draw mask here

• Draw mask here

• (defaults to: {})

  Set of options

Returns:

• Image to draw on

# File 'lib/vips/methods.rb', line 1932

#draw_rect(ink, left, top, width, height, opts = {}) ⇒ Vips::Image

Paint a rectangle on an image.

Parameters:

• Color for pixels

• Rect to fill

• Rect to fill

• Rect to fill

• Rect to fill

• (defaults to: {})

  Set of options

Options Hash (opts):

• :fill (Boolean) —

  Draw a solid object

Returns:

• Image to draw on

# File 'lib/vips/methods.rb', line 1921

#draw_smudge(left, top, width, height, opts = {}) ⇒ Vips::Image

Blur a rectangle on an image.

Parameters:

• Rect to fill

• Rect to fill

• Rect to fill

• Rect to fill

• (defaults to: {})

  Set of options

Returns:

• Image to draw on

# File 'lib/vips/methods.rb', line 1984

#dzsave(filename, opts = {}) ⇒ nil

Save image to deepzoom file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :basename (String) —

  Base name to save to

• :layout (Vips::ForeignDzLayout) —

  Directory layout

• :suffix (String) —

  Filename suffix for tiles

• :overlap (Integer) —

  Tile overlap in pixels

• :tile_size (Integer) —

  Tile size in pixels

• :centre (Boolean) —

  Center image in tile

• :depth (Vips::ForeignDzDepth) —

  Pyramid depth

• :angle (Vips::Angle) —

  Rotate image during save

• :container (Vips::ForeignDzContainer) —

  Pyramid container type

• :properties (Boolean) —

  Write a properties file to the output directory

• :compression (Integer) —

  ZIP deflate compression level

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1223

#dzsave_buffer(opts = {}) ⇒ VipsBlob

Save image to dz buffer.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :basename (String) —

  Base name to save to

• :layout (Vips::ForeignDzLayout) —

  Directory layout

• :suffix (String) —

  Filename suffix for tiles

• :overlap (Integer) —

  Tile overlap in pixels

• :tile_size (Integer) —

  Tile size in pixels

• :centre (Boolean) —

  Center image in tile

• :depth (Vips::ForeignDzDepth) —

  Pyramid depth

• :angle (Vips::Angle) —

  Rotate image during save

• :container (Vips::ForeignDzContainer) —

  Pyramid container type

• :properties (Boolean) —

  Write a properties file to the output directory

• :compression (Integer) —

  ZIP deflate compression level

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

• Buffer to save to

# File 'lib/vips/methods.rb', line 1242

#embed(x, y, width, height, opts = {}) ⇒ Vips::Image

Embed an image in a larger image.

Parameters:

• Left edge of input in output

• Top edge of input in output

• Image width in pixels

• Image height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :extend (Vips::Extend) —

  How to generate the extra pixels

• :background (Array<Double>) —

  Color for background pixels

Returns:

• Output image

# File 'lib/vips/methods.rb', line 306

#erode(mask) ⇒ Image

Erode with a structuring element.

The structuring element must be an array with 0 for black, 255 for white and 128 for don't care.

Parameters:

• structuring element

Returns:

• eroded image

# File 'lib/vips/image.rb', line 1198

def erode mask
    morph mask, :erode
end

#exp ⇒ Image

Return e ** pixel.

Returns:

• e ** pixel

# File 'lib/vips/image.rb', line 1165

def exp
    math :exp
end

#exp10 ⇒ Image

Return 10 ** pixel.

Returns:

• 10 ** pixel

# File 'lib/vips/image.rb', line 1172

def exp10
    math :exp10
end

#extract_area(left, top, width, height, opts = {}) ⇒ Vips::Image

Extract an area from an image.

Parameters:

• Left edge of extract area

• Top edge of extract area

• Width of extract area

• Height of extract area

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 357

#extract_band(band, opts = {}) ⇒ Vips::Image

Extract band from an image.

Parameters:

• Band to extract

• (defaults to: {})

  Set of options

Options Hash (opts):

• :n (Integer) —

  Number of bands to extract

Returns:

• Output image

# File 'lib/vips/methods.rb', line 383

#falsecolour(opts = {}) ⇒ Vips::Image

False-color an image.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 524

#fastcor(ref, opts = {}) ⇒ Vips::Image

Fast correlation.

Parameters:

• Input reference image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1835

#filename ⇒ String

Get image filename, if any.

Returns:

• image filename

# File 'lib/vips/image.rb', line 641

def filename
    get "filename"
end

#fitssave(filename, opts = {}) ⇒ nil

Save image to fits file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1404

#flatten(opts = {}) ⇒ Vips::Image

Flatten alpha out of an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :background (Array<Double>) —

  Background value

• :max_alpha (Float) —

  Maximum value of alpha channel

Returns:

• Output image

# File 'lib/vips/methods.rb', line 464

#flip(direction, opts = {}) ⇒ Vips::Image

Flip an image.

Parameters:

• Direction to flip image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 317

#fliphor ⇒ Image

Flip horizontally.

Returns:

• image flipped horizontally

# File 'lib/vips/image.rb', line 1179

def fliphor
    flip :horizontal
end

#flipver ⇒ Image

Flip vertically.

Returns:

• image flipped vertically

# File 'lib/vips/image.rb', line 1186

def flipver
    flip :vertical
end

#float2rad(opts = {}) ⇒ Vips::Image

Transform float rgb to radiance coding.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1625

#floor ⇒ Image

Return the largest integral value not greater than the argument.

Returns:

• floor of image

# File 'lib/vips/image.rb', line 937

def floor
    round :floor
end

#format ⇒ Symbol

Get image format.

Returns:

• image format

# File 'lib/vips/image.rb', line 620

def format
    get "format"
end

#freqmult(mask, opts = {}) ⇒ Vips::Image

Frequency-domain filtering.

Parameters:

• Input mask image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1877

#fwfft(opts = {}) ⇒ Vips::Image

Forward fft.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1866

#gamma(opts = {}) ⇒ Vips::Image

Gamma an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :exponent (Float) —

  Gamma factor

Returns:

• Output image

# File 'lib/vips/methods.rb', line 529

#gaussblur(sigma, opts = {}) ⇒ Vips::Image

Gaussian blur.

Parameters:

• Sigma of Gaussian

• (defaults to: {})

  Set of options

Options Hash (opts):

• :min_ampl (Float) —

  Minimum amplitude of Gaussian

• :precision (Vips::Precision) —

  Convolve with this precision

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1858

#get(name) ⇒ Object

Get a metadata item from an image. Ruby types are constructed automatically from the GValue, if possible.

For example, you can read the ICC profile from an image like this:

profile = image.get "icc-profile-data"

and profile will be an array containing the profile.

Parameters:

• Metadata field to get

Returns:

• Value of field

Raises:

# File 'lib/vips/image.rb', line 501

def get name
    # with old libvips, we must fetch properties (as opposed to
    # metadata) via VipsObject
    if not Vips::at_least_libvips?(8, 5)
        return super if parent_get_typeof(name) != 0
    end

    gvalue = GObject::GValue.alloc
    result = Vips::vips_image_get self, name, gvalue
    raise Vips::Error if result != 0 

    return gvalue.get
end

#get_fields ⇒ [String]

Get the names of all fields on an image. Use this to loop over all image metadata.

Returns:

• array of field names

# File 'lib/vips/image.rb', line 519

def get_fields
    # vips_image_get_fields() was added in libvips 8.5
    return [] if not Vips.respond_to? :vips_image_get_fields

    array = Vips::vips_image_get_fields self

    names = []
    p = array
    until ((q = p.read_pointer).null?)
        names << q.read_string
        GLib::g_free q
        p += FFI::Type::POINTER.size
    end
    GLib::g_free array

    return names
end

#get_typeof(name) ⇒ Integer

Fetch a GType from an image. GType will be 0 for no such field.

Parameters:

• Metadata field to fetch

Returns:

• GType

See Also:

• #get

# File 'lib/vips/image.rb', line 477

def get_typeof name
    # on libvips before 8.5, property types must be searched first,
    # since vips_image_get_typeof returned built-in enums as int
    if not Vips::at_least_libvips?(8, 5)
        gtype = parent_get_typeof name
        return gtype if gtype != 0
    end

    Vips::vips_image_get_typeof self, name
end

#get_value(name) ⇒ Object

compatibility: old name for get

# File 'lib/vips/image.rb', line 587

def get_value name
    get name
end

#getpoint(x, y, opts = {}) ⇒ Array<Double>

Read a point from an image.

Parameters:

• Point to read

• Point to read

• (defaults to: {})

  Set of options

Returns:

• Array of output values

# File 'lib/vips/image.rb', line 1029

def getpoint x, y
    # vips has an operation that does this, but we can't call it via
    # gobject-introspection 3.1 since it's missing array double
    # get
    #
    # remove this def when gobject-introspection updates
    crop(x, y, 1, 1).bandsplit.map(&:avg)
end

#globalbalance(opts = {}) ⇒ Vips::Image

Global balance an image mosaic.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :gamma (Float) —

  Image gamma

• :int_output (Boolean) —

  Integer output

Returns:

• Output image

# File 'lib/vips/methods.rb', line 2063

#grid(tile_height, across, down, opts = {}) ⇒ Vips::Image

Grid an image.

Parameters:

• chop into tiles this high

• number of tiles across

• number of tiles down

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 483

#height ⇒ Integer

Get image height, in pixels.

Returns:

• image height, in pixels

# File 'lib/vips/image.rb', line 606

def height
    get "height"
end

#hist_cum(opts = {}) ⇒ Vips::Image

Form cumulative histogram.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1733

#hist_entropy(opts = {}) ⇒ Float

Estimate image entropy.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output value

# File 'lib/vips/methods.rb', line 1773

#hist_equal(opts = {}) ⇒ Vips::Image

Histogram equalisation.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :band (Integer) —

  Equalise with this band

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1749

#hist_find(opts = {}) ⇒ Vips::Image

Find image histogram.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :band (Integer) —

  Find histogram of band

Returns:

• Output histogram

# File 'lib/vips/methods.rb', line 196

#hist_find_indexed(index, opts = {}) ⇒ Vips::Image

Find indexed image histogram.

Parameters:

• Index image

• (defaults to: {})

  Set of options

Returns:

• Output histogram

# File 'lib/vips/methods.rb', line 208

#hist_find_ndim(opts = {}) ⇒ Vips::Image

Find n-dimensional image histogram.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :bins (Integer) —

  Number of bins in each dimension

Returns:

• Output histogram

# File 'lib/vips/methods.rb', line 202

#hist_ismonotonic(opts = {}) ⇒ Boolean

Test for monotonicity.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• true if in is monotonic

# File 'lib/vips/methods.rb', line 1768

#hist_local(width, height, opts = {}) ⇒ Vips::Image

Local histogram equalisation.

Parameters:

• Window width in pixels

• Window height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :max_slope (Integer) —

  Maximum slope (CLAHE)

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1760

#hist_match(ref, opts = {}) ⇒ Vips::Image

Match two histograms.

Parameters:

• Reference histogram

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1738

#hist_norm(opts = {}) ⇒ Vips::Image

Normalise histogram.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1744

#hist_plot(opts = {}) ⇒ Vips::Image

Plot histogram.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1755

#hough_circle(opts = {}) ⇒ Vips::Image

Find hough circle transform.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :scale (Integer) —

  Scale down dimensions by this factor

• :min_radius (Integer) —

  Smallest radius to search for

• :max_radius (Integer) —

  Largest radius to search for

Returns:

• Output image

# File 'lib/vips/methods.rb', line 221

#hough_line(opts = {}) ⇒ Vips::Image

Find hough line transform.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :width (Integer) —

  horizontal size of parameter space

• :height (Integer) —

  Vertical size of parameter space

Returns:

• Output image

# File 'lib/vips/methods.rb', line 214

#HSV2sRGB(opts = {}) ⇒ Vips::Image

Transform hsv to srgb.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1640

#icc_export(opts = {}) ⇒ Vips::Image

Output to device with icc profile.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :pcs (Vips::PCS) —

  Set Profile Connection Space

• :intent (Vips::Intent) —

  Rendering intent

• :output_profile (String) —

  Filename to load output profile from

• :depth (Integer) —

  Output device space depth in bits

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1654

#icc_import(opts = {}) ⇒ Vips::Image

Import from device with icc profile.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :pcs (Vips::PCS) —

  Set Profile Connection Space

• :intent (Vips::Intent) —

  Rendering intent

• :embedded (Boolean) —

  Use embedded input profile, if available

• :input_profile (String) —

  Filename to load input profile from

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1645

#icc_transform(output_profile, opts = {}) ⇒ Vips::Image

Transform between devices with icc profiles.

Parameters:

• Filename to load output profile from

• (defaults to: {})

  Set of options

Options Hash (opts):

• :pcs (Vips::PCS) —

  Set Profile Connection Space

• :intent (Vips::Intent) —

  Rendering intent

• :embedded (Boolean) —

  Use embedded input profile, if available

• :input_profile (String) —

  Filename to load input profile from

• :depth (Integer) —

  Output device space depth in bits

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1663

#ifthenelse(th, el, opts = {}) ⇒ Image

Select pixels from th if self is non-zero and from el if self is zero. Use the :blend option to fade smoothly between th and el.

Parameters:

• true values

• false values

• (defaults to: {})

  set of options

Options Hash (opts):

• :blend (Boolean) — default: false —

  Blend smoothly between th and el

Returns:

• merged image

# File 'lib/vips/image.rb', line 1244

def ifthenelse(th, el, opts = {}) 
    match_image = [th, el, self].find {|x| x.is_a? Vips::Image}

    if not th.is_a? Vips::Image
        th = Operation.imageize match_image, th
    end
    if not el.is_a? Vips::Image
        el = Operation.imageize match_image, el
    end

    Vips::Operation.call "ifthenelse", [self, th, el], opts
end

#imag ⇒ Image

Return the imaginary part of a complex image.

Returns:

• imaginary part of complex image

# File 'lib/vips/image.rb', line 1056

def imag
    complexget :imag
end

#insert(sub, x, y, opts = {}) ⇒ Vips::Image

Insert image @sub into @main at @x, @y.

Parameters:

• Sub-image to insert into main image

• Left edge of sub in main

• Top edge of sub in main

• (defaults to: {})

  Set of options

Options Hash (opts):

• :expand (Boolean) —

  Expand output to hold all of both inputs

• :background (Array<Double>) —

  Color for new pixels

Returns:

• Output image

# File 'lib/vips/methods.rb', line 323

#inspect ⇒ Object

# File 'lib/vips/image.rb', line 164

def inspect
    "#<Image #{width}x#{height} #{format}, #{bands} bands, " +
        "#{interpretation}>"
end

#interpretation ⇒ Symbol

Get image interpretation.

Returns:

• image interpretation

# File 'lib/vips/image.rb', line 627

def interpretation
    get "interpretation"
end

#invert(opts = {}) ⇒ Vips::Image

Invert an image.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 85

#invertlut(opts = {}) ⇒ Vips::Image

Build an inverted look-up table.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :size (Integer) —

  LUT size to generate

Returns:

• Output image

# File 'lib/vips/methods.rb', line 769

#invfft(opts = {}) ⇒ Vips::Image

Inverse fft.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :real (Boolean) —

  Output only the real part of the transform

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1871

#join(in2, direction, opts = {}) ⇒ Vips::Image

Join a pair of images.

Parameters:

• Second input image

• Join left-right or up-down

• (defaults to: {})

  Set of options

Options Hash (opts):

• :expand (Boolean) —

  Expand output to hold all of both inputs

• :shim (Integer) —

  Pixels between images

• :background (Array<Double>) —

  Colour for new pixels

• :align (Vips::Align) —

  Align on the low, centre or high coordinate edge

Returns:

• Output image

# File 'lib/vips/methods.rb', line 333

#jpegsave(filename, opts = {}) ⇒ nil

Save image to jpeg file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :Q (Integer) —

  Q factor

• :profile (String) —

  ICC profile to embed

• :optimize_coding (Boolean) —

  Compute optimal Huffman coding tables

• :interlace (Boolean) —

  Generate an interlaced (progressive) jpeg

• :no_subsample (Boolean) —

  Disable chroma subsample

• :trellis_quant (Boolean) —

  Apply trellis quantisation to each 8x8 block

• :overshoot_deringing (Boolean) —

  Apply overshooting to samples with extreme values

• :optimize_scans (Boolean) —

  Split the spectrum of DCT coefficients into separate scans

• :quant_table (Integer) —

  Use predefined quantization table with given index

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1283

#jpegsave_buffer(opts = {}) ⇒ VipsBlob

Save image to jpeg buffer.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :Q (Integer) —

  Q factor

• :profile (String) —

  ICC profile to embed

• :optimize_coding (Boolean) —

  Compute optimal Huffman coding tables

• :interlace (Boolean) —

  Generate an interlaced (progressive) jpeg

• :no_subsample (Boolean) —

  Disable chroma subsample

• :trellis_quant (Boolean) —

  Apply trellis quantisation to each 8x8 block

• :overshoot_deringing (Boolean) —

  Apply overshooting to samples with extreme values

• :optimize_scans (Boolean) —

  Split the spectrum of DCT coefficients into separate scans

• :quant_table (Integer) —

  Use predefined quantization table with given index

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

• Buffer to save to

# File 'lib/vips/methods.rb', line 1300

#jpegsave_mime(opts = {}) ⇒ nil

Save image to jpeg mime.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :Q (Integer) —

  Q factor

• :profile (String) —

  ICC profile to embed

• :optimize_coding (Boolean) —

  Compute optimal Huffman coding tables

• :interlace (Boolean) —

  Generate an interlaced (progressive) jpeg

• :no_subsample (Boolean) —

  Disable chroma subsample

• :trellis_quant (Boolean) —

  Apply trellis quantisation to each 8x8 block

• :overshoot_deringing (Boolean) —

  Apply overshooting to samples with extreme values

• :optimize_scans (Boolean) —

  Split the spectrum of DCT coefficients into separate scans

• :quant_table (Integer) —

  Use predefined quantization table with given index

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1316

#Lab2LabQ(opts = {}) ⇒ Vips::Image

Transform float lab to labq coding.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1595

#Lab2LabS(opts = {}) ⇒ Vips::Image

Transform float lab to signed short.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1615

#Lab2LCh(opts = {}) ⇒ Vips::Image

Transform lab to lch.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1550

#Lab2XYZ(opts = {}) ⇒ Vips::Image

Transform cielab to xyz.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :temp (Array<Double>) —

  Color temperature

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1538

#labelregions(opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Label regions in an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :segments (Integer) —

  Output Number of discrete contigious regions

Returns:

• Mask of region labels, Hash of optional output items

# File 'lib/vips/methods.rb', line 1915

#LabQ2Lab(opts = {}) ⇒ Vips::Image

Unpack a labq image to float lab.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1590

#LabQ2LabS(opts = {}) ⇒ Vips::Image

Unpack a labq image to short lab.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1600

#LabQ2sRGB(opts = {}) ⇒ Vips::Image

Convert a labq image to srgb.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1630

#LabS2Lab(opts = {}) ⇒ Vips::Image

Transform signed short lab to float.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1610

#LabS2LabQ(opts = {}) ⇒ Vips::Image

Transform short lab to labq coding.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1605

#LCh2CMC(opts = {}) ⇒ Vips::Image

Transform lch to cmc.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1560

#LCh2Lab(opts = {}) ⇒ Vips::Image

Transform lch to lab.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1555

#linear(a, b, opts = {}) ⇒ Vips::Image

Calculate (a * in + b).

Parameters:

• Multiply by this

• Add this

• (defaults to: {})

  Set of options

Options Hash (opts):

• :uchar (Boolean) —

  Output should be uchar

Returns:

• Output image

# File 'lib/vips/methods.rb', line 90

#linecache(opts = {}) ⇒ Vips::Image

Cache an image as a set of lines.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :tile_height (Integer) —

  Tile height in pixels

• :access (Vips::Access) —

  Expected access pattern

• :threaded (Boolean) —

  Allow threaded access

• :persistent (Boolean) —

  Keep cache between evaluations

Returns:

• Output image

# File 'lib/vips/methods.rb', line 283

#log ⇒ Image

Return the natural log of an image.

Returns:

• natural log of each pixel

# File 'lib/vips/image.rb', line 1151

def log
    math :log
end

#log10 ⇒ Image

Return the log base 10 of an image.

Returns:

• base 10 log of each pixel

# File 'lib/vips/image.rb', line 1158

def log10
    math :log10
end

#mapim(index, opts = {}) ⇒ Vips::Image

Resample with an mapim image.

Parameters:

• Index pixels with this

• (defaults to: {})

  Set of options

Options Hash (opts):

• :interpolate (Vips::Interpolate) —

  Interpolate pixels with this

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1440

#maplut(lut, opts = {}) ⇒ Vips::Image

Map an image though a lut.

Parameters:

• Look-up table image

• (defaults to: {})

  Set of options

Options Hash (opts):

• :band (Integer) —

  apply one-band lut to this band of in

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1709

#match(sec, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts = {}) ⇒ Vips::Image

First-order match of two images.

Parameters:

• Secondary image

• Position of first reference tie-point

• Position of first reference tie-point

• Position of first secondary tie-point

• Position of first secondary tie-point

• Position of second reference tie-point

• Position of second reference tie-point

• Position of second secondary tie-point

• Position of second secondary tie-point

• (defaults to: {})

  Set of options

Options Hash (opts):

• :hwindow (Integer) —

  Half window size

• :harea (Integer) —

  Half area size

• :search (Boolean) —

  Search to improve tie-points

• :interpolate (Vips::Interpolate) —

  Interpolate pixels with this

Returns:

• Output image

# File 'lib/vips/methods.rb', line 2045

#math(math, opts = {}) ⇒ Vips::Image

Apply a math operation to an image.

Parameters:

• math to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 98

#math2(right, math2, opts = {}) ⇒ Vips::Image

Binary math operations.

Parameters:

• Right-hand image argument

• math to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 59

#math2_const(math2, c, opts = {}) ⇒ Vips::Image

Binary math operations with a constant.

Parameters:

• math to perform

• Array of constants

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 140

#matrixprint(opts = {}) ⇒ nil

Print matrix.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1167

#matrixsave(filename, opts = {}) ⇒ nil

Save image to matrix file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1159

#max(opts = {}) ⇒ Float, Hash<Symbol => Object>

Find image maximum.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :size (Integer) —

  Number of maximum values to find

• :x (Integer) —

  Output Horizontal position of maximum

• :y (Integer) —

  Output Vertical position of maximum

• :out_array (Array<Double>) —

  Output Array of output values

• :x_array (Array<Integer>) —

  Output Array of horizontal positions

• :y_array (Array<Integer>) —

  Output Array of vertical positions

Returns:

• Output value, Hash of optional output items

# File 'lib/vips/methods.rb', line 175

#maxpos ⇒ Real

Return the coordinates of the image maximum.

Returns:

• maximum value, x coordinate of maximum, y coordinate of maximum

# File 'lib/vips/image.rb', line 1006

def maxpos
    v, opts = max x: true, y: true
    x = opts['x']
    y = opts['y']
    return v, x, y
end

#measure(h, v, opts = {}) ⇒ Vips::Image

Measure a set of patches on a color chart.

Parameters:

• Number of patches across chart

• Number of patches down chart

• (defaults to: {})

  Set of options

Options Hash (opts):

• :left (Integer) —

  Left edge of extract area

• :top (Integer) —

  Top edge of extract area

• :width (Integer) —

  Width of extract area

• :height (Integer) —

  Height of extract area

Returns:

• Output array of statistics

# File 'lib/vips/methods.rb', line 239

#median(size = 3) ⇒ Image

a median filter

Parameters:

• (defaults to: 3)

  size of filter window

Returns:

• result of median filter

# File 'lib/vips/image.rb', line 1042

def median size = 3
    rank size, size, (size * size) / 2
end

#merge(sec, direction, dx, dy, opts = {}) ⇒ Vips::Image

Merge two images.

Parameters:

• Secondary image

• Horizontal or vertcial merge

• Horizontal displacement from sec to ref

• Vertical displacement from sec to ref

• (defaults to: {})

  Set of options

Options Hash (opts):

• :mblend (Integer) —

  Maximum blend size

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1993

#min(opts = {}) ⇒ Float, Hash<Symbol => Object>

Find image minimum.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :size (Integer) —

  Number of minimum values to find

• :x (Integer) —

  Output Horizontal position of minimum

• :y (Integer) —

  Output Vertical position of minimum

• :out_array (Array<Double>) —

  Output Array of output values

• :x_array (Array<Integer>) —

  Output Array of horizontal positions

• :y_array (Array<Integer>) —

  Output Array of vertical positions

Returns:

• Output value, Hash of optional output items

# File 'lib/vips/methods.rb', line 164

#minpos ⇒ Real

Return the coordinates of the image minimum.

Returns:

• minimum value, x coordinate of minimum, y coordinate of minimum

# File 'lib/vips/image.rb', line 1017

def minpos
    v, opts = min x: true, y: true
    x = opts['x']
    y = opts['y']
    return v, x, y
end

#morph(mask, morph, opts = {}) ⇒ Vips::Image

Morphology operation.

Parameters:

• Input matrix image

• Morphological operation to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1894

#mosaic(sec, direction, xref, yref, xsec, ysec, opts = {}) ⇒ Vips::Image, Hash<Symbol => Object>

Mosaic two images.

Parameters:

• Secondary image

• Horizontal or vertcial mosaic

• Position of reference tie-point

• Position of reference tie-point

• Position of secondary tie-point

• Position of secondary tie-point

• (defaults to: {})

  Set of options

Options Hash (opts):

• :hwindow (Integer) —

  Half window size

• :harea (Integer) —

  Half area size

• :mblend (Integer) —

  Maximum blend size

• :bandno (Integer) —

  Band to search for features on

• :dx0 (Integer) —

  Output Detected integer offset

• :dy0 (Integer) —

  Output Detected integer offset

• :scale1 (Float) —

  Output Detected scale

• :angle1 (Float) —

  Output Detected rotation

• :dy1 (Float) —

  Output Detected first-order displacement

• :dx1 (Float) —

  Output Detected first-order displacement

Returns:

• Output image, Hash of optional output items

# File 'lib/vips/methods.rb', line 2003

#mosaic1(sec, direction, xr1, yr1, xs1, ys1, xr2, yr2, xs2, ys2, opts = {}) ⇒ Vips::Image

First-order mosaic of two images.

Parameters:

• Secondary image

• Horizontal or vertcial mosaic

• Position of first reference tie-point

• Position of first reference tie-point

• Position of first secondary tie-point

• Position of first secondary tie-point

• Position of second reference tie-point

• Position of second reference tie-point

• Position of second secondary tie-point

• Position of second secondary tie-point

• (defaults to: {})

  Set of options

Options Hash (opts):

• :hwindow (Integer) —

  Half window size

• :harea (Integer) —

  Half area size

• :search (Boolean) —

  Search to improve tie-points

• :interpolate (Vips::Interpolate) —

  Interpolate pixels with this

• :mblend (Integer) —

  Maximum blend size

• :bandno (Integer) —

  Band to search for features on

Returns:

• Output image

# File 'lib/vips/methods.rb', line 2024

#msb(opts = {}) ⇒ Vips::Image

Pick most-significant byte from an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :band (Integer) —

  Band to msb

Returns:

• Output image

# File 'lib/vips/methods.rb', line 513

#multiply(right, opts = {}) ⇒ Vips::Image

Multiply two images.

Parameters:

• Right-hand image argument

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 27

#new_from_image(value) ⇒ Image

A new image is created with the same width, height, format, interpretation, resolution and offset as self, but with every pixel set to the specified value.

You can pass an array to make a many-band image, or a single value to make a one-band image.

Parameters:

• value to put in each pixel

Returns:

• constant image

# File 'lib/vips/image.rb', line 369

def new_from_image value
    pixel = (Vips::Image.black(1, 1) + value).cast(format)
    image = pixel.embed 0, 0, width, height, extend: :copy
    image.copy interpretation: interpretation,
        xres: xres, yres: yres, xoffset: xoffset, yoffset: yoffset
end

#offset ⇒ Float

Get offset metadata.

Returns:

• image offset

# File 'lib/vips/image.rb', line 685

def offset
    return 0 if get_typeof("offset") == 0

    get "offset"
end

#parent_get_typeof ⇒ Object

# File 'lib/vips/image.rb', line 54

alias_method :parent_get_typeof, :get_typeof

#percent(percent, opts = {}) ⇒ Integer

Find threshold for percent of pixels.

Parameters:

• Percent of pixels

• (defaults to: {})

  Set of options

Returns:

• Threshold above which lie percent of pixels

# File 'lib/vips/methods.rb', line 1716

#phasecor(in2, opts = {}) ⇒ Vips::Image

Calculate phase correlation.

Parameters:

• Second input image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1888

#pngsave(filename, opts = {}) ⇒ nil

Save image to png file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :compression (Integer) —

  Compression factor

• :interlace (Boolean) —

  Interlace image

• :profile (String) —

  ICC profile to embed

• :filter (Vips::ForeignPngFilter) —

  libpng row filter flag(s)

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1260

#pngsave_buffer(opts = {}) ⇒ VipsBlob

Save image to png buffer.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :compression (Integer) —

  Compression factor

• :interlace (Boolean) —

  Interlace image

• :profile (String) —

  ICC profile to embed

• :filter (Vips::ForeignPngFilter) —

  libpng row filter flag(s)

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

• Buffer to save to

# File 'lib/vips/methods.rb', line 1272

#polar ⇒ Image

Return an image with rectangular pixels converted to polar.

The image can be complex, in which case the return image will also be complex, or must have an even number of bands, in which case pairs of bands are treated as (x, y) coordinates.

Returns:

• image converted to polar coordinates

See Also:

• xyz

# File 'lib/vips/image.rb', line 1069

def polar
    Image::run_cmplx(self) {|x| x.complex :polar}
end

#ppmsave(filename, opts = {}) ⇒ nil

Save image to ppm file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :ascii (Boolean) —

  save as ascii

• :squash (Boolean) —

  save as one bit

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1198

#premultiply(opts = {}) ⇒ Vips::Image

Premultiply image alpha.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :max_alpha (Float) —

  Maximum value of alpha channel

Returns:

• Output image

# File 'lib/vips/methods.rb', line 471

#profile(opts = {}) ⇒ Array<] First non-zero pixel in column, First non-zero pixel in row

Find image profiles.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Array<] First non-zero pixel in column, First non-zero pixel in row

# File 'lib/vips/methods.rb', line 234

#project(opts = {}) ⇒ Array<] Sums of columns, Sums of rows

Find image projections.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Array<] Sums of columns, Sums of rows

# File 'lib/vips/methods.rb', line 229

#quadratic(coeff, opts = {}) ⇒ Vips::Image

Resample an image with a quadratic transform.

Parameters:

• Coefficient matrix

• (defaults to: {})

  Set of options

Options Hash (opts):

• :interpolate (Vips::Interpolate) —

  Interpolate values with this

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1491

#rad2float(opts = {}) ⇒ Vips::Image

Unpack radiance coding to float rgb.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1620

#radsave(filename, opts = {}) ⇒ nil

Save image to radiance file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1208

#radsave_buffer(opts = {}) ⇒ VipsBlob

Save image to radiance buffer.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

• Buffer to save to

# File 'lib/vips/methods.rb', line 1216

#rank(width, height, index, opts = {}) ⇒ Vips::Image

Rank filter.

Parameters:

• Window width in pixels

• Window height in pixels

• Select pixel at index

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1901

#rawsave(filename, opts = {}) ⇒ nil

Save image to raw file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1174

#rawsave_fd(fd, opts = {}) ⇒ nil

Write raw image to file descriptor.

Parameters:

• File descriptor to write to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1182

#real ⇒ Image

Return the real part of a complex image.

Returns:

• real part of complex image

# File 'lib/vips/image.rb', line 1049

def real
    complexget :real
end

#recomb(m, opts = {}) ⇒ Vips::Image

Linear recombination with matrix.

Parameters:

• matrix of coefficients

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 446

#rect ⇒ Image

Return an image with polar pixels converted to rectangular.

The image can be complex, in which case the return image will also be complex, or must have an even number of bands, in which case pairs of bands are treated as (x, y) coordinates.

Returns:

• image converted to rectangular coordinates

See Also:

• xyz

# File 'lib/vips/image.rb', line 1082

def rect
    Image::run_cmplx(self) {|x| x.complex :rect}
end

#reduce(hshrink, vshrink, opts = {}) ⇒ Vips::Image

Reduce an image.

Parameters:

• Horizontal shrink factor

• Vertical shrink factor

• (defaults to: {})

  Set of options

Options Hash (opts):

• :kernel (Vips::Kernel) —

  Resampling kernel

• :centre (Boolean) —

  Use centre sampling convention

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1482

#reduceh(hshrink, opts = {}) ⇒ Vips::Image

Shrink an image horizontally.

Parameters:

• Horizontal shrink factor

• (defaults to: {})

  Set of options

Options Hash (opts):

• :kernel (Vips::Kernel) —

  Resampling kernel

• :centre (Boolean) —

  Use centre sampling convention

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1466

#reducev(vshrink, opts = {}) ⇒ Vips::Image

Shrink an image vertically.

Parameters:

• Vertical shrink factor

• (defaults to: {})

  Set of options

Options Hash (opts):

• :kernel (Vips::Kernel) —

  Resampling kernel

• :centre (Boolean) —

  Use centre sampling convention

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1474

#relational(right, relational, opts = {}) ⇒ Vips::Image

Relational operation on two images.

Parameters:

• Right-hand image argument

• relational to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 39

#relational_const(relational, c, opts = {}) ⇒ Vips::Image

Relational operations against a constant.

Parameters:

• relational to perform

• Array of constants

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 120

#remainder(right, opts = {}) ⇒ Vips::Image

Remainder after integer division of two images.

Parameters:

• Right-hand image argument

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 46

#remainder_const(c, opts = {}) ⇒ Vips::Image

Remainder after integer division of an image and a constant.

Parameters:

• Array of constants

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 127

#remove(name) ⇒ Object

Remove a metadata item from an image.

Parameters:

• Metadata field to remove

# File 'lib/vips/image.rb', line 582

def remove name
    Vips::vips_image_remove self, name
end

#replicate(across, down, opts = {}) ⇒ Vips::Image

Replicate an image.

Parameters:

• Repeat this many times horizontally

• Repeat this many times vertically

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 414

#resize(scale, opts = {}) ⇒ Vips::Image

Resize an image.

Parameters:

• Scale image by this factor

• (defaults to: {})

  Set of options

Options Hash (opts):

• :kernel (Vips::Kernel) —

  Resampling kernel

• :centre (Boolean) —

  Use centre sampling convention

• :vscale (Float) —

  Vertical scale image by this factor

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1522

#respond_to?(name, include_all = false) ⇒ Boolean

Returns:

# File 'lib/vips/image.rb', line 169

def respond_to? name, include_all = false
    # To support keyword args, we need to tell Ruby that final image
    # arguments cannot be hashes of keywords. 
    #
    # https://makandracards.com/makandra/36013-heads-up-ruby-implicitly-converts-a-hash-to-keyword-arguments
    return false if name == :to_hash

    # respond to all vips operations by nickname
    return true if Vips::type_find("VipsOperation", name.to_s) != 0

    super
end

#rint ⇒ Image

Return the nearest integral value.

Returns:

• rint of image

# File 'lib/vips/image.rb', line 951

def rint
    round :rint
end

#rot(angle, opts = {}) ⇒ Vips::Image

Rotate an image.

Parameters:

• Angle to rotate image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 428

#rot180 ⇒ Image

Rotate by 180 degrees clockwise.

Returns:

• rotated image

# File 'lib/vips/image.rb', line 1224

def rot180
    rot :d180
end

#rot270 ⇒ Image

Rotate by 270 degrees clockwise.

Returns:

• rotated image

# File 'lib/vips/image.rb', line 1231

def rot270
    rot :d270
end

#rot45(opts = {}) ⇒ Vips::Image

Rotate an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :angle (Vips::Angle45) —

  Angle to rotate image

Returns:

• Output image

# File 'lib/vips/methods.rb', line 434

#rot90 ⇒ Image

Rotate by 90 degrees clockwise.

Returns:

• rotated image

# File 'lib/vips/image.rb', line 1217

def rot90
    rot :d90
end

#round(round, opts = {}) ⇒ Vips::Image

Perform a round function on an image.

Parameters:

• rounding operation to perform

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 114

#scale ⇒ Float

Get scale metadata.

Returns:

• image scale

# File 'lib/vips/image.rb', line 676

def scale
    return 1 if get_typeof("scale") == 0

    get "scale"
end

#scaleimage(opts = {}) ⇒ Vips::Image

Scale an image to uchar. This is the vips scale operation, but renamed to avoid a clash with the .scale property.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/image.rb', line 1262

def scaleimage opts = {}
    Vips::Image.scale self, opts
end

#scRGB2BW(opts = {}) ⇒ Vips::Image

Convert scrgb to bw.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :depth (Integer) —

  Output device space depth in bits

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1697

#scRGB2sRGB(opts = {}) ⇒ Vips::Image

Convert an scrgb image to srgb.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :depth (Integer) —

  Output device space depth in bits

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1703

#scRGB2XYZ(opts = {}) ⇒ Vips::Image

Transform scrgb to xyz.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1580

#sequential(opts = {}) ⇒ Vips::Image

Check sequential access.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :tile_height (Integer) —

  Tile height in pixels

Returns:

• Output image

# File 'lib/vips/methods.rb', line 292

#set(name, value) ⇒ Object

Set the value of a metadata item on an image. The metadata item must already exist. Ruby types are automatically transformed into the matching GValue, if possible.

For example, you can use this to set an image's ICC profile:

x = y.set "icc-profile-data", profile

where profile is an ICC profile held as a binary string object.

Parameters:

• Metadata field to set

• Value to set

See Also:

• #set_type

# File 'lib/vips/image.rb', line 575

def set name, value
    set_type get_typeof(name), name, value
end

#set_type(gtype, name, value) ⇒ Object

Create a metadata item on an image, of the specifed type. Ruby types are automatically transformed into the matching GType, if possible.

For example, you can use this to set an image's ICC profile:

x = y.set Vips::BLOB_TYPE, "icc-profile-data", profile

where profile is an ICC profile held as a binary string object.

Parameters:

• GType of item

• Metadata field to set

• Value to set

See Also:

• #set

# File 'lib/vips/image.rb', line 553

def set_type gtype, name, value
    gvalue = GObject::GValue.alloc
    gvalue.init gtype
    gvalue.set value
    Vips::vips_image_set self, name, gvalue
end

#set_value(name, value) ⇒ Object

compatibility: old name for set

# File 'lib/vips/image.rb', line 592

def set_value name, value
    set name, value
end

#sharpen(opts = {}) ⇒ Vips::Image

Unsharp masking for print.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :sigma (Float) —

  Sigma of Gaussian

• :x1 (Float) —

  Flat/jaggy threshold

• :y2 (Float) —

  Maximum brightening

• :y3 (Float) —

  Maximum darkening

• :m1 (Float) —

  Slope for flat areas

• :m2 (Float) —

  Slope for jaggy areas

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1847

#shrink(hshrink, vshrink, opts = {}) ⇒ Vips::Image

Shrink an image.

Parameters:

• Horizontal shrink factor

• Vertical shrink factor

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1447

#shrinkh(hshrink, opts = {}) ⇒ Vips::Image

Shrink an image horizontally.

Parameters:

• Horizontal shrink factor

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1454

#shrinkv(vshrink, opts = {}) ⇒ Vips::Image

Shrink an image vertically.

Parameters:

• Vertical shrink factor

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1460

#sign(opts = {}) ⇒ Vips::Image

Unit vector of pixel.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 109

#similarity(opts = {}) ⇒ Vips::Image

Similarity transform of an image.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :interpolate (Vips::Interpolate) —

  Interpolate pixels with this

• :scale (Float) —

  Scale by this factor

• :angle (Float) —

  Rotate anticlockwise by this many degrees

• :odx (Float) —

  Horizontal output displacement

• :ody (Float) —

  Vertical output displacement

• :idx (Float) —

  Horizontal input displacement

• :idy (Float) —

  Vertical input displacement

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1510

#sin ⇒ Image

Return the sine of an image in degrees.

Returns:

• sine of each pixel

# File 'lib/vips/image.rb', line 1109

def sin
    math :sin 
end

#size ⇒ Integer

Get the image size.

Returns:

• image width and height

# File 'lib/vips/image.rb', line 694

def size
    [width, height]
end

#smartcrop(width, height, opts = {}) ⇒ Vips::Image

Extract an area from an image.

Parameters:

• Width of extract area

• Height of extract area

• (defaults to: {})

  Set of options

Options Hash (opts):

• :interesting (Vips::Interesting) —

  How to measure interestingness

Returns:

• Output image

# File 'lib/vips/methods.rb', line 375

#spcor(ref, opts = {}) ⇒ Vips::Image

Spatial correlation.

Parameters:

• Input reference image

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1841

#spectrum(opts = {}) ⇒ Vips::Image

Make displayable power spectrum.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1883

#sRGB2HSV(opts = {}) ⇒ Vips::Image

Transform srgb to hsv.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1635

#sRGB2scRGB(opts = {}) ⇒ Vips::Image

Convert an srgb image to scrgb.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1692

#stats(opts = {}) ⇒ Vips::Image

Find image average.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output array of statistics

# File 'lib/vips/methods.rb', line 191

#stdif(width, height, opts = {}) ⇒ Vips::Image

Statistical difference.

Parameters:

• Window width in pixels

• Window height in pixels

• (defaults to: {})

  Set of options

Options Hash (opts):

• :s0 (Float) —

  New deviation

• :b (Float) —

  Weight of new deviation

• :m0 (Float) —

  New mean

• :a (Float) —

  Weight of new mean

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1722

#subsample(xfac, yfac, opts = {}) ⇒ Vips::Image

Subsample an image.

Parameters:

• Horizontal subsample factor

• Vertical subsample factor

• (defaults to: {})

  Set of options

Options Hash (opts):

• :point (Boolean) —

  Point sample

Returns:

• Output image

# File 'lib/vips/methods.rb', line 505

#subtract(right, opts = {}) ⇒ Vips::Image

Subtract two images.

Parameters:

• Right-hand image argument

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 21

#tan ⇒ Image

Return the tangent of an image in degrees.

Returns:

• tangent of each pixel

# File 'lib/vips/image.rb', line 1123

def tan
    math :tan
end

#tiffsave(filename, opts = {}) ⇒ nil

Save image to tiff file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :compression (Vips::ForeignTiffCompression) —

  Compression for this file

• :Q (Integer) —

  Q factor

• :predictor (Vips::ForeignTiffPredictor) —

  Compression prediction

• :profile (String) —

  ICC profile to embed

• :tile (Boolean) —

  Write a tiled tiff

• :tile_width (Integer) —

  Tile width in pixels

• :tile_height (Integer) —

  Tile height in pixels

• :pyramid (Boolean) —

  Write a pyramidal tiff

• :miniswhite (Boolean) —

  Use 0 for white in 1-bit images

• :squash (Boolean) —

  Squash images down to 1 bit

• :resunit (Vips::ForeignTiffResunit) —

  Resolution unit

• :xres (Float) —

  Horizontal resolution in pixels/mm

• :yres (Float) —

  Vertical resolution in pixels/mm

• :bigtiff (Boolean) —

  Write a bigtiff image

• :properties (Boolean) —

  Write a properties document to IMAGEDESCRIPTION

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1359

#tiffsave_buffer(opts = {}) ⇒ VipsBlob

Save image to tiff buffer.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :compression (Vips::ForeignTiffCompression) —

  Compression for this file

• :Q (Integer) —

  Q factor

• :predictor (Vips::ForeignTiffPredictor) —

  Compression prediction

• :profile (String) —

  ICC profile to embed

• :tile (Boolean) —

  Write a tiled tiff

• :tile_width (Integer) —

  Tile width in pixels

• :tile_height (Integer) —

  Tile height in pixels

• :pyramid (Boolean) —

  Write a pyramidal tiff

• :miniswhite (Boolean) —

  Use 0 for white in 1-bit images

• :squash (Boolean) —

  Squash images down to 1 bit

• :resunit (Vips::ForeignTiffResunit) —

  Resolution unit

• :xres (Float) —

  Horizontal resolution in pixels/mm

• :yres (Float) —

  Vertical resolution in pixels/mm

• :bigtiff (Boolean) —

  Write a bigtiff image

• :properties (Boolean) —

  Write a properties document to IMAGEDESCRIPTION

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

• Buffer to save to

# File 'lib/vips/methods.rb', line 1382

#tilecache(opts = {}) ⇒ Vips::Image

Cache an image as a set of tiles.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :tile_width (Integer) —

  Tile width in pixels

• :tile_height (Integer) —

  Tile height in pixels

• :max_tiles (Integer) —

  Maximum number of tiles to cache

• :access (Vips::Access) —

  Expected access pattern

• :threaded (Boolean) —

  Allow threaded access

• :persistent (Boolean) —

  Keep cache between evaluations

Returns:

• Output image

# File 'lib/vips/methods.rb', line 272

#to_a ⇒ Array

Convert to an Array. This will be slow for large images.

Returns:

• array of Fixnum

# File 'lib/vips/image.rb', line 901

def to_a
    # we render the image to a big string, then unpack 
    # as a Ruby array of the correct type
    memory = write_to_memory

    # make the template for unpack
    template = {
        :char => 'c',
        :uchar => 'C',
        :short => 's_',
        :ushort => 'S_',
        :int => 'i_',
        :uint => 'I_',
        :float => 'f',
        :double => 'd',
        :complex => 'f',
        :dpcomplex => 'd'
    }[format] + '*'

    # and unpack into something like [1, 2, 3, 4 ..]
    array = memory.unpack(template)

    # gather band elements together
    pixel_array = []
    array.each_slice(bands) {|pixel| pixel_array << pixel}

    # build rows 
    row_array = []
    pixel_array.each_slice(width) {|row| row_array << row}

    return row_array
end

#unpremultiply(opts = {}) ⇒ Vips::Image

Unpremultiply image alpha.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :max_alpha (Float) —

  Maximum value of alpha channel

Returns:

• Output image

# File 'lib/vips/methods.rb', line 477

#vipssave(filename, opts = {}) ⇒ nil

Save image to vips file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1190

#webpsave(filename, opts = {}) ⇒ nil

Save image to webp file.

Parameters:

• Filename to save to

• (defaults to: {})

  Set of options

Options Hash (opts):

• :Q (Integer) —

  Q factor

• :lossless (Boolean) —

  enable lossless compression

• :preset (Vips::ForeignWebpPreset) —

  Preset for lossy compression

• :smart_subsample (Boolean) —

  Enable high quality chroma subsampling

• :near_lossless (Boolean) —

  Enable preprocessing in lossless mode (uses Q)

• :alpha_q (Integer) —

  Change alpha plane fidelity for lossy compression

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

# File 'lib/vips/methods.rb', line 1332

#webpsave_buffer(opts = {}) ⇒ VipsBlob

Save image to webp buffer.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :Q (Integer) —

  Q factor

• :lossless (Boolean) —

  enable lossless compression

• :preset (Vips::ForeignWebpPreset) —

  Preset for lossy compression

• :smart_subsample (Boolean) —

  Enable high quality chroma subsampling

• :near_lossless (Boolean) —

  Enable preprocessing in lossless mode (uses Q)

• :alpha_q (Integer) —

  Change alpha plane fidelity for lossy compression

• :strip (Boolean) —

  Strip all metadata from image

• :background (Array<Double>) —

  Background value

Returns:

• Buffer to save to

# File 'lib/vips/methods.rb', line 1346

#width ⇒ Integer

Get image width, in pixels.

Returns:

• image width, in pixels

# File 'lib/vips/image.rb', line 599

def width
    get "width"
end

#wrap(opts = {}) ⇒ Vips::Image

Wrap image origin.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :x (Integer) —

  Left edge of input in output

• :y (Integer) —

  Top edge of input in output

Returns:

• Output image

# File 'lib/vips/methods.rb', line 491

#write_to_buffer(format_string, opts = {}) ⇒ String

Write this image to a memory buffer. Save options may be encoded in the format_string or given as a hash. For example:

buffer = image.write_to_buffer ".jpg[Q=90]"

or equivalently:

image.write_to_buffer ".jpg", Q: 90

The full set of save options depend on the selected saver. Try something like:

$ vips jpegsave

to see all the available options for JPEG save.

Parameters:

• save format plus options

• (defaults to: {})

  set of options

Options Hash (opts):

• :strip (Boolean) — default: false —

  Strip all metadata from image

• :background (Array<Float>) — default: 0 —

  Background colour to flatten alpha against, if necessary

Returns:

• the image saved in the specified format

Raises:

# File 'lib/vips/image.rb', line 443

def write_to_buffer format_string, opts = {}
    filename = Vips::vips_filename_get_filename format_string
    option_string = Vips::vips_filename_get_options format_string
    saver = Vips::vips_foreign_find_save_buffer filename
    if saver == nil
        raise Vips::Error, "No known saver for '#{filename}'."
    end

    buffer = Vips::Operation.call saver, [self], opts, option_string
    raise Vips::Error if buffer == nil

    write_gc

    return buffer
end

#write_to_file(name, opts = {}) ⇒ Object

Write this image to a file. Save options may be encoded in the filename or given as a hash. For example:

image.write_to_file "fred.jpg[Q=90]"

or equivalently:

image.write_to_file "fred.jpg", Q: 90

The full set of save options depend on the selected saver. Try something like:

$ vips jpegsave

to see all the available options for JPEG save.

Parameters:

• (defaults to: {})

  set of options

• filename to write to

Options Hash (opts):

• :strip (Boolean) — default: false —

  Strip all metadata from image

• :background (Array<Float>) — default: 0 —

  Background colour to flatten alpha against, if necessary

# File 'lib/vips/image.rb', line 405

def write_to_file name, opts = {}
    filename = Vips::vips_filename_get_filename name
    option_string = Vips::vips_filename_get_options name
    saver = Vips::vips_foreign_find_save filename
    if saver == nil
        raise Vips::Error, "No known saver for '#{filename}'."
    end

    Vips::Operation.call saver, [self, filename], opts, option_string

    write_gc
end

#write_to_memory ⇒ String

Write this image to a large memory buffer.

Returns:

• the pixels as a huge binary string

# File 'lib/vips/image.rb', line 462

def write_to_memory
    len = Vips::SizeStruct.new
    ptr = Vips::vips_image_write_to_memory self, len

    # wrap up as an autopointer
    ptr = FFI::AutoPointer.new(ptr, GLib::G_FREE)

    ptr.get_bytes 0, len[:value]
end

#xoffset ⇒ Integer

Get image xoffset.

Returns:

• image xoffset

# File 'lib/vips/image.rb', line 648

def xoffset
    get "xoffset"
end

#xres ⇒ Float

Get image x resolution.

Returns:

• image x resolution

# File 'lib/vips/image.rb', line 662

def xres
    get "xres"
end

#XYZ2Lab(opts = {}) ⇒ Vips::Image

Transform xyz to lab.

Parameters:

• (defaults to: {})

  Set of options

Options Hash (opts):

• :temp (Array<Double>) —

  Colour temperature

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1544

#XYZ2scRGB(opts = {}) ⇒ Vips::Image

Transform xyz to scrgb.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1585

#XYZ2Yxy(opts = {}) ⇒ Vips::Image

Transform xyz to yxy.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1570

#yoffset ⇒ Integer

Get image yoffset.

Returns:

• image yoffset

# File 'lib/vips/image.rb', line 655

def yoffset
    get "yoffset"
end

#yres ⇒ Float

Get image y resolution.

Returns:

• image y resolution

# File 'lib/vips/image.rb', line 669

def yres
    get "yres"
end

#Yxy2XYZ(opts = {}) ⇒ Vips::Image

Transform yxy to xyz.

Parameters:

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 1575

#zoom(xfac, yfac, opts = {}) ⇒ Vips::Image

Zoom an image.

Parameters:

• Horizontal zoom factor

• Vertical zoom factor

• (defaults to: {})

  Set of options

Returns:

• Output image

# File 'lib/vips/methods.rb', line 498

#|(other) ⇒ Image

Integer bitwise OR with an image, constant or array.

Parameters:

• bitwise OR with this

Returns:

• result of bitwise OR

# File 'lib/vips/image.rb', line 776

def | other
    call_enum "boolean", other, :or
end

#~ ⇒ Image

Equivalent to image ^ -1

Returns:

• image with bits flipped

# File 'lib/vips/image.rb', line 806

def ~
    self ^ -1
end