spatstat (version 1.23-1)

summary.im: Summarizing a Pixel Image

Description

summary method for class "im".

Usage

## S3 method for class 'im':
summary(object, \dots)
  ## S3 method for class 'im':
print.summary(x, \dots)

Arguments

object

A pixel image.

...

Ignored.

x

Object of class "summary.im" as returned by summary.im.

Value

• summary.im returns an object of class "summary.im", while print.summary.im returns NULL.

Details

This is a method for the generic summary for the class "im". An object of class "im" describes a pixel image. See im.object) for details of this class. summary.im extracts information about the pixel image, and print.summary.im prints this information in a comprehensible format.

In normal usage, print.summary.im is invoked implicitly when the user calls summary.im without assigning its value to anything. See the examples.

The information extracted by summary.im includes [object Object],[object Object],[object Object],[object Object]

Examples

# make an image
  X <- as.im(function(x,y) {x^2}, unit.square())
  # summarize it
  summary(X)
  # save the summary
  s <- summary(X)
  # print it
  print(X)
  s
  # extract stuff
  X$dim
  X$range
  X$integral