border - add a constant-valued border to a field

Name

    border - add a constant-valued border to a field

Summary

    Name    border

Type

  Filter

Inputs

   input -     field REQUIRED

Outputs

   output -     field

Parameters

    Name        Type    Default    Choices
    Border Value    typein_real     0.00     0.00     0.00
    Dim 1 Lower    typein_integer    0    0    UNBOUND
    Dim 1 Upper    typein_integer    0    0    UNBOUND
    ...
    Dim 20 Lower    typein_integer    0    0    UNBOUND
    Dim 20 Upper    typein_integer    0    0    UNBOUND

Description

    Changes the size of a field by adding a constant-valued border around
    the field's edge.  The data of the interior (non-border) of the output
    field is copied from the input field.  The widths of the borders can
    be varied independently.  The user also specifies a constant for the
    data values of the border.  This value is copied to all vector
    elements of the border.
    The coordinates of the interior (non-border) are copied from the input
    field.  Those of the border depend on the coordinate arrangement of
    the input field:
    UNIFORM field coordinates are extended uniformly into the border, i.e.
    the coordinate spacing of the border is the same as that of the
    interior and hence the same as that of the input field.
    The coordinate spacing in the border of RECTILINEAR fields is obtained
    from the spacing of the input field's lower/upper elements, i.e. for
    the ith axis of coordinate-space the lower/upper coordinate spacing is
    as follows:
        spacing[i] = coord[i][1]-coord[i][0]                     (lower), 
        spacing[i] = coord[i][dims[i] - 1]-coord[i][dims[i] - 2] (upper), 
    where dims = output->dimensions.
    IRREGULAR field border coordinates are all 0.
INPUTS
    input - field
        The input data may be any AVS field (up to 20-dimensional) of any
        data type, vector-length or coordinate type.
PARAMETERS
    Border Value (typein_real)
        The constant value to assign to data elements in the border.
    Dim n (1..20) Lower (typein_integer)
        The width of the lower border for the nth dimension.
    Dim n (1..20) Upper (typein_integer)
        The width of the upper border for the nth dimension.
OUTPUTS
    output - field
        The output field has the same dimensionality, data-type,
        vector-length and coordinate type as the input.

Example networks

    The following example network reads an image, adds a border to it and
    then displays it:
       read image
              |
           border
              |
    display image

Related modules

    crop

Author

    Chris Pudney (cpudney@alphapharm.pharm.uwa.edu.au)
    Biomedical Confocal Microscopy Research Centre
    Department of Pharmacology
    The University of Western Australia
    Nedlands, Western AUSTRALIA, 6907.