ImageResizer  3.4.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ImageResizer.Plugins.Faces.FacesPlugin Class Reference
Inheritance diagram for ImageResizer.Plugins.Faces.FacesPlugin:
Inheritance graph
[legend]
Collaboration diagram for ImageResizer.Plugins.Faces.FacesPlugin:
Collaboration graph
[legend]

Public Member Functions

IPlugin Install (Configuration.Config c)
 
bool Uninstall (Configuration.Config c)
 
string GetFacesFromImageAsString (object image, NameValueCollection settings)
 Returns a comma-delimited list of face coordinates (x,y,x2,y2,accuracy) for the given image (path, stream, Bitmap, etc). Note that the face coordinates are relative to the unrotated, unflipped source image. ImageResizer.js can keep these coordinates synced during rotations/flipping if they are stored in the 'f.rects' querystring key before the 'srotate' or 'sflip' commands are applied. More...
 
List< FaceGetFacesFromImage (object image, NameValueCollection settings)
 Returns a list of face objects for the given image (path, stream, Bitmap, etc). Note that the face coordinates are relative to the unrotated, unflipped source image. ImageResizer.js can keep these coordinates synced during rotations/flipping if they are stored in the 'f.rects' querystring key before the 'srotate' or 'sflip' commands are applied. More...
 
FaceDetection ConfigureDetection (NameValueCollection s)
 
IEnumerable< string > GetSupportedQuerystringKeys ()
 If the plugin reads any values from the querystring, the names of the keys should be specified here. This information is required so that the HttpModule knows when to handle an image request. More...
 
- Public Member Functions inherited from ImageResizer.Resizing.AbstractImageProcessor
 AbstractImageProcessor ()
 Creates a new AbstractImageProcessor with no extensions More...
 
 AbstractImageProcessor (IEnumerable< BuilderExtension > extensions)
 Creates a new AbstractImageProcessor which will run the specified extensions with each method call. More...
 
virtual Bitmap DecodeStreamFailed (Stream s, ResizeSettings settings, string optionalPath)
 Extensions are executed until one extension returns a non-null value. This is taken to mean that the error has been resolved. Extensions should not throw an exception unless they wish to cause subsequent extensions to not execute. If extensions throw an ArgumentException or ExternalException, it will be wrapped in an ImageCorruptedException instance. If the Bitmap class is used for decoding, read gdi-bugs.txt and make sure you set b.Tag to new BitmapTag(optionalPath,stream); More...
 
virtual Bitmap DecodeStream (Stream s, ResizeSettings settings, string optionalPath)
 Extend this to support alternate image source formats. If the Bitmap class is used for decoding, read gdi-bugs.txt and make sure you set b.Tag to new BitmapTag(optionalPath,stream); More...
 
- Public Member Functions inherited from ImageResizer.Plugins.IPlugin
IPlugin Install (Config c)
 Installs the plugin in the specified Config instance. The plugin must handle all the work of loading settings, registering the plugin etc. More...
 
bool Uninstall (Config c)
 Uninstalls the plugin. Should reverse all changes made during Install More...
 

Protected Member Functions

override RequestedAction PostPrepareSourceBitmap (ImageState s)
 Process.2 Extend this to apply any pre-processing to the source bitmap that needs to occur before Layout begins More...
 
override RequestedAction PostRenderImage (ImageState s)
 Process.5(Render).11: After the image is drawn More...
 
override RequestedAction Render (ImageState s)
 Process.5(Render) Rendering. Do not return RequestedAction.Cancel unless you want to replace the entire rendering system. More...
 
- Protected Member Functions inherited from ImageResizer.Resizing.AbstractImageProcessor
virtual void PreLoadImage (ref object source, ref string path, ref bool disposeSource, ref ResizeSettings settings)
 Extend this to allow additional types of source objects to be accepted by transforming them into Bitmap instances. More...
 
virtual Stream GetStream (object source, ResizeSettings settings, ref bool disposeStream, out string path, out bool restoreStreamPosition)
 Extend this to allow additional types of source objects to be accepted by transforming them into Stream instances. First plugin to return a Stream wins. More...
 
virtual RequestedAction PostDecodeStream (ref Bitmap img, ResizeSettings settings)
 Extend this to modify the Bitmap instance after it has been decoded by DecodeStream or DecodeStreamFailed More...
 
virtual void PreAcquireStream (ref object dest, ResizeSettings settings)
 Extend this to allow additional types of destination objects to be accepted by transforming them into a stream. More...
 
virtual RequestedAction BuildJob (ImageResizer.ImageJob job)
 The method to override if you want to replace the entire pipeline. All Build() calls call this method first. Does nothing in ImageBuilder More...
 
virtual RequestedAction buildToStream (Bitmap source, Stream dest, ResizeSettings settings)
 Called for Build() calls that want the result encoded. (Not for Bitmap Build(source,settings) calls. Only override this method if you need to replace the behavior of image encoding and image processing together, such as adding support for resizing multi-page TIFF files or animated GIFs. More...
 
virtual Bitmap buildToBitmap (Bitmap source, ResizeSettings settings, bool transparencySupported)
 Most calls funnel through here. Default behavior configures an ImageState instance and calls Process(imageState); Shouldn't be overriden for any reason I can think of - use the appropriate virtual method under Process(). If an extension returns a Bitmap instance, it will be used instead of the default behavior. Does NOT dispose of 'source' or 'source's underlying stream. More...
 
virtual RequestedAction OnProcess (ImageState s)
 Process.0 First step of the Process() method. Can replace the entire Process method if RequestAction.Cancel is returned. Can be used to add points to translate (for image maps), and also to modify the settings More...
 
virtual RequestedAction PrepareSourceBitmap (ImageState s)
 Process.1 Switches the bitmap to the correct frame or page, and applies source flipping commands. More...
 
virtual RequestedAction Layout (ImageState s)
 Process.3(Layout).0: This is the last point at which points to translate should be added. Only return RequestedAction.Cancel if you wish to replace the entire Layout sequence logic. More...
 
virtual RequestedAction FlipExistingPoints (ImageState s)
 Process.3(Layout).1: This is where the points in the layout are flipped the same way the source bitmap was flipped (unless their flags specify otherwise) More...
 
virtual RequestedAction LayoutImage (ImageState s)
 Process.3(Layout).2: Rings 'image' and 'imageArea' are added to the layout. More...
 
virtual RequestedAction PostLayoutImage (ImageState s)
 Process.3(Layout).3: Add rings here to insert them between the image area and the padding More...
 
virtual RequestedAction LayoutPadding (ImageState s)
 Process.3(Layout).4: Ring "padding" is added to the layout More...
 
virtual RequestedAction PostLayoutPadding (ImageState s)
 Process.3(Layout).5: Add rings here to insert them between the padding and the border More...
 
virtual RequestedAction LayoutBorder (ImageState s)
 Process.3(Layout).6: Ring "border" is added to the layout More...
 
virtual RequestedAction PostLayoutBorder (ImageState s)
 Process.3(Layout).7: Add rings here to insert them between the border and the effect rings More...
 
virtual RequestedAction LayoutEffects (ImageState s)
 Process.3(Layout).8: Effects such as 'shadow' are added here. More...
 
virtual RequestedAction PostLayoutEffects (ImageState s)
 Process.3(Layout).9: Add rings here to insert them between the effects and the margin More...
 
virtual RequestedAction LayoutMargin (ImageState s)
 Process.3(Layout).10: Margins are added to the layout More...
 
virtual RequestedAction PostLayoutMargin (ImageState s)
 Process.3(Layout).11: Add rings here to insert them around the margin. Rings will be outermost More...
 
virtual RequestedAction LayoutRotate (ImageState s)
 Process.3(Layout).anytime: Occurs when the layout is rotated. May be called anytime during Layout() More...
 
virtual RequestedAction PostLayoutRotate (ImageState s)
 Process.3(Layout).anytime: Occurs after the layout is rotated. May be called anytime during Layout() More...
 
virtual RequestedAction LayoutNormalize (ImageState s)
 Process.3(Layout).anytime: Occurs when the layout is normalized to 0,0. May be called anytime during Layout() More...
 
virtual RequestedAction PostLayoutNormalize (ImageState s)
 Process.3(Layout).anytime: Occurs after the layout is normalized. May be called anytime during Layout() More...
 
virtual RequestedAction LayoutRound (ImageState s)
 Process.3(Layout).anytime: Occurs when the layout point values are rounded to integers. May be called anytime during Layout() More...
 
virtual RequestedAction PostLayoutRound (ImageState s)
 Process.3(Layout).anytime: Occurs after the layout point values are rounded to integers. May be called anytime during Layout() More...
 
virtual RequestedAction EndLayout (ImageState s)
 Process.3(Layout).12: Occurs once layout has finished. No more changes should occur to points or rings in the layout after this method. destSize is calculated here. More...
 
virtual RequestedAction PrepareDestinationBitmap (ImageState s)
 Process.4: The destination bitmap is created and sized based destSize. A graphics object is initialized for rendering. More...
 
virtual RequestedAction RenderBackground (ImageState s)
 Process.5(Render).1 The background color is rendered More...
 
virtual RequestedAction PostRenderBackground (ImageState s)
 Process.5(Render).2 After the background color is rendered More...
 
virtual RequestedAction RenderEffects (ImageState s)
 Process.5(Render).3 Effects (such as a drop shadow or outer glow) are rendered More...
 
virtual RequestedAction PostRenderEffects (ImageState s)
 Process.5(Render).4 After outer effects are rendered More...
 
virtual RequestedAction RenderPadding (ImageState s)
 Process.5(Render).5 Image padding is drawn More...
 
virtual RequestedAction PostRenderPadding (ImageState s)
 Process.5(Render).6 After image padding is drawn More...
 
virtual RequestedAction CreateImageAttribues (ImageState s)
 Process.5(Render).7: An ImageAttributes instance is created if it doesn't already exist. More...
 
virtual RequestedAction PostCreateImageAttributes (ImageState s)
 Process.5(Render).8: The ImageAttributes instance exists and can be modified or replaced. More...
 
virtual RequestedAction PreRenderImage (ImageState s)
 Process.5(Render).9: Plugins have a chance to pre-process the source image before it gets rendered, and save it to s.preRenderBitmap More...
 
virtual RequestedAction RenderImage (ImageState s)
 Process.5(Render).10: The image is copied to the destination parallelogram specified by ring 'image'. More...
 
virtual RequestedAction RenderBorder (ImageState s)
 Process.5(Render).12: The border is rendered More...
 
virtual RequestedAction PostRenderBorder (ImageState s)
 Process.5(Render).13: After the border is drawn More...
 
virtual RequestedAction PreRenderOverlays (ImageState s)
 Process.5(Render).14: Any last-minute changes before watermarking or overlays are applied More...
 
virtual RequestedAction RenderOverlays (ImageState s)
 Process.5(Render).15: Watermarks can be rendered here. All image processing should be done More...
 
virtual RequestedAction PreFlushChanges (ImageState s)
 Process.5(Render).16: Called before changes are flushed and the graphics object is destroyed. More...
 
virtual RequestedAction FlushChanges (ImageState s)
 Process.5(Render).17: Changes are flushed to the bitmap here and the graphics object is destroyed. More...
 
virtual RequestedAction PostFlushChanges (ImageState s)
 Process.5(Render).18: Changes have been flushed to the bitmap, but the final bitmap has not been flipped yet. More...
 
virtual RequestedAction ProcessFinalBitmap (ImageState s)
 Process.6: Non-rendering changes to the bitmap object occur here, such as flipping. The graphics object is unavailable. More...
 
virtual RequestedAction EndProcess (ImageState s)
 Process.7: Layout and rendering are both complete. More...
 

Protected Attributes

Config c
 
- Protected Attributes inherited from ImageResizer.Resizing.AbstractImageProcessor
volatile IEnumerable
< BuilderExtension
exts
 Contains the set of extensions that are called for every method. More...
 

Detailed Description

Definition at line 17 of file FacesPlugin.cs.

Member Function Documentation

List<Face> ImageResizer.Plugins.Faces.FacesPlugin.GetFacesFromImage ( object  image,
NameValueCollection  settings 
)
inline

Returns a list of face objects for the given image (path, stream, Bitmap, etc). Note that the face coordinates are relative to the unrotated, unflipped source image. ImageResizer.js can keep these coordinates synced during rotations/flipping if they are stored in the 'f.rects' querystring key before the 'srotate' or 'sflip' commands are applied.

Parameters
image
settings
Returns

Definition at line 59 of file FacesPlugin.cs.

59  {
60  using (var b = c.CurrentImageBuilder.LoadImage(image, new ResizeSettings(settings))) {
61  using (var detector = ConfigureDetection(settings)) {
62  return detector.DetectFeatures(b);
63  }
64  }
65  }
string ImageResizer.Plugins.Faces.FacesPlugin.GetFacesFromImageAsString ( object  image,
NameValueCollection  settings 
)
inline

Returns a comma-delimited list of face coordinates (x,y,x2,y2,accuracy) for the given image (path, stream, Bitmap, etc). Note that the face coordinates are relative to the unrotated, unflipped source image. ImageResizer.js can keep these coordinates synced during rotations/flipping if they are stored in the 'f.rects' querystring key before the 'srotate' or 'sflip' commands are applied.

Parameters
image
settings
Returns

Definition at line 42 of file FacesPlugin.cs.

42  {
43  var faces = GetFacesFromImage(image, settings);
44  StringBuilder sb = new StringBuilder();
45  foreach (Face f in faces)
46  sb.Append(f.X + "," + f.Y + "," + f.X2 + "," + f.Y2 + "," + f.Accuracy + ",");
47 
48  return sb.ToString().TrimEnd(',');
49  }
List< Face > GetFacesFromImage(object image, NameValueCollection settings)
Returns a list of face objects for the given image (path, stream, Bitmap, etc). Note that the face co...
Definition: FacesPlugin.cs:59
IEnumerable<string> ImageResizer.Plugins.Faces.FacesPlugin.GetSupportedQuerystringKeys ( )
inline

If the plugin reads any values from the querystring, the names of the keys should be specified here. This information is required so that the HttpModule knows when to handle an image request.

Returns

Implements ImageResizer.Plugins.IQuerystringPlugin.

Definition at line 197 of file FacesPlugin.cs.

197  {
198  return new string[] { "f.show", "f.detect","f.faces", "f.threshold", "f.minsize", "f.expand"};
199  }
override RequestedAction ImageResizer.Plugins.Faces.FacesPlugin.PostPrepareSourceBitmap ( ImageState  s)
inlineprotectedvirtual

Process.2 Extend this to apply any pre-processing to the source bitmap that needs to occur before Layout begins

Parameters
s

Reimplemented from ImageResizer.Resizing.AbstractImageProcessor.

Definition at line 67 of file FacesPlugin.cs.

67  {
68  if (s.sourceBitmap == null) return RequestedAction.None;
69 
70  bool focusFaces = ("faces".Equals(s.settings["c.focus"], StringComparison.OrdinalIgnoreCase));
71  bool showFaces = "true".Equals(s.settings["f.show"], StringComparison.OrdinalIgnoreCase);
72 
73  List<Face> faces = null;
74 
75  //Perform face detection for either (or both) situations
76  if (showFaces || focusFaces) {
77  using (var detector = ConfigureDetection(s.settings)) {
78  //Store faces
79  s.Data["faces"] = faces = detector.DetectFeatures(s.sourceBitmap);
80  }
81  //Store points
82  List<PointF> points = new List<PointF>();
83  foreach (Face r in faces) { points.Add(new PointF(r.X, r.Y)); points.Add(new PointF(r.X2, r.Y2)); }
84  s.layout.AddInvisiblePolygon("faces", points.ToArray());
85  }
86 
87  //Capture and rewrite requests with &c.focus=faces
88  if (focusFaces) {
89  //Write the face points as focus values
90  List<double> focusPoints = new List<double>();
91  foreach (Face r in faces) { focusPoints.Add(r.X); focusPoints.Add(r.Y); focusPoints.Add(r.X2); focusPoints.Add(r.Y2); }
92  NameValueCollectionExtensions.SetList<double>(s.settings, "c.focus", focusPoints.ToArray(), false);
93  }
94  return RequestedAction.None;
95  }
ResizeSettings settings
The commands to apply to the bitmap
Definition: ImageState.cs:25
Bitmap sourceBitmap
The source bitmap. If null, skip drawing commands, but continue layout logic.
Definition: ImageState.cs:66
override RequestedAction ImageResizer.Plugins.Faces.FacesPlugin.PostRenderImage ( ImageState  s)
inlineprotectedvirtual

Process.5(Render).11: After the image is drawn

Parameters
s

Reimplemented from ImageResizer.Resizing.AbstractImageProcessor.

Definition at line 98 of file FacesPlugin.cs.

98  {
99  if (!"true".Equals(s.settings["f.show"], StringComparison.OrdinalIgnoreCase) ||
100  !s.layout.ContainsRing("faces") ||
101  s.destBitmap == null) return RequestedAction.None;
102 
103 
104  var newPoints = s.layout["faces"];
105 
106  using (Graphics g = Graphics.FromImage(s.destBitmap)) {
107 
108  for (var i = 0; i < newPoints.Length - 1; i += 2) {
109  float x1 = newPoints[i].X;
110  float y1 = newPoints[i].Y;
111  float x2 = newPoints[i + 1].X;
112  float y2 = newPoints[i + 1].Y;
113  float t;
114  if (x1 > x2) { t = x2; x2 = x1; x1 = t; }
115  if (y1 > y2) { t = y1; y1 = y2; y2 = t; }
116 
117  g.DrawRectangle(Pens.Green, new Rectangle((int)x1, (int)y1, (int)(x2 - x1), (int)(y2 - y1)));
118  }
119  }
120 
121 
122  return RequestedAction.None;
123  }
RequestedAction
What to do about remaining handlers/methods for the specified section
ResizeSettings settings
The commands to apply to the bitmap
Definition: ImageState.cs:25
Bitmap destBitmap
The destination bitmap. If null, skip drawing commands, but continue layout logic.
Definition: ImageState.cs:178
LayoutBuilder layout
The layout object. Used for calculated and flowing the layout of the various rings around the image (...
Definition: ImageState.cs:42
override RequestedAction ImageResizer.Plugins.Faces.FacesPlugin.Render ( ImageState  s)
inlineprotectedvirtual

Process.5(Render) Rendering. Do not return RequestedAction.Cancel unless you want to replace the entire rendering system.

Parameters
s

Reimplemented from ImageResizer.Resizing.AbstractImageProcessor.

Definition at line 126 of file FacesPlugin.cs.

126  {
127  bool detect = NameValueCollectionExtensions.Get(s.settings, "f.detect", false);
128  bool getlayout = NameValueCollectionExtensions.Get(s.settings, "f.getlayout", false);
129  if (!detect && !getlayout) return RequestedAction.None;
130 
131 
132 
133  var d = new DetectionResponse<Face>();
134  try {
135  //Only detect faces if it was requested.
136  if (detect) using (var detector =ConfigureDetection(s.settings)) d.features = detector.DetectFeatures(s.sourceBitmap);
137  } catch (TypeInitializationException e) {
138  throw e;
139  } catch (Exception e) {
140  d.message = e.Message;
141  }
142  d.PopulateFrom(s);
143  throw d.GetResponseException(s.settings["callback"]);
144  }
ResizeSettings settings
The commands to apply to the bitmap
Definition: ImageState.cs:25
Bitmap sourceBitmap
The source bitmap. If null, skip drawing commands, but continue layout logic.
Definition: ImageState.cs:66

The documentation for this class was generated from the following file: