Simulate

Format

/1/Simulate/Autodigitize/*path

*path is the file that was uploaded to the server using Upload

Description

Return a estimation for the design stitches and a reduced color image(embroidery like) in base64 format.

Parameters

• Path - Is the file that was uploaded to the server using Upload
• Format - Format of the returned list. Valid values are "xml" or "json". Default is "xml".
• FinalWidth - Width in pixels for resizing the image before color reduction. The width also participates in stitches estimation calculation. If value is empty, physical image width is taken as default.
  • FinalWidth will take effect only if original image width is greater than height. The resizing is done proportionally.
• FinalHeight - Height in pixels for resizing the image before color reduction. The height also participates in stitches estimation calculation. If value is empty, physical image height is taken as default.
  • FinalHeight will take effect only if original image height is greater than width. The resizing is done proportionally.
• NumColors - Maximum number of colors which will be used for color reduction process. If there is no value then it will be decided by the process.
• Density - Valid values : Low, Medium, High. Desnity of stitches that participates in stitches estimation calculation. Default is "Low".
• BackgroundColor - True/False value that specifies which colour in the image - except for the trasparent - is considered to be the background. Default is false. This setting works independently of the GenerateTransparentBackground.
• BackgroundRed - 0-255 value for Red for the BackgroundColor. Value should be set when BackgroundColor is true. Default is 0.
• BackgroundGreen - 0-255 value for Green for the BackgroundColor. Value should be set when BackgroundColor is true. Default is 0.
• BackgroundBlue - 0-255 value for Blue for the BackgroundColor. Value should be set when BackgroundColor is true. Default is 0.

Example

/1/Simulate/PulseLogoVerticalHQ.PNG

Sample Output

<?xml version="1.0"?>
<SimulateResponse>
  <StitchesEstimation>17642</StitchesEstimation>
  <Preview>
    iVBORw0KGgoAAAANSUhEUgAABVkAAAhpCAYAAAATyW0nAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAALiMAAC4jAXilP3YAAP+lSURBVHhe7PtdrmvZtkQNUQtekSgUojzUjDrxDDJSoCC+1seIOb32X57+ELpuzRHdO7288uS2dP9P//f/1//l/5f/8//t//H//sTdZrPZbDabzWaz2Ww2m81ms9ls5vz/gb5k/b/+P/6f/9/sF66bzWaz2Ww2m81ms9lsNpvNZnPO/x/kl6z6otWd9zebzWaz2Ww2m81ms9lsNpvN5n89/weRX7J+MrncbjabzWaz2Ww2m81ms9lsNpvN/1r+D4K+VP1w4/LWZrPZbDabzWaz2Ww2m81ms9n81/N/EPoC1b88Pbn04ry72Ww2m81ms9lsNpvNZrPZbDb/xfwfhH9hmqEvVCfn/vM4X2ez2Ww2m81ms9lsNpvNZrPZbP4LQelfluqLUjlninbeTUevudlsNpvNZrPZbDabzWaz2Ww2/2JQ3r4sFcs5n0K3PqE/w2az2Ww2m81ms9lsNpvNZrPZ/AtBmV+E0hejU+dpcvth+jNtNpvNZrPZbDabzWaz2Ww2m83fGJT+hSd9CfqNc6bkjv58m81ms9lsNpvNZrPZbDabzWbztwTlJ9OXnnLJU88ddZr4hv6sm81ms9lsNpvNZrPZbDabzWbzp4Lyk+lLTvFPO+c2nx392TebzWaz2Ww2m81ms9lsNpvN5ncF5Sf5ZaZz6z78tnfjydE/y2az2Ww2m81ms9lsNpvNZrPZ/KqgVPILTE/zxaice+rI53PE034K/XNtNpvNZrPZbDabzWaz2Ww2m81PBaWiLyr15SZ96elMbtqlp558crOj0D/jZrPZbDabzWaz2Ww2m81ms9l8E5QKfZlJTiznPGW6lXvi1jlT6J95s9lsNpvNZrPZbDabzWaz2WyeBKVy+zJTTE78JLSdnDO5Zpcdeg82m81ms9lsNpvNZrPZbDabzeYUlB76UtK/mEyX7D3nNnQveQr1iKdb9H5sNpvNZrPZbDabzWaz2Ww2m40Hpef2paS4deLJNdHOt+Tkk28dch+m92ez2Ww2m81ms9lsNpvNZrPZ/G8Hpaf9AvLmxG3PO22mW3kvmVyzo
    ...
    ...
    ...
    /drs9lsNpvNZrPZbDabzWaz2fxvBaWHvlxMbt2H3/Zol5luuxdnN5ncbUfv32az2Ww2m81ms9lsNpvNZrP5bwdlpv0C0vknnPtkOWcKdaZbrXMmpx29l5vNZrPZbDabzWaz2Ww2m83mvxWUGX1pmF8kOk+hXePkk8klp2uinW/pFjn5ZHdien83m81ms9lsNpvNZrPZbDabzb8blBl9QUhfGoqnUGdy7sXZTSbX7m7RHd+Sk09uHL3fm81ms9lsNpvNZrPZbDabzebfCUpKfkEovjl5Z8q0cyemnjO5dtckb4nJid0nu6P3frPZbDabzWaz2Ww2m81ms9n8vUFJ0ReC+jJQPDn5ZHfiKdTR1p9LPjlnctRpMr1ec486cvSz2Gw2m81ms9lsNpvNZrPZbDZ
  </Preview>
</SimulateResponse>

---