Basics
Size - CreateSize_CreateFromInts
Constructs a new Size object with specified width and height.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Width. |
| InHeight | Int | Height. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSize | Size | The Size instance. |
| Error | ErrorState | Gets the execution error message |
Size - Deserialize
De-serialize a Size buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSize | Size | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Size - Serialize
Serializes the object.
IN
| Name | Type | Description |
|---|---|---|
| InSize | Size | The input Size |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |
ShapeRegion - Align
Aligns the ShapeRegion using the provided alignment.
IN
| Name | Type | Description |
|---|---|---|
| InShapeRegion | ShapeRegion | The input ShapeRegion |
| InAlignment | UCS2D | New coordinate system. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutShapeRegion | ShapeRegion | Aligned ShapeRegion. |
| Error | ErrorState | Gets the execution error message |
Range - CreateRange_CreateFromLength
Constructs a new Range object, with specified start and length.
IN
| Name | Type | Description |
|---|---|---|
| InStart | Int | Start. |
| InLength | Int | Length. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRange | Range | The Range instance. |
| Error | ErrorState | Gets the execution error message |
Range - Deserialize
De-serialize a Range buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRange | Range | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Range - GetEnd
Returns the end of the range.
IN
| Name | Type | Description |
|---|---|---|
| InRange | Range | The input Range |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | End. |
| Error | ErrorState | Gets the execution error message |
Range - Serialize
Serializes the object.
IN
| Name | Type | Description |
|---|---|---|
| InRange | Range | The input Range |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |
Path - SetSize
Sets the path's size.
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InSize | Int | The size to set. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The modified Core.Data.Types.Path |
| Error | ErrorState | Gets the execution error message |
IO - DecodeFromBase64
Decode a Base64 encoded string into a buffer.
IN
| Name | Type | Description |
|---|---|---|
| InString | String | Base64 encoded string. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Corresponding buffer. |
| Error | ErrorState | Gets the execution error message |
IO - EncodeToBase64
Encode a buffer into a Base64 encoded string.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutString | String | Base64 encoded string. |
| Error | ErrorState | Gets the execution error message |
IO - Read
Loads data from a file into a buffer.
IN
| Name | Type | Description |
|---|---|---|
| InFilename | PathFile | Name of the file. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer that stores the data. |
| Error | ErrorState | Gets the execution error message |
IO - Write
Writes data from a buffer into a file.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the data. |
| InFilename | PathFile | Name of the file. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Interval - CreateInterval_CreateFromRange
Constructs a new Interval object, from begin to end.
IN
| Name | Type | Description |
|---|---|---|
| InBegin | Float | Begin value. |
| InEnd | Float | End value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInterval | Interval | The Interval instance. |
| Error | ErrorState | Gets the execution error message |
Interval - Deserialize
De-serialize an Interval buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInterval | Interval | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Interval - GetCenter
Returns the center of the interval.
IN
| Name | Type | Description |
|---|---|---|
| InInterval | Interval | The input Interval |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Center of the interval. |
| Error | ErrorState | Gets the execution error message |
Interval - GetWidth
Returns the width of the interval. The value is either 0 or positive.
IN
| Name | Type | Description |
|---|---|---|
| InInterval | Interval | The input Interval |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Width of the interval. |
| Error | ErrorState | Gets the execution error message |
Interval - Serialize
Serializes the object.
IN
| Name | Type | Description |
|---|---|---|
| InInterval | Interval | The input Interval |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |
Image - CropFromBox
Crops an image using the given box.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRoi | Box | The box. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The cropped image. |
| Error | ErrorState | Gets the execution error message |