Produced by IDL 7.1.1
User Documentation

./guide
dirin.pro

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

dirin

procedure dirin[, dir_name], [/new_index]

Specify a directory from which data will be read. Compare to filein, which identifies a single file as the input source.

When dirin is used, data can be retrieved from any of the SDFITS files in that dir without the need to issue a new filein command.

In line mode, this sets the line input data directory, in continuum mode, this sets the continuum input data directory. Both directories can be opened at the same time and the mode (line or continuum) determines where data is retrieved from (e.g. get). Only one line and one continuum data source (single file or single directory) can be opened at the same time. Use of dirin or filein always first closes any previously opened line or continuum data source before opening a new one.

The opened input file or directory name is stored in !g.line_filein_name (line mode) or !g.cont_filein_name (continuum mode).

Examples
   dirin            ; Use a GUI to select the directory
   cont             ; switch to continuum mode
   dirin,'mydcr'    ; open up all FITS files in a specific directory
 
Uses
sdfitsin
Version
$Id$

Parameters
dir_name
in, optional
string
The directory name to use. If omitted, a file selector GUI will appear and you can select the directory to use. You must select a directory in that case. If the dir_name isn't a directory, the underlying code will recognize that and it will be as if you had used filein instead.

Keywords
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 be trusted to regenerate the index file only when necessary.


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