Macros Grouped in Hips Directory

Macros Grouped in Hips Directory

MACRO ARGUMENTS DESCRIPTION

Check_File_Existence filename Sets the script variable $file_exists based on the existence or non-existence of the named file. A warning is printed if the file does not exist.

Clobber bool Enable or disable overwriting of existing image files. In interactive use, the user is always prompted before overwriting (CHECK THIS). [fileio/clobber]

Close_Hips_File movie_file Used to close a file before the expected number of frames has been read or written. [fileio/close]

Close_Hips_Movie movie_file Closes the specified hips movie. [fileio/close]

File_Info filename Gives information about a specified image file. [fileio/info]

File_Seek filename, frameno [fileio/seek]

Filetype typename Sets the default file type. Valid types are: network, raw, hips1, hips2, sunraster, ppm, dis, vista, VL, rgb, disk, rv, and lumisys. [fileio/filetype]

Get_File data object, filename, filetype Reads the file with <filetype> and puts it into a data object with same filename.

Get_Hips data object, HIPS filename Reads the HIPS file with <filetype> and puts it into a data object with same filename.

Get_Hips2 data object, HIPS2 filename Reads the HIPS2 file with <filetype> and puts it into a data object with same filename.

Get_Next object, filename Reads the next frame from file into an image object.

Get_Rasterfile filename Reads the rasterfile and puts it into a usable data object with same filename.

Hips_Directory name [fileio/directory]

Import_Disk filename Automatically creates a dest. object with the same name as the original file.

Import_File filename Automatically creates a file object with the same name as the original file.

Import_Hips filename Automatically creates a hips object with the same name as the original file.

Import_Hips2 filename Automatically creates a hips2 object with the same name as the original file.

Import_Image filename Automatically creates an image object with the same name as the original file.

Import_VL filename Automatically creates a VL object with the same name as the original file.

Load_Hips data object, HIPS filename

Next_Frame data object Shows the next frame of a movie.

Put_Byte_Hips object, filename Reads the file and puts the information into an object with the same filename.

Put_Bytes float data object, HIPS filename

Put_File data object, filename Reads the file and puts the information into a data object with the same filename.

Put_Hips data object, HIPS filename Reads the HIPS file and puts the information into a data object with the same filename.

Put_Hips2 data object, HIPS2 filename Reads the HIPS2 file and puts the information into a data object with the same filename.

Put_Image data object, filename Reads the image file and puts the information into a data object with the same filename.

Put_Next object, filename Reads the next frame of the specified filename and puts the information into an object with the same filename. Same as Write_Next_File. [fileio/put]

Put_Next_Float image, moviefile, minval, maxval

Put_Raw object, filename Reads the raw file and puts the information into a data object with the same filename.

Put_Viff object, filename Reads the viff file and puts the information into a data object with the same filename.

Put_Vista data object, filename Reads the vista file and puts the information into a data object with the same filename.

Read_File_Header filename Reads the file header name for a user specified filename. Same as Open_Read_File. [fileio/read]

Read_Next_Frame object, filename Reads the next frame for a specified object and filename. Same as Get_Next. [fileio/get]

Read_Object_File objname, filename Reads the object file for the specified filename.

Start_Hips2_Movie filename, number of frames Starts the specifed hips2 movie file and plays for the specified number of frames.

Start_Hips_Movie filename, number of frames Starts the specifed hips movie file and plays for the specified number of frames.

Write_File_Header filename, nframes Same as Open_Write_File. [fileio/write]

Write_Next_Frame object, filename Reads the next frame of the specified filename and puts the information into an object. Same as Put_Next. [fileio/put]

MACRO	ARGUMENTS	DESCRIPTION
Check_File_Existence	filename	Sets the script variable $file_exists based on the existence or non-existence of the named file. A warning is printed if the file does not exist.
Clobber	bool	Enable or disable overwriting of existing image files. In interactive use, the user is always prompted before overwriting (CHECK THIS). [fileio/clobber]
Close_Hips_File	movie_file	Used to close a file before the expected number of frames has been read or written. [fileio/close]
Close_Hips_Movie	movie_file	Closes the specified hips movie. [fileio/close]
File_Info	filename	Gives information about a specified image file. [fileio/info]
File_Seek	filename, frameno	[fileio/seek]
Filetype	typename	Sets the default file type. Valid types are: network, raw, hips1, hips2, sunraster, ppm, dis, vista, VL, rgb, disk, rv, and lumisys. [fileio/filetype]
Get_File	data object, filename, filetype	Reads the file with <filetype> and puts it into a data object with same filename.
Get_Hips	data object, HIPS filename	Reads the HIPS file with <filetype> and puts it into a data object with same filename.
Get_Hips2	data object, HIPS2 filename	Reads the HIPS2 file with <filetype> and puts it into a data object with same filename.
Get_Next	object, filename	Reads the next frame from file into an image object.
Get_Rasterfile	filename	Reads the rasterfile and puts it into a usable data object with same filename.
Hips_Directory	name	[fileio/directory]
Import_Disk	filename	Automatically creates a dest. object with the same name as the original file.
Import_File	filename	Automatically creates a file object with the same name as the original file.
Import_Hips	filename	Automatically creates a hips object with the same name as the original file.
Import_Hips2	filename	Automatically creates a hips2 object with the same name as the original file.
Import_Image	filename	Automatically creates an image object with the same name as the original file.
Import_VL	filename	Automatically creates a VL object with the same name as the original file.
Load_Hips	data object, HIPS filename
Next_Frame	data object	Shows the next frame of a movie.
Put_Byte_Hips	object, filename	Reads the file and puts the information into an object with the same filename.
Put_Bytes	float data object, HIPS filename
Put_File	data object, filename	Reads the file and puts the information into a data object with the same filename.
Put_Hips	data object, HIPS filename	Reads the HIPS file and puts the information into a data object with the same filename.
Put_Hips2	data object, HIPS2 filename	Reads the HIPS2 file and puts the information into a data object with the same filename.
Put_Image	data object, filename	Reads the image file and puts the information into a data object with the same filename.
Put_Next	object, filename	Reads the next frame of the specified filename and puts the information into an object with the same filename. Same as Write_Next_File. [fileio/put]
Put_Next_Float	image, moviefile, minval, maxval
Put_Raw	object, filename	Reads the raw file and puts the information into a data object with the same filename.
Put_Viff	object, filename	Reads the viff file and puts the information into a data object with the same filename.
Put_Vista	data object, filename	Reads the vista file and puts the information into a data object with the same filename.
Read_File_Header	filename	Reads the file header name for a user specified filename. Same as Open_Read_File. [fileio/read]
Read_Next_Frame	object, filename	Reads the next frame for a specified object and filename. Same as Get_Next. [fileio/get]
Read_Object_File	objname, filename	Reads the object file for the specified filename.
Start_Hips2_Movie	filename, number of frames	Starts the specifed hips2 movie file and plays for the specified number of frames.
Start_Hips_Movie	filename, number of frames	Starts the specifed hips movie file and plays for the specified number of frames.
Write_File_Header	filename, nframes	Same as Open_Write_File. [fileio/write]
Write_Next_Frame	object, filename	Reads the next frame of the specified filename and puts the information into an object. Same as Put_Next. [fileio/put]