tclVecChain.c
Interface between vectors and chains and regions, etc.
TCL SYNTAX:
vFromChain "<chain>" "<element>"
TCL HELP STRING:
Return a vector of the values of the element of a chain
RETURN: handle to the vector
TCL ARGUMENTS:
:
"<chain>" : The chain
"<element>" : The element
TCL SYNTAX:
vPlot "<pgstate>" "<vectorX>" "-vectorXErr" "<vectorY>" "-vectorYErr" "-vectorMask" "-vectorSymbol" "-vectorColor" "-xmin" "-xmax" "-ymin" "-ymax"
TCL HELP STRING:
Plot two vectors
TCL ARGUMENTS:
:
"<pgstate>" : pgstate to write on
"<vectorX>" : X vector
"-vectorXErr" : error on X
"<vectorY>" : Y vector
"-vectorYErr" : error on Y
"-vectorMask" : mask values, set to 1 for good points
"-vectorSymbol" : PGPLOT symbols
"-vectorColor" : PGPLOT colors
"-xmin" : minimum x of the plot
"-xmax" : maximum x of the plot
"-ymin" : minimum y of the plot
"-ymax" : maximum y of the plot
TCL SYNTAX:
vExtreme "<vector>" "<minORmax>" "-vMask"
TCL HELP STRING:
Return the extreme of the vector.
Set minORmax to either min or max.
TCL ARGUMENTS:
:
"<vector>" : The vector
"<minORmax>" : Return minimum or maximum?
"-vMask" : The mask
TCL SYNTAX:
vLimit "<vector>" "<minORmax>" "-vMask"
TCL HELP STRING:
Return the limit of the vector
(extreme and 10 percent buffer).
Set minORmax to either min or max.
TCL ARGUMENTS:
:
"<vector>" : The vector
"<minORmax>" : Return minimum or maximum?
"-vMask" : The mask
TCL SYNTAX:
vNameSet "<vector>" "<name>"
TCL HELP STRING:
Set the name of an vector.
TCL ARGUMENTS:
:
"<vector>" : VECTOR to name
"<name>" : Name to give the VECTOR
TCL SYNTAX:
vNameGet "<vector>"
TCL HELP STRING:
Get the name of a vector.
TCL ARGUMENTS:
:
"<vector>" : VECTOR to get name from
TCL SYNTAX:
vMean "<vector>" "-vMask"
TCL HELP STRING:
Calculate the mean of the values of a VECTOR.
TCL ARGUMENTS:
:
"<vector>" : VECTOR to print MEAN of
"-vMask" : The mask
TCL SYNTAX:
vSigma "<vector>" "-vMask"
TCL HELP STRING:
Calculate the sigma of the values of a VECTOR.
TCL ARGUMENTS:
:
"<vector>" : VECTOR to print SIGMA of
"-vMask" : The mask
TCL SYNTAX:
vMedian "<vector>" "-vMask"
TCL HELP STRING:
Return the median of the good values of the VECTOR.
TCL ARGUMENTS:
:
"<vector>" : VECTOR to median
"-vMask" : Corresponding mask values
TCL SYNTAX:
vSigmaClip "<vector>" "-sigmaClip" "-nIter" "-vMask"
TCL HELP STRING:
Return a keyed list of the mean and sqrtVar (== sigma)
of the values in the vector that are not masked by vMask,
rejecting those values more than sigmaClip*sigma
from the mean for nIter iterations.
TCL ARGUMENTS:
:
"<vector>" : Initial VECTOR
"-sigmaClip" : Clip value
"-nIter" : Number of iterations
"-vMask" : Vector mask
TCL SYNTAX:
vToChain "<vector>" "<chain>" "<member>"
TCL HELP STRING:
Put a vector in the values of member on the chain
TCL ARGUMENTS:
:
"<vector>" : Vector to use
"<chain>" : Chain to fill
"<member>" : Member of chain to hold vector
TCL SYNTAX:
hgNewFromV "<vector>" "-name" "-min" "-max" "-vMask" "-vWeight"
TCL HELP STRING:
Create a new HG and fill it with the values in vector.
Set min>max for auto scaling. Use only the points in
vMask that are set to 1.
TCL ARGUMENTS:
:
"<vector>" : Vector to fill hg from
"-name" : The name for the HG
"-min" : Low edge of first bin
"-max" : High edge of last bin
"-vMask" :
"-vWeight" :
TCL SYNTAX:
hgFillFromV "<hg>" "<vector>" "-vMask"
TCL ARGUMENTS:
:
"<hg>" : HG to fill
"<vector>" : VECTOR to use for filling the HG
"-vMask" :