STScI Logo

aregpars astcat


NAME · USAGE · PARAMETERS · DESCRIPTION · EXAMPLES · TIME_REQUIREMENTS
BUGS · SEE_ALSO

NAME

aregpars -- edit the region extraction parameters

USAGE

aregpars

PARAMETERS

rcra = "00:00:00.0"
The right ascension / longitude of the center of the region to be extracted.
rcdec = "+00:00.00"
The declination / latitude of the center of the region to be extracted.
rrawidth = 10.0
The right ascension / longitude width in minutes of arc of the region to be extracted.
rdecwidth = 10.0
The declination / latitude width in minutes of arc of the region to be extracted.
rcsystem = ""
The input celestial coordinate system. This is the celestial coordinate system of the region center. If the input celestial coordinate system is undefined it defaults to the query celestial coordinate system. Popular options are "icrs", "j2000.0", and "b1950.0". The full set of options can be examined by typing "help ccsystems".
rcraunits = ""
The units of rcra. Permitted values are "hours", "degrees", and radians. If rcraunits is undefined it defaults to the preferred units of the input celestial coordinate system, e.g. hours for equatorial coordinate system, degrees for ecliptic, galactic, and super-galactic coordinate systems.
rcdecunits = ""
The units of rcdec. Permitted values are "degrees" and "radians". If rcdecunits is undefined it defaults to the preferred units of the input celestial coordinate system, e.g. degrees for all systems.

DESCRIPTION

The region to extracted from the selected astrometric catalog or image survey is defined by the aregpars parameters rcra , rcdec , rcrawidth , and rcdecwidth .

rcra and rcdec are defined in the input celestial coordinate system specified by rcsystem . If rcsystem is undefined it defaults to the query celestial coordinate system defined by the qsystem query parameter in the catalog configuration file.

rcra and rcdec are expressed in the units specified by rcraunits , and rcdecunits . If undefined rcraunits and rcdecunits are expressed in the preferred units of the input celestial coordinate system, e.g. hours and degrees for equatorial coordinate systems, and degrees and degrees for ecliptic, galactic, and super-galactic coordinate systems.

EXAMPLES

1. List the region extraction parameters.

cl> lpar aregpars

2. Edit the region extraction parameters.

cl> aregpars
... edit the parameters in the usual way
... type :wq to quit and save the edits

3. Edit the region extraction parameters from the agetcat task.

cl> epar agetcat
... edit the agetcat parameters
... move to the aregpars parameter line and type :e
... edit the aregpar parameters
... type :wq to quit and save the aregpars edits
... continue editing the remaining agetcat parameters
... type :go to execute the task

4. Save the current aregpars parameter values in a text file called areg1.par. Use the saved parameter set in the next call to the agetcat task.

cl> epar aregpars
... edit some parameters in the usual way
... type :w areg1.par 
... type :q to quit
cl> agetcat ... aregpars=areg1.par ...

TIME REQUIREMENTS

BUGS

SEE ALSO

agetcat, agetim, help ccsystems


Search Form · STSDAS