PxPicture Class

@interface PxPicture : NSObject

An image plus its scanning metadata (orientation, flash status, and so on), and the operations to detect a document in it and refine it.

Instance Properties

NameSummary
colorHintA hint about the image’s colour content.
flashStatusWhether the flash fired when the image was captured.
isoSpeedRatingsThe image’s ISO speed rating.
orientationThe image orientation.
originalImageThe original image (rotated to its orientation) this picture was created from.
originalImageWithOrientationThe original image with its current orientation applied.
pageNumberThe image’s page number.
scanResultThe most recent text-scan result, or nil if none.
strongShadowsWhether the image has strong shadows.

Instance Methods

NameSummary
clearScanResultClears the cached text-scan result.
detectAttempts to detect the document corners in the image.
extractImageExtracts the currently processed image.
extractImageWithoutProcessingExtracts the original image rotated to the current orientation, without processing.
init:Creates a picture from an image, with no metadata.
init:withMetadata:Creates a picture from an image and its associated metadata.
initFromData:Creates a picture from in-memory image data, reading its metadata from the data.
initFromNSURL:Creates a picture from an image NSURL, reading its metadata from the image.
initFromPath:Creates a picture from an image file, reading its metadata from the file.
initFromURL:Creates a picture from an image URL string, reading its metadata from the image.
refine:Processes the image as described by the given features. The features builder is reset on return.
resetResets the pixel data back to the original image, leaving image properties (such as orientation) intact. originalImage must not be nil.
scopeReturns an expanded cutout that covers the entire image.

Relationships

Inherits From

  • NSObject
Top