feat: add setClampedValue and setClampedValueByIndex (#443)

Author: EscapedGibbon

src/Image.ts

@@ -431,6 +431,24 @@ export class Image {
     this.data[(row * this.width + column) * this.channels + channel] = value;
   }
 
+  /**
+   * Set the value of a specific pixel channel. Select pixel using coordinates.
+   * If the value is out of range it is set to the closest extremety.
+   * @param column - Column index.
+   * @param row - Row index.
+   * @param channel - Channel index.
+   * @param value - Value to set.
+   */
+  public setClampedValue(
+    column: number,
+    row: number,
+    channel: number,
+    value: number,
+  ): void {
+    if (value < 0) value = 0;
+    else if (value > this.maxValue) value = this.maxValue;
+    this.data[(row * this.width + column) * this.channels + channel] = value;
+  }
   /**
    * Get the value of a specific pixel channel. Select pixel using index.
    * @param index - Index of the pixel.
@@ -450,6 +468,23 @@ export class Image {
     this.data[index * this.channels + channel] = value;
   }
 
+  /**
+   * Set the value of a specific pixel channel. Select pixel using index.
+   * If the value is out of range it is set to the closest extremety.
+   * @param index - Index of the pixel.
+   * @param channel - Channel index.
+   * @param value - Value to set.
+   */
+  public setClampedValueByIndex(
+    index: number,
+    channel: number,
+    value: number,
+  ): void {
+    if (value < 0) value = 0;
+    else if (value > this.maxValue) value = this.maxValue;
+    this.data[index * this.channels + channel] = value;
+  }
+
   /**
    * Get the value of a specific pixel channel. Select pixel using a point.
    * @param point - Coordinates of the desired pixel.

src/__tests__/Image.test.ts

@@ -155,6 +155,21 @@ describe('get and set pixels', () => {
     img.setValueByPoint(point, 0, 50);
     expect(img.getValueByPoint(point, 0)).toBe(50);
   });
+  it('should set clamped value', () => {
+    const img = new Image(10, 20);
+    img.setClampedValue(15, 0, 0, -50);
+    expect(img.getValue(15, 0, 0)).toBe(0);
+    img.setClampedValue(15, 0, 0, 99999);
+    expect(img.getValue(15, 0, 0)).toBe(img.maxValue);
+  });
+  it('should set clamped value by index', () => {
+    const img = new Image(10, 20);
+    expect(img.getValueByIndex(15, 0)).toBe(0);
+    img.setClampedValueByIndex(15, 0, -50);
+    expect(img.getValueByIndex(15, 0)).toBe(0);
+    img.setClampedValueByIndex(15, 0, 999999);
+    expect(img.getValueByIndex(15, 0)).toBe(img.maxValue);
+  });
 });
 
 test('createFrom', () => {