4.58 sddsinsideboundaries

• description: sddsinsideboundaries determines whether points in a two-dimensional space (x, y) are inside any of a series of closed boundaries (or contours).
• examples:
      sddsinsideboundaries <inputFile> <outputFile> -columns=Z,X -boundary=exclusionRegions.sdds,Z,X -keep=outside  
      

• synopsis:
      sddsinsideboundaries [<inputfile>] [<outputfile>] [-pipe=[input][,output]]  
        -columns=<x-name>,<y-name>  
        -boundary=<filename>,<x-name>,<y-name>  
        [-insideColumn=<columnName>]  
        [-keep={inside|outside}] [-threads=<number>]  
      

• switches:
  • -pipe[=input] — The standard SDDS Toolkit pipe option.
  • -columns=\emph{xName},\emph{yName} — Specifies the columns containing the x and y coordinates of the probe points.
  • -boundary=\emph{filename},\emph{xName},\emph{yName} — Specifies the file containing the x and y coordinates of the boundaries. Each boundary should form a closed curve (first and last point the same). Each boundary is on a separate page.
  • -insideColumn=\emph{columnName} — By default, the output file contains all the input data plus a new column called InsideSum, which gives the number of boundaries that enclose the point in question. This option allows changing the name of this column.
  • -keep={inside|outside} — By default, all input rows appear in the output file. If this option is given, the user may elect to keep only those rows that are inside at least one boundary or only those rows that are outside all boundaries.
  • -threads=\emph{number} — Specify the number of threads to use for computations. Defaults to 1. Using more threads tends to help more when there are many complex boundary contours and when the number of output points is a small fraction of the number of input points.
• files: The input file contains the columns defining the test points. By default, the output file will contain the same columns, but also an additional column indicating if each test point is inside any of the boundaries. The boundary file provides a series of closed boundaries, each on a separate page.
• author: M. Borland, ANL/APS.