queries¶
-
vcs.queries.
graphicsmethodinfo
(obj)[source]¶ For a given graphic method returns a dictionary with information about it such as number of slabs expected, dimensions used for the plot etc…
-
vcs.queries.
graphicsmethodlist
()[source]¶ List available graphics methods.
- Example
>>> a=vcs.init() >>> vcs.graphicsmethodlist() # Return graphics method list [...]
- Returns
A list of available grapics methods (i.e., ‘boxfill’, ‘isofill’, ‘isoline’, ‘meshfill’, ‘scatter’, ‘vector’, ‘xvsy’, ‘xyvsy’, ‘yxvsx’, ‘taylordiagram’, ‘1d’, ‘3d_scalar’, ‘3d_dual_scalar’, ‘3d_vector’).
- Return type
-
vcs.queries.
graphicsmethodtype
(gobj)[source]¶ Check the type of a graphics object.
Returns None if the object is not a graphics method.
- Example
>>> a=vcs.init() >>> box=a.getboxfill() # Get default boxfill graphics method >>> iso=a.getisofill() # Get default isofill graphics method >>> ln=a.getline() # Get default line element >>> vcs.graphicsmethodtype(box) 'boxfill' >>> vcs.graphicsmethodtype(iso) 'isofill' >>> vcs.graphicsmethodtype(ln) Traceback (most recent call last): ... vcsError: The object passed is not a graphics method object.
- Returns
If gobj is a graphics method object, returns its type: ‘boxfill’, ‘isofill’, ‘isoline’, ‘meshfill’, ‘scatter’, ‘vector’, ‘xvsy’, ‘xyvsy’, ‘yxvsx’, ‘taylordiagram’, ‘1d’, ‘3d_scalar’, ‘3d_dual_scalar’, ‘3d_vector’. If gobj is not a graphics method object, raises an exception and prints a vcsError message.
- Return type
-
vcs.queries.
is1d
(obj)[source]¶ Check to see if this object is a VCS 1d graphics method.
- Example
>>> a=vcs.init() >>> a.show('1d') # available 1ds *******************1d Names List********************** ... *******************End 1d Names List********************** >>> ex = a.get1d('default') >>> vcs.queries.is1d(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a 1d graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
is3d_dual_scalar
(obj)[source]¶ Check to see if this object is a VCS 3d_dual_scalar graphics method.
- Example
>>> a=vcs.init() >>> a.show('3d_dual_scalar') # available 3d_dual_scalars *******************3d_dual_scalar Names List********************** ... *******************End 3d_dual_scalar Names List********************** >>> ex = a.get3d_dual_scalar() >>> vcs.queries.is3d_dual_scalar(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a 3d_dual_scalar graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
is3d_scalar
(obj)[source]¶ Check to see if this object is a VCS 3d_scalar graphics method.
- Example
>>> a=vcs.init() >>> a.show('3d_scalar') # available 3d_scalars *******************3d_scalar Names List********************** ... *******************End 3d_scalar Names List********************** >>> ex = a.get3d_scalar() >>> vcs.queries.is3d_scalar(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a 3d_scalar graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
is3d_vector
(obj)[source]¶ Check to see if this object is a VCS 3d_vector graphics method.
- Example
>>> a=vcs.init() >>> a.show('3d_vector') # available 3d_vectors *******************3d_vector Names List********************** ... *******************End 3d_vector Names List********************** >>> ex = a.get3d_vector() >>> vcs.queries.is3d_vector(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a 3d_vector graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isboxfill
(obj)[source]¶ Check to see if this object is a VCS boxfill graphics method.
- Example
>>> a=vcs.init() >>> a.show('boxfill') # available boxfills *******************Boxfill Names List********************** ... *******************End Boxfill Names List********************** >>> ex = a.getboxfill() >>> vcs.queries.isboxfill(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a boxfill graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
iscolormap
(obj)[source]¶ Check to see if this object is a VCS colormap secondary method.
- Example
>>> a=vcs.init() >>> a.show('colormap') # available colormaps *******************Colormap Names List********************** ... *******************End Colormap Names List********************** >>> ex = a.getcolormap() >>> vcs.queries.iscolormap(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a colormap secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
isdisplay
(obj)[source]¶ Check to see if this object is a VCS display object
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a display (1), or not (0).
- Return type
int
-
vcs.queries.
isfillarea
(obj)[source]¶ Check to see if this object is a VCS fillarea secondary method.
- Example
>>> a=vcs.init() >>> a.show('fillarea') # available fillareas *******************Fillarea Names List********************** ... *******************End Fillarea Names List********************** >>> ex = a.getfillarea() >>> vcs.queries.isfillarea(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a fillarea secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
isgraphicsmethod
(gobj)[source]¶ Indicates if the entered argument is one of the following graphics methods: boxfill, isofill, isoline, scatter, vector, xvsy, xyvsy, yxvsx.
- Example
>>> a=vcs.init() >>> box=a.getboxfill() # get default boxfill object >>> vcs.isgraphicsmethod(box) 1
- Parameters
gobj (A VCS graphics object) – A graphics object
- Returns
Integer reperesenting whether gobj is one of the above graphics methods. 1 indicates true, 0 indicates false.
- Return type
-
vcs.queries.
isisofill
(obj)[source]¶ Check to see if this object is a VCS isofill graphics method.
- Example
>>> a=vcs.init() >>> a.show('isofill') # available isofills *******************Isofill Names List********************** ... *******************End Isofill Names List********************** >>> ex = a.getisofill() >>> vcs.queries.isisofill(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a isofill graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isisoline
(obj)[source]¶ Check to see if this object is a VCS isoline graphics method.
- Example
>>> a=vcs.init() >>> a.show('isoline') # available isolines *******************Isoline Names List********************** ... *******************End Isoline Names List********************** >>> ex = a.getisoline() >>> vcs.queries.isisoline(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a isoline graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isline
(obj)[source]¶ Check to see if this object is a VCS line secondary method.
- Example
>>> a=vcs.init() >>> a.show('line') # available lines *******************Line Names List********************** ... *******************End Line Names List********************** >>> ex = a.getline() >>> vcs.queries.isline(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a line secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
ismarker
(obj)[source]¶ Check to see if this object is a VCS marker secondary method.
- Example
>>> a=vcs.init() >>> a.show('marker') # available markers *******************Marker Names List********************** ... *******************End Marker Names List********************** >>> ex = a.getmarker() >>> vcs.queries.ismarker(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a marker secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
ismeshfill
(obj)[source]¶ Check to see if this object is a VCS meshfill graphics method.
- Example
>>> a=vcs.init() >>> a.show('meshfill') # available meshfills *******************Meshfill Names List********************** ... *******************End Meshfill Names List********************** >>> ex = a.getmeshfill() >>> vcs.queries.ismeshfill(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a meshfill graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isplot
(pobj)[source]¶ Check to see if this object is a VCS secondary display plot.
- Example
>>> a=vcs.init() >>> array=[range(10) for _ in range(10)] >>> dsp=a.plot(array) # plotting should return a displayplot object >>> vcs.queries.isplot(dsp) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a display plot (1), or not (0).
- Return type
-
vcs.queries.
isprojection
(obj)[source]¶ Check to see if this object is a VCS projection graphics method.
- Example
>>> a=vcs.init() >>> a.show('projection') # available projections *******************Projection Names List********************** ... *******************End Projection Names List********************** >>> ex = a.getprojection() >>> vcs.queries.isprojection(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a projection graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isscatter
(obj)[source]¶ Check to see if this object is a VCS scatter graphics method.
- Example
>>> a=vcs.init() >>> a.show('scatter') # available scatters *******************Scatter Names List********************** ... *******************End Scatter Names List********************** >>> ex = a.getscatter('default_scatter_') >>> vcs.queries.isscatter(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a scatter graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
issecondaryobject
(sobj)[source]¶ Check to see if this object is a VCS secondary object
Note
Secondary objects will be one of the following:
- 1.) colormap: specification of combinations of 256 available
colors
2.) fill area: style, style index, and color index
- 3.) format: specifications for converting numbers to display
strings
4.) line: line type, width, and color index
5.) list: a sequence of pairs of numerical and character values
6.) marker: marker type, size, and color index
- 7.) text table: text font type, character spacing, expansion,
and color index
- 8.) text orientation: character height, angle, path, and
horizontal/vertical alignment
9.) projections
10.) displays
- Example
>>> a=vcs.init() >>> a.show('projection') # Show all available projections *******************Projection Names List********************** ... *******************End Projection Names List********************** >>> ex = a.getprojection('default') # To test an existing line object >>> vcs.issecondaryobject(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a projection graphics object (1), or not (0).
- Return type
-
vcs.queries.
isstreamline
(obj)[source]¶ Check to see if this object is a VCS streamline graphics method.
- Example
>>> a=vcs.init() >>> a.show('streamline') # available streamlines *******************Streamline Names List********************** ... *******************End Streamline Names List********************** >>> ex = a.getstreamline() >>> vcs.queries.isstreamline(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a streamline graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
istaylordiagram
(obj)[source]¶ Check to see if this object is a VCS taylordiagram graphics method.
- Example
>>> a=vcs.init() >>> a.show('taylordiagram') # available taylordiagrams *******************Taylordiagram Names List********************** ... *******************End Taylordiagram Names List********************** >>> ex = a.gettaylordiagram() >>> vcs.queries.istaylordiagram(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a taylordiagram graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
istemplate
(gobj)[source]¶ Check to see if this object is a VCS template graphics method.
- Example
>>> a=vcs.init() >>> a.show('template') # available templates *******************Template Names List********************** ... *******************End Template Names List********************** >>> ex = a.gettemplate() >>> vcs.queries.istemplate(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a template graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
istext
(obj)¶ Check to see if this object is a VCS textcombined secondary method.
- Example
>>> a=vcs.init() >>> try: # try to create a new textcombined, in case none exist ... tc = vcs.createtextcombined('EX_tt', 'qa', 'EX_tto', '7left') ... except: ... pass >>> a.show('textcombined') # available textcombineds *******************Textcombined Names List********************** ... *******************End Textcombined Names List********************** >>> ex = a.gettextcombined('EX_tt', 'EX_tto') >>> vcs.queries.istextcombined(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a textcombined secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
istextcombined
(obj)[source]¶ Check to see if this object is a VCS textcombined secondary method.
- Example
>>> a=vcs.init() >>> try: # try to create a new textcombined, in case none exist ... tc = vcs.createtextcombined('EX_tt', 'qa', 'EX_tto', '7left') ... except: ... pass >>> a.show('textcombined') # available textcombineds *******************Textcombined Names List********************** ... *******************End Textcombined Names List********************** >>> ex = a.gettextcombined('EX_tt', 'EX_tto') >>> vcs.queries.istextcombined(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a textcombined secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
istextorientation
(obj)[source]¶ Check to see if this object is a VCS textorientation secondary method.
- Example
>>> a=vcs.init() >>> a.show('textorientation') # available textorientations *******************Textorientation Names List********************** ... *******************End Textorientation Names List********************** >>> ex = a.gettextorientation() >>> vcs.queries.istextorientation(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a textorientation secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
istexttable
(obj)[source]¶ Check to see if this object is a VCS texttable secondary method.
- Example
>>> a=vcs.init() >>> a.show('texttable') # available texttables *******************Texttable Names List********************** ... *******************End Texttable Names List********************** >>> ex = a.gettexttable() >>> vcs.queries.istexttable(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a texttable secondary method (1), or not (0).
- Return type
int
-
vcs.queries.
isvector
(obj)[source]¶ Check to see if this object is a VCS 1d graphics method.
- Example
>>> a=vcs.init() >>> a.show('1d') # available 1ds *******************1d Names List********************** ... *******************End 1d Names List********************** >>> ex = a.get1d('default') >>> vcs.queries.is1d(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a 1d graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isxvsy
(obj)[source]¶ Check to see if this object is a VCS xvsy graphics method.
- Example
>>> a=vcs.init() >>> a.show('xvsy') # available xvsys *******************Xvsy Names List********************** ... *******************End Xvsy Names List********************** >>> ex = a.getxvsy() >>> vcs.queries.isxvsy(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a xvsy graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isxyvsy
(obj)[source]¶ Check to see if this object is a VCS xyvsy graphics method.
- Example
>>> a=vcs.init() >>> a.show('xyvsy') # available xyvsys *******************Xyvsy Names List********************** ... *******************End Xyvsy Names List********************** >>> ex = a.getxyvsy('default_xyvsy_') >>> vcs.queries.isxyvsy(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a xyvsy graphics method (1), or not (0).
- Return type
int
-
vcs.queries.
isyxvsx
(obj)[source]¶ Check to see if this object is a VCS yxvsx graphics method.
- Example
>>> a=vcs.init() >>> a.show('yxvsx') # available yxvsxs *******************Yxvsx Names List********************** ... *******************End Yxvsx Names List********************** >>> ex = a.getyxvsx() >>> vcs.queries.isyxvsx(ex) 1
- Parameters
obj (VCS Object) – A VCS object
- Returns
An integer indicating whether the object is a yxvsx graphics method (1), or not (0).
- Return type
int