deepstack-custom-model.html

<script type="text/javascript">
    RED.nodes.registerType('deepstack-custom-model',{
        category: 'function',
        color: '#4682b4',
        defaults: {
            name: {value:""},
            server: {value:"", type:"deepstack-server"},
            confidence: {value: 80,required:true,validate:RED.validators.number()},
            customModel: {value:"",required:true,validate:RED.validators.regex(/.+/)},
            drawPredictions: {value: false},
            outlineColor: {value: 'pink'},
            custom: {value: ""},
            outputs: {value:1}
        },
        inputs:1,
        outputs:1,
        icon: "font-awesome/fa-flask",
        label: function() {
            return this.name||"Custom Model";
        },
        oneditprepare: function() {
            var node = this;
        
            if (! $("#node-input-drawPredictions").is(":checked")) {
                $("#row-outlineColor").hide();
                $("#row-printLabel").hide();
            }

            $("#node-input-drawPredictions").click(function() {
                $("#row-outlineColor").toggle(this.checked);
                $("#row-printLabel").toggle(this.checked);
            });
        }
    });
</script>

<script type="text/x-red" data-template-name="deepstack-custom-model">
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
        <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
    </div>
    <div class="form-row">
        <label for="node-input-server"><i class="icon-tag"></i> Deepstack server</label>
        <input type="text" id="node-input-server">
    </div>
    <div class="form-row">
        <label for="node-input-customModel"><i class="icon-tag"></i> Custom Model</label>
        <input type="text" id="node-input-customModel">
    </div>
    <hr />
    <div class="form-row">
        <label for="node-input-confidence"><i class="icon-tag"></i> Minimum Confidence (%)</label>
        <input type="text" id="node-input-confidence" size="5">
    </div>
    <div class="form-row">
        <input type="checkbox" id="node-input-drawPredictions" style="display: inline-block; width: auto; vertical-align: top;">
        <label for="node-input-drawPredictions" style="width: 90%;">Draw prediction outlines</label>
    </div>
    <div class="form-row" id="row-outlineColor" style="padding-left:10%;">
        <label for="node-input-outlineColor"><i class="icon-tag"></i> Outline color</label>
        <input type="text" id="node-input-outlineColor">
    </div>
    <div class="form-row" id="row-printLabel" style="padding-left:10%;">
        <input type="checkbox" id="node-input-printLabel" style="display: inline-block; width: auto; vertical-align: top;">
        <label for="node-input-printLabel" style="width: 90%;">Print prediction label</label>
    </div>
</script>

<script type="text/x-red" data-help-name="deepstack-custom-model">
    <p>A node to query the Deepstack Custom Model API.</p>
    <p>Before usage of this node, make sure the model is installed on your Deepstack server. See Deepstack <a href="https://docs.deepstack.cc/custom-models/index.html">docs on custom models</a> for deteails.</p>

    <h3>Inputs</h3>
    <p>The node takes one single input, the image to be processed.</p>

    <dl class="message-properties">
        <dt>payload
            <span class="property-type">buffer</span>
        </dt>
        <dd> the image buffer to process. </dd>
    </dl>

    <h3>Outputs</h3>
    <p>The output contains all predictions made by the Custom Model API.</p>

    <ol class="node-ports">
        <li>Standard output
            <dl class="message-properties">
                <dt>payload <span class="property-type">object</span></dt>
                <dd>Deepstack Detection predictions.</dd>
                <dt>success <span class="property-type">boolean</span></dt>
                <dd>Deepstack Detection status.</dd>
                <dt>originalImage <span class="property-type">buffer</span></dt>
                <dd>the image buffer processed.</dd>
                <dt>outlinedImage <span class="property-type">buffer</span></dt>
                <dd>the image buffer with rectangular outline around detected objects. Only if config option *drawPredictions* is true.</dd>
            </dl>
        </li>
    </ol>

    <h3>Details</h3>
    <p>Sends an image to the Deepstack Custom Model API and outputs the predictions.</p>

    <h3>References</h3>
    <ul>
        <li><a href="https://deepstack.cc/">Deepstack</a> - the service performing the actual magic.</li>
    </ul>
</script>