$Id$

NeSDaC

mask, creating a two dimensional maskpattern


NAME

mask - Create a two dimensional maskpattern.

SYNOPSIS

The program can be started with no arguments at all, in which case the parameter values are taken from the parameterfile.
Alternatively, values can be passed via the commandline, the required items as command arguments, the optional ones as valued switches.

The table lists all the parameters used by mask, the second column lists the paramater key names used in the parameterfile, the first column gives the corresponding switch letter.

mask parameters
switchkeyvalueIOdescription
mskfile stringo mask pattern file .msk
config stringi mask pattern configuration string, syntax
esizex reali mask element length, x axis.
esizey reali mask element length, y axis.
eosizex reali length of transparent part of open mask element, x axis.
eosizey reali length of transparent part of open mask element, y axis.
pdebug inti only as first commandline argument: ignore parameterfile, set debuglevel. general
ititle stringi file title, description cq. comments. general
Llogfile stringi redirect diagnostic and informational messages. see general
mode "ql"i has meaning for (some) parameterfile parsers/readers only.

DESCRIPTION

mask creates a 2-dimensional pattern of transparent (1) and opaque (0) elements.
class
prN pseudorandom pattern, overall transparancy is N %. N can be either 25, 33 or 50 (integral N).
rN random pattern, overall transparancy is N % (real N).
tN test pattern (integral N)
N= 1 -> all elements opaque (0).
N= 2 -> all elements transparent (1).
N= 3 -> elements alternating, checker board pattern.
N= 4 -> horizontal, centered line of transparent elements.
N= 5 -> vertical, centered line of transparent elements.
N= 6 -> centered cross of transparent elements.
N= 7 -> one transparent element in center.
size
gives the number of elements along the x (nx) and y (ny) axis and optional repeat factors (rx, ry) for the mask pattern. if ny is not given, it defaults to the nx value (note. cf class pr50). the repeat factors default to 1, otherwise they give a repetition of the basic nx*ny patterns into an array of (rx.nx) by (ry.ny) elements.
fold
folding method to 2 dimensions, either linear or diagonal.
code
either simple or repeated.
shift
shift array before folding to 2D.
mirror
mirror 2D pattern.
rotate
rotate 2D pattern.

EXAMPLE

  mask -p "pr33,[256,256],my" 1.0 1.0 wfc.msk
produces a file 'wfc.msk', with the mask pattern as used in the SAX-WFC camera's.
  mask -p "pr50,[255,257],shift 18456,diag" 1.0 1.0 comis.msk
produces a file 'comis.msk', with the mask pattern as used in the TTM/COMIS-WFC camera.
  mask -p "r23.4,[200,200],mi x,ro 90" 1.0 1.0 ran.msk
produces a file 'ran.msk', a random pattern, overall tranparancy aproximately. 23.4 %, pattern is mirrored in the X-axis, then rotated through 90 deg.


mask pattern configuration string syntax
term expansion
config ::= class "," size [","fold] [","code] [","shift] [","mirror] [","rotate]
class ::= "pr25" | "pr33" | "pr50"["("int")"] | "r"real["("int")"] | "t"int
size ::= "[" int[,int[,int[,int]]] "]"
fold ::= ("diagonal" | "linear")
code ::= ("simple" | "repeated")
shift ::= "shift" int
mirror ::= "mirror" ("x"|"y"|"xy")
rotate ::= "rotate" 0|1|2|3

NOTE

SEE ALSO


Back to: