Title Page
|
VICAR Run Time Library - Contents
VICAR Run Time Library - Title Page
1. Introduction
1.1 Document Organization
1.2 Acronym List
1.3 Data Types and Host Representations
1.3.1 VICAR File Representations
1.4 Data Type Labels
1.5 Pixel Type Declarations
1.5.1 Pixel Sizes
1.6 Converting Data Types & Hosts
1.7 Using Binary Labels
1.7.1 Separate Host Types
1.7.2 Programming and Binary Labels
1.7.3 Binary Label Types
2. Programming Practice
2.1 General VICAR conventions
2.2 ANSI C
2.3 C Calling Sequence
2.3.1 C Data Types
2.4 FORTRAN Calling Sequence
2.4.1 Character Strings
2.4.2 FORTRAN Data Types
2.5 Include Files
2.6 Mixing FORTRAN and C
2.6.1 Bridge Routines
2.6.2 Naming Subroutines
2.6.3 Passing Numeric Arguments
2.6.4 Passing Strings
2.6.4.1 Accepting FORTRAN Strings in C
2.6.4.2 Accepting C Strings in FORTRAN
2.6.4.3 Machine Dependencies
2.7 Writing Portable FORTRAN
2.7.1 RTL Issues
2.7.2 No EQUIVALENCE for Type Conversion
2.7.3 CHARACTER*n for Strings
2.7.4 READ & WRITE to Strings
2.7.5 VMS FORTRAN Extensions
2.7.6 VMS-Specific Code
2.8 Portable TAE Command Language (TCL)
3. Image I/O
3.1 Introduction
3.1.1 Unix filename expansion
3.1.2 Temporary files
3.1.3 Filename Expansions
3.2 Image I/O API
3.2.1 x/zvadd—Add information to control block
3.2.2 x/zvclose—Close a file
3.2.3 x/zveaction—Set the default error handling action
3.2.4 x/zvget—Retrieve control block information
3.2.5 x/zvopen—Open a file
3.2.6 x/zvread—Read a line
3.2.7 x/zvsignal—Signal an error
3.2.8 x/zvunit—Assign a unit number to a file
3.2.9 x/zvwrit—Write an image line
4. Label I/O
4.1 Introduction
4.1.1 A Label Model
4.1.2 Property Labels
4.1.2.1 Using Property Labels
4.1.2.2 Property Instance Numbers
4.1.2.3 Property Names
4.2 Image Label Access API
4.2.1 x/zladd—Add information to an existing label item
4.2.2 x/zldel—Remove a label item
4.2.3 x/zlget—Return the value of a label item
4.2.4 x/zlhinfo—Return history label information
4.2.5 x/zlinfo—Return information about a single label item
4.2.6 x/zlninfo—Return name of next key
4.2.7 x/zlpinfo—Returns the names of property subsets in the given file
5. Parameter I/O
5.1 Introduction
5.2 Parameter I/O API
5.2.1 x/zvintract—Prompt user for interactive command
5.2.2 x/zviparm—Return interactive parameter values
5.2.3 x/zvip—Interactive version of x/zvp; abbreviated version of x/zviparm
5.2.4 x/zviparmd—Interactive version of x/zvparmd
5.2.5 x/zvipcnt—Return the count of a parameter.
5.2.6 x/zvipone—Interactive version of x/zvpone
5.2.7 x/zvipstat—Interactive version of x/zvpstat
5.2.8 x/zviptst—Interactive version of x/zvptst
5.2.9 x/zvp—Abbreviated version of x/zvparm
5.2.10 x/zvparm—Return a parameter value
5.2.11 x/zvparmd—Double-precision version of x/zvparm
5.2.12 x/zvpcnt—Return the count of a parameter.
5.2.13 x/zvpone—Single value from a multivalued parameter
5.2.14 x/zvpstat—Information about a parameter
5.2.15 x/zvptst Indicate whether key word was specified
5.3 Examples
6. Translation Routines
6.1 Introduction
6.2 Translation API
6.2.1 x/zvhost—Integer and real data representations of a host given the host type name
6.2.2 x/zvpixsize—Size of a pixel in bytes given the data type and host representation
6.2.3 x/zvpixsizeb—Size of a binary label value in bytes from a file
6.2.4 x/zvpixsizeu—Size of a pixel in bytes from a file
6.2.5 x/zvtrans—Translate pixels from one format to another
6.2.6 x/zvtrans_in—Create translation buffer for input
6.2.7 x/zvtrans_inb—Create translation buffer for input from binary labels of a file
6.2.8 x/zvtrans_inu—Create translation buffer for input from a file
6.2.9 x/zvtrans_out—Create translation buffer for output
6.2.10 x/zvtrans_set—Create translation buffer for data types only
7. FORTRAN String Conversion Routines
7.1 Introduction
7.1.1 Common Features: Rules and arguments common to all string routines
7.1.1.1 Include file
7.1.1.2 Imakefile
7.1.1.3 FORSTR_PARAM and FORSTR_DEF macros
7.1.1.4 Argument restrictions
7.1.1.5 Arguments to FORTRAN string conversion routines
7.2 String Conversion API
7.2.1 sc2for—C null-terminated string to an output FORTRAN string
7.2.2 sc2for_array—C null-terminated array of strings to FORTRAN string array
7.2.3 sfor2c—FORTRAN input string to a standard C null-terminated string
7.2.4 sfor2c_array—FORTRAN string array to C null-terminated array of strings
7.2.5 sfor2len—Length of a FORTRAN string
7.2.6 sfor2ptr—Pointer to actual characters in FORTRAN string
8. Utility Routines
8.1 Introduction
8.2 Utility API
8.2.1 abend/zabend—Terminate processing abnormally
8.2.2 x/zmove—Move bytes from one buffer to another
8.2.3 x/zvbands—Return band usage information
8.2.4 x/zvcmdout—Sends a command string to TAE to be executed
8.2.5 x/zvcommand—Execute a VICAR command string
8.2.6 x/zvfilename—Returns a filename suitable for use with a system open() call
8.2.7 x/zvfilpos—Return the current tape position
8.2.8 x/zvmessage—Log a user message
8.2.9 x/zvselpi—Selects the file to use as the primary input
8.2.10 x/zvselpiu—Selects the file to use as primary input
8.2.11 x/zvsize—Return image size values
9. Appendix A: Summary of Calling Sequences
10. Appendix B: Error Messages
10.1 Error message format
10.2 Messages by key
11. Appendix C: Deprecated and Obsolete Subroutines
11.1 qprint/zqprint—(Obsolete) Print a message to the terminal
11.2 vic1lab—(Obsolete) Return IBM VICAR72 byte labels in a buffer x/zvpblk—Return the address of the parameter block. FOR SPECIAL APPLICATIONS ONLY.
11.3 x/zlgetlabel—(Obsolete) Read labels into local memory
11.4 x/zvend—(Do Not Use) Terminate processing
11.5 x/zvpclose—Close parameter data set NOT RECOMMENDED
11.6 x/zvpopen—Open a parameter data set for output. NOT RECOMMENDED
11.7 x/zvpout—Write parameter to parameter file. NOT RECOMMENDED.
11.8 x/zvsfile—Skip files on a tape. USE x/zvadd INSTEAD.
11.9 x/zvsptr—String parameter processing subroutine.
11.10 x/zvtpinfo—Return tape drive information
11.11 x/zvtpmode—Indicate whether an image file is on tape
11.12 x/zvtpset—Set tape drive position globals
12. Apprendix D: Unavailable Optional Arguments
13. Appendix E: About This Document
13.1 Document Source
13.2 Generating HTML Version
13.3 Changing or Adding to this Document
13.3.1 Styles used in this Document
13.3.2 Formatting Hints and Kinks
Title Page
|