sdfitsin.pro

NRAO GBTIDL
Produced by IDL 7.1.1
Developer Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./guide
sdfitsin.pro

Last modification date:: Wed Sep 28 13:27:13 2016

SDFITSIN

function SDFITSIN([filename], [/directory], [/continuum], [/new_index])

Create a new io_sdfits object and associate the indicated filename with it. If filename is a directory, the io_sdfits::set_project method is used and hence the contents of all sdfits files in that directory will be accessible through this single io object.

Returns: io_sdfits (line or cntm) object on success or -1 on failure
Version: $Id$

Parameters

filename
in, optional
string . If the filename is not suppled, a graphical file chooser will be launched to allow the user to select one.

Keywords

directory
in, optional
boolean . If this keyword exists and filename was omitted, then the file chooser is launched allowing the user to select a directory, otherwise a single, regular file must be selected.

continuum
in, optional
boolean . If this keyword exists then a continuum io_sdfits object will be returned. Otherwise (the default), a line io_sdfits object will be returned.

new_index
in, optional
boolean When set,, a new index is generated, whether it needed to be or not. By default, the io code tries to re-use an existing index unless it is seen to be out of date. Regenerating the index file can take some time, but no information should be lost in the process. Usually, the io code can trusted to regenerate the index file only when necessary.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:20 2016

Parameters
filename in, optional string	. If the filename is not suppled, a graphical file chooser will be launched to allow the user to select one.

Keywords
directory in, optional boolean	. If this keyword exists and filename was omitted, then the file chooser is launched allowing the user to select a directory, otherwise a single, regular file must be selected.
continuum in, optional boolean	. If this keyword exists then a continuum io_sdfits object will be returned. Otherwise (the default), a line io_sdfits object will be returned.
new_index in, optional boolean	When set,, a new index is generated, whether it needed to be or not. By default, the io code tries to re-use an existing index unless it is seen to be out of date. Regenerating the index file can take some time, but no information should be lost in the process. Usually, the io code can trusted to regenerate the index file only when necessary.