diff options
Diffstat (limited to 'noao/imred/vtel/doc')
23 files changed, 1343 insertions, 0 deletions
diff --git a/noao/imred/vtel/doc/destreak.hlp b/noao/imred/vtel/doc/destreak.hlp new file mode 100644 index 00000000..ef05d905 --- /dev/null +++ b/noao/imred/vtel/doc/destreak.hlp @@ -0,0 +1,50 @@ +.help destreak Dec84 noao.imred.vtel +.ih +NAME +destreak -- Remove streaks from Helium 10830 grams +.ih +USAGE +destreak input_image output_image +.ih +PARAMETERS +.ls input_image +Image to be destreaked. +.le +.ls output_image +Name to give destreaked output image (must be a separate image). +.le +.ls tempim +Temporary image used for pixel storage between destreak passes. +.le +.ls verbose=no +Flag to signal program that it should produce verbose output. +.le +.ls threshold = 4 +Squibby brightness threshold to use in determining limb points. +.le +.ih +DESCRIPTION +The helium 10830 grams as taken by the vacuum telescope have horizontal +streaks caused by the detecting apparatus. Destreak removes these streaks +and the limb darkening +using a two pass procedure. First, for each diode, a function of the form +'a + b*r**4', where r is the radius from disk center and a, b are parameters, +is fit to the intensity distribution and is then subtracted from the data. +Then a spatial filter is applied to the result and the final image is +written to disk. The full disk images are 2048 x 2048 and are taken using +a 512 diode array which is scanned from west to east across the solar disk +4 times. Thus, data from a particular diode consists of four lines of the +image. +.ih +EXAMPLES +1. To destreak "image1", put the output in "image2", put the temporary image in +"temp2", and see verbose output, the command would be: + +.nf + vt> destreak image1 image2 temp2 v+ +.fi + +.ih +SEE ALSO +readvt, writevt, quickfit, getsqib, putsqib +.endhelp diff --git a/noao/imred/vtel/doc/destreak5.hlp b/noao/imred/vtel/doc/destreak5.hlp new file mode 100644 index 00000000..8bf383fa --- /dev/null +++ b/noao/imred/vtel/doc/destreak5.hlp @@ -0,0 +1,43 @@ +.help destreak5 Dec85 noao.imred.vtel +.ih +NAME +destreak5 -- First pass of 10830 processing +.ih +USAGE +destreak5 input_root output_root +.ih +PARAMETERS +.ls input_root +Root name for input files. +.le +.ls output_root +Root name of output files. +.le +.ih +DESCRIPTION +Destreak5 takes as input the 5 files from a vacuum telescope 10830 +tape and produces 5 nearly identical files but with the streaks +removed from the solar images and with the best fit ellipse parameters +added to the image header. The input files are expected to be in the +directory 'imdir' and to have the extensions '001' thru '005'. These +input files are expected to be mag tape images produced by T2D. The output +files are stored in the current directory with the same extensions. +Destreak5 calls 'readvt','quickfit', 'destreak', and various other utilities +and is a cl script file. +If an input image is not found, the processing for that image is skipped and +a message is printed telling about the missing image. +The next step in the 10830 reduction process is 'makehelium' which produces +the projected daily grams. +.ih +EXAMPLES +1. To destreak five files with root name m1585 and store the resulting images +with root name M1585 the command would be: + +.nf + vt> destreak5 m1585 M1585 +.fi + +.ih +SEE ALSO +readvt, destreak, quickfit +.endhelp diff --git a/noao/imred/vtel/doc/dicoplot.hlp b/noao/imred/vtel/doc/dicoplot.hlp new file mode 100644 index 00000000..5bb9f071 --- /dev/null +++ b/noao/imred/vtel/doc/dicoplot.hlp @@ -0,0 +1,36 @@ +.help dicoplot Dec84 noao.imred.vtel +.ih +NAME +dicoplot -- Make plots of Carrington maps on the Dicomed +.ih +USAGE +dicoplot input_image1 input_image2 rot_number +.ih +PARAMETERS +.ls input_image1 +First image to plot on the output. +.le +.ls input_image2 +Second image to plot on the output. +.le +.ls rot_number +Carrington rotation number. +.le +.ih +DESCRIPTION +Dicoplot produces plots on the Dicomed. +.ih +EXAMPLES +1. To make a plot containing a 10830 gram and the associated weight gram where +the carrington rotation number is 1841, the 10830 gram is "temp1", +and the weight gram is "carweight" type: + +.nf + vt> dicoplot temp1 carweight 1841 +.fi + +The program gets information about the dates and longitudes from the image +headers. +.ih +SEE ALSO +.endhelp diff --git a/noao/imred/vtel/doc/fitslogr.hlp b/noao/imred/vtel/doc/fitslogr.hlp new file mode 100644 index 00000000..4a195e45 --- /dev/null +++ b/noao/imred/vtel/doc/fitslogr.hlp @@ -0,0 +1,58 @@ +.help fitslogr Dec85 noao.imred.vtel +.ih +NAME +fitslogr -- Make a log of header information from a fits tape +.ih +USAGE +fitslogr input_dev out_file startfnum endfnum +.ih +PARAMETERS +.ls input_dev +Tape drive, e.g. "mta1600" or just "mta" +.le +.ls out_file +Name of output file to store information. Information is appended to this +file to allow one to update a previously created file. +.le +.ls startfnum +Tape file to start logging. +.le +.ls endfnum +Tape file to stop logging. +.le +.ih +DESCRIPTION +Fitslogr reads FITS headers from successive tape files and compiles +certain information into a single line of output for each file. +Currently, the information output for each file includes: + + Tape file number, IRAF image name, date, time, and the + Carrington longitude for each image. + +If all of these header parameters are not present, only the ones found +will be printed out and garbage will come out for the empty parameters. +The date is stored in a header parameter called OBS_DATE, the time is +stored as 'seconds since midnight' in OBS_TIME and the Carrington +longitude is stored in L_ZERO. +To use this script, both the DATAIO package and the VTEL package must +be loaded. +.ih +EXAMPLES +1. To log all of the FITS images on a tape mounted on 'mta' and store the +information in a file called 'CX052' the command would be: + +.nf + vt> fitslogr mta CX052 1 999 +.fi + +2. To log just the 40th through 60th files on mtb and see the output on +your terminal, the command would be: + +.nf + vt> fitslogr mtb STDOUT 40 60 +.fi + +.ih +SEE ALSO +rfits +.endhelp diff --git a/noao/imred/vtel/doc/getsqib.hlp b/noao/imred/vtel/doc/getsqib.hlp new file mode 100644 index 00000000..1bf24fb0 --- /dev/null +++ b/noao/imred/vtel/doc/getsqib.hlp @@ -0,0 +1,33 @@ +.help getsqib Jan85 noao.imred.vtel +.ih +NAME +getsqib -- Extract a full disk squibby brightness image from a full disk image +.ih +USAGE +getsqib inputimage outputimage +.ih +PARAMETERS +.ls inputimage +Name of image to get squibby brightness from. +.le +.ls outputimage +Name of new output squibby brightness image. +.le +.ih +DESCRIPTION +Getsqib takes as input any full disk image and extracts the lower four bits +from each pixel and stores this information in a new output image the same +size as the input image. +.ih +EXAMPLES +1. To extract the squibby brightness image from the image "test1" and store +it in an image called "test1.sqib" the command would be: + +.nf + vt> getsqib test1 test1.sqib +.fi + +.ih +SEE ALSO +putsqib +.endhelp diff --git a/noao/imred/vtel/doc/makehelium.hlp b/noao/imred/vtel/doc/makehelium.hlp new file mode 100644 index 00000000..df27430c --- /dev/null +++ b/noao/imred/vtel/doc/makehelium.hlp @@ -0,0 +1,38 @@ +.help makehelium Jan86 noao.imred.vtel +.ih +NAME +makehelium -- Second pass of 10830 processing +.ih +USAGE +makehelium input_root output_root +.ih +PARAMETERS +.ls input_root +Root name for input files. +.le +.ls output_root +Root name of output files. +.le +.ih +DESCRIPTION +Makehelium takes the files output by 'destreak5' and projects them the +small [180x180] maps. The input files are expected to be in the current +directory and have the extensions '1' thru '5'. The output files are +stored in the current directory with the extensions 'a1', 'a2', 'a3', 'b1', etc. +This coding scheme is the same as that used in makeimages. Note that the +absolute value images for 10830 grams should be thrown out since they are +garbage. +Makehelium calls 'rmap' and 'imdelete' and is a cl script file. +.ih +EXAMPLES +1. To run makehelium on five files with root name m1585 and store the resulting +images with root name M1585 the command would be: + +.nf + vt> makehelium m1585 M1585 +.fi + +.ih +SEE ALSO +rmap +.endhelp diff --git a/noao/imred/vtel/doc/makeimages.hlp b/noao/imred/vtel/doc/makeimages.hlp new file mode 100644 index 00000000..d5f5fe31 --- /dev/null +++ b/noao/imred/vtel/doc/makeimages.hlp @@ -0,0 +1,64 @@ +.help makeimages Jan86 noao.imred.vtel +.ih +NAME +makeimages -- Magnetogram batch processing script +.ih +USAGE +makeimages input_root output_root +.ih +PARAMETERS +.ls input_root +Root name for input files. +.le +.ls output_root +Root name of output files. +.le +.ih +DESCRIPTION +Makeimages processes 5 magnetograms from raw data tape images into projected +small [180x180] maps. The input images are expected be output from T2D, +be in the current imdir, and have the extensions '001' through '005'. +The output files are stored in the current directory with the extensions +'a1', 'a2', 'a3', 'b1', etc. The output image coding scheme is the following: + +.nf + On the filename extensions the first character is a letter + corresponding to the tape file position. + a = first file on tape + b = second + . + . + e = fifth + + The second character specifies which type of image this is. + 1 = data + 2 = absolute value + 3 = weights +.fi + +Note: A logical directory called "scratch" must be set up before this +program is run. This logical directory must point to the directory +containing the input images. This can be set up as in the following +example: + +vt> set scratch = "scr1:[recely]" + +where this particular directory is a VAX/VMS type name. If the image +files are in the user's home directory then "scratch" can be set to +"home". + +Makeimages calls 'readvt', 'quickfit', 'rmap', +'delete', and 'imdelete' and is a cl script. +.ih +EXAMPLES +1. To process five magnetograms with root name m1585 and produce output images +with the root name M1585, the command would be. + +.nf + vt> makeimages m1585 M1585 +.fi + +.ih +SEE ALSO +readvt, quickfit, rmap, delete, imdelete +.endhelp diff --git a/noao/imred/vtel/doc/merge.hlp b/noao/imred/vtel/doc/merge.hlp new file mode 100644 index 00000000..24dbb778 --- /dev/null +++ b/noao/imred/vtel/doc/merge.hlp @@ -0,0 +1,90 @@ +.help merge Dec84 noao.imred.vtel +.ih +NAME +merge -- Merge together daily synoptic grams into a complete Carrington map +.ih +USAGE +merge outimage outweight outabs outratio month day year +.ih +PARAMETERS +.ls outimage +Name of output image. +.le +.ls outweight +Output image containing weights, number of pixels per pixel. +.le +.ls outabs +Output image containing the sums of the absolute values of the flux. +Not used when merging 10830 maps. +.le +.ls outratio +Output image containing the ratio of outimage/outabs. +Not used when merging 10830 maps. +.le +.ls month, day, year +Date of the center of this Carrington rotation. +.le +.ls longout = 180 +Longitude of the center of this Carrington rotation. +.le +.ls mergelist = "mergelist" +File containing list of files to be merged. +.le +.ih +DESCRIPTION +Merge adds up daily synoptic grams to produce a Carrington rotation map. +the input images are 180x180 and the output images are 360x180. The input +images are read from the file mergelist. Merge then weights the input +image as cos**4 in x where the center of the image corresponds to zero angle +and the left and right edges of the image correspond to -90 and +90 degrees +respectively. The input image consists of an unweighted "data" image, +a weight image, and an absolute value image. The summing is done on the +"data" image, on the weight image, and on the absolute value image +separately to produce three output images. Finally the "data" image is +divided by the absolute value image to produce a 4th output image. +If 10830 data is being merged there are only two(2) images per day, the +"data" image and the "weight" image. Also there are only two(2) output images, +the "data" merged image and the "weights" merged image. +A note about the mergelist file, the three grams for each day must be stored +in the following sequence (data, absolute value, weight) for magnetograms +and the two grams for each day must be stored as (data, weight) for 10830. +The filenames must be one file name per line in the mergelist and files +for different days must be grouped together, for example mergelist might look +like: + +.nf + MAG01 MAG01 + MAG01a MAG01w + MAG01w for magnetograms or MAG02 for 10830 grams + MAG02 MAG02w + MAG02a + MAG02w +.fi + +for merging only two days of data where the first day is MAG01 and the second +is MAG02. The 'a' extension stands for absolute value and the 'w' for weights. +.ih +EXAMPLES +1. To merge a number of images on disk into output images called "im", +"imweight", "imabs", and "imratio", where the date corresponding to the +center of the Carrington map is 3/20/84 the command would be (magnetograms): + +.nf + vt> merge im imweight imabs imratio 3 20 84 +.fi + +The same command used for 10830 grams would be: + +.nf + vt> merge im imweight 3 20 84 +.fi + +2. If you have the list of files to be merged listed in a file called "mlist" +instead of "mergelist" the command would be modified to read: + +.nf + vt> merge im imweight 3 20 84 mergelist="mlist" +.fi +.ih +SEE ALSO +.endhelp diff --git a/noao/imred/vtel/doc/mrotlogr.hlp b/noao/imred/vtel/doc/mrotlogr.hlp new file mode 100644 index 00000000..f86dbc0e --- /dev/null +++ b/noao/imred/vtel/doc/mrotlogr.hlp @@ -0,0 +1,63 @@ +.help mrotlogr Jul86 "noao.imred.vtel" +.ih +NAME +mrotlogr -- Make a log of header information from a fits tape (Carrington maps). +.ih +USAGE +mrotlogr input_dev out_file startfnum endfnum append +.ih +PARAMETERS +.ls input_dev +Tape drive, e.g. "mta1600" or just "mta" +.le +.ls out_file +Name of output file to store information. Information is appended to this +file to allow one to update a previously created file. +.le +.ls startfnum +Tape file to start logging. +.le +.ls endfnum +Tape file to stop logging. +.le +.ls append +Flag to signal that we are appending to an existing file. +.le +.ih +DESCRIPTION +Mrotlogr reads FITS headers from successive tape files and compiles +certain information into a single line of output for each file. +Currently, the information output for each file includes: + +.nf + Tape file number, IRAF image name, date, time, and the + Carrington longitude for each image. +.fi + +If all of these header parameters are not present, only the ones found +will be printed out and garbage will come out for the empty parameters. +The date is stored in a header parameter called OBS_DATE, the time is +stored as 'seconds since midnight' in OBS_TIME and the Carrington +longitude is stored in L_ZERO. +To use this script, both the DATAIO package and the VTEL package must +be loaded. +.ih +EXAMPLES +1. To log all of the FITS images on a tape mounted on 'mta' and store the +information in a file called 'CX052' the command would be: + +.nf + vt> mrotlogr mta CX052 1 999 no +.fi + +2. To log just the 40th through 60th files on mtb and see the output on +your terminal, the command would be: + +.nf + vt> mrotlogr mtb STDOUT 40 60 no +.fi + +.ih +SEE ALSO +rfits +.endhelp diff --git a/noao/imred/vtel/doc/mscan.hlp b/noao/imred/vtel/doc/mscan.hlp new file mode 100644 index 00000000..d6b7f46b --- /dev/null +++ b/noao/imred/vtel/doc/mscan.hlp @@ -0,0 +1,86 @@ +.help mscan May88 noao.imred.vtel +.ih +NAME +mscan -- Read sector scans from tape into IRAF images +.ih +USAGE +mscan input +.ih +PARAMETERS +.ls input +File template or device, e.g. "junk" or "s*" or "mta1600[1]" or "mtb800" +.le +.ls files +List of tape file numbers or ranges delimited by commas, e.g. "1-3,5-8". +`Files' is requested only if no file number is given in `input' and the +input is tape. +Files will be read in ascending order, regardless of the order of the list. +Reading will terminate if EOT is reached, thus a list such as "1-999" +may be used to read all the files on the tape. +.le +.ls verbose = yes +Flag to signal program that it should produce verbose output. This means +header information. +.le +.ls makeimage = yes +Flag to signal the program that it should make images. If this parameter +is set to no, the header will be read and decoded but no data will be read +and no image will be produced on disk. +.le +.ls brief = yes +Flag to make mscan produce brief filenames for the output images. These +filenames have the form [svb]nnn e.g. s034 or b122. The b is for a brightness +image, the v is for a velocity image, and the s is for a select image. The +'nnn' is the tape sequence number or the filenumber in a template expansion. +If this flag is set to false the long filenames described below in the +"Description" section will be produced. +.le +.ls select = yes +Flag to tell the program to make a select image. +.le +.ls bright = yes +Flag to tell the program to make a brightness image. +.le +.ls velocity = yes +Flag to tell the program to make a velocity image. +.le +.ih +DESCRIPTION +Mscan reads all or selected area scans from a vacuum telescope tape +and formats the data into multiple IRAF images. Type 1, 2, and 3 area +scans can produce 3 output images and type 4 produces one output image. +The long image names are assembled in the following way: +.nf + + The first letter is one of [bsv] for brightness, select, or velocity. + The next two digits are the day of the month. + Underbar. + The next 4 digits are the hour and minute. + Underbar. + Finally there is a three digit tape sequence number. + ie. + + b13_1709_002 +.fi + +.ih +EXAMPLES +1. To read files 5-7 from mta at 1600 bpi, the command would be: + +.nf + vt> mscan mta1600 5-7 +.fi + +2. To see the header information only for file 6, one could use the command: + +.nf + vt> mscan mta1600[6] make- +.fi + +3. To read file 4 from mta and only produce a velocity image: + +.nf + vt> mscan mta[4] bri- sel- +.fi + +.endhelp diff --git a/noao/imred/vtel/doc/pimtext.hlp b/noao/imred/vtel/doc/pimtext.hlp new file mode 100644 index 00000000..e78fdc8d --- /dev/null +++ b/noao/imred/vtel/doc/pimtext.hlp @@ -0,0 +1,110 @@ +.help pimtext May86 noao.imred.vtel +.ih +NAME +pimtext -- Put image text. Use pixel font to write text into image. +.ih +USAGE +pimtext iraf_files +.ih +PARAMETERS +.ls iraf_files +Image or images to be written into. This entry may contain wild cards and +will be expanded into however many files match the wild card. +.le +.ls refim +Reference image to pull date and time parameters from in the event the "ref" +flag is set. +.le +.ls ref +Reference flag. When set, causes the program to take information (date/time) +from the reference image and write it into the image or images expanded from +the template "iraf_images". +.le +.ls x = 10 +X position (column) in image to write text. +.le +.ls y = 10 +Y position (line) in image to write text. +.le +.ls xmag = 2 +Factor by which to magnify the text in the x direction. This must be an +integer. The pixelfont is expanded by pixel replication. The font width +at xmag=1 is 6. +.le +.ls ymag = 2 +Factor by which to magnify the text in the y direction. This must be an +integer. The pixelfont is expanded by pixel replication. The font width +at ymag=1 is 7. +.le +.ls val = -10000 +Value to put in text pixels. +.le +.ls setbgnd = yes +Boolean parameter to signal the program to fill in the area behind the +characters with pixels set to bgndval. +.le +.ls bgndval = 10000 +Pixel value to use to fill in background in text block. +.le +.ls date = yes +Flag that instructs the program to look for the date in the +image header and write it into the image. If the date and time +flags are both set, both will be written into the image as a single +string. +.le +.ls time = yes +Flag that instructs the program to look for the time in the +image header and write it into the image. +.le +.ls text +Text string to write into image. +.le +.ih +DESCRIPTION +Pimtext writes either the date and/or time or the indicated text string into +the image or images specified. +Pimtext, by default, writes the date and/or time into the image in the lower +left corner. If it cannot find the date or time pimtext will give a warning +and read a text string from the users terminal. If the date and time flags are +set to 'no', pimtext will take the text string to be written from the user. +The position of the text may be adjusted by setting +the parameters 'x' and 'y' which set the lower left pixel of +the text block. The pixels in the text block behind the characters may +be set to a particular value when the 'setbgnd' flag is set. The pixel +values used to write the text and the background can be set by adjusting +the parameters 'val' and 'bgndval'. If the text overlaps the image +edge in the X direction it will be truncated. If it overlaps in Y it will +not be written. +The user may magnify the text by adjusting the "xmag" and "ymag" parameters. +The default (2,2) is a nice size for display in a 512 by 512 image. Bigger +images may need bigger text, smaller images may need smaller text. +The "ref" flag is used to write information from one image into another +image. + +.ih +EXAMPLES +1. To write the date and time into the three images s13_1709_001, v13_1709_001, +and b13_1709_001 (assuming the directory contains only these three images) +the command would be: + +.nf + vt> pimtext ?13* +.fi + +2. To write the text string "hello world" into the image 'testim' the command +would be + +.nf + vt> pimtext testim 'hello world' date=no time=no +.fi + +3. To write the date and time into the images s1, s2, s3, s4 and position +the text at pixel 30,30, and turn off the text background fill, the command +would be: + +.nf + vt> pimtext s* x=30 y=30 setbgnd=no +.fi +.ih +SEE ALSO +.endhelp diff --git a/noao/imred/vtel/doc/putsqib.hlp b/noao/imred/vtel/doc/putsqib.hlp new file mode 100644 index 00000000..f6400cfe --- /dev/null +++ b/noao/imred/vtel/doc/putsqib.hlp @@ -0,0 +1,38 @@ +.help putsqib Jan85 noao.imred.vtel +.ih +NAME +putsqib -- Merge a full disk image with a squibby brightness image +.ih +USAGE +putsqib inputimage sqibimage outputimage +.ih +PARAMETERS +.ls inputimage +Name of data image to merge with squibby brightness image. +.le +.ls sqibimage +Name of squibby brightness image to merge with data image. +.le +.ls outputimage +Name of new, merged, output image. +.le +.ih +DESCRIPTION +Putsqib accepts as input a data image and a squibby brightness image. It +multiplies each pixel in the input data image by 16 and adds the associated +pixel from the squibby brightness input image. The pixel is then written +to the new, output image. +.ih +EXAMPLES +1. To merge a data image called 'data' and a squibby brightness image called +'sqib' and store the result in an image called 'complete', the command +would be: + +.nf + vt> putsqib data sqib complete +.fi + +.ih +SEE ALSO +getsqib +.endhelp diff --git a/noao/imred/vtel/doc/quickfit.hlp b/noao/imred/vtel/doc/quickfit.hlp new file mode 100644 index 00000000..41621b6d --- /dev/null +++ b/noao/imred/vtel/doc/quickfit.hlp @@ -0,0 +1,59 @@ +.help quickfit Dec84 noao.imred.vtel +.ih +NAME +quickfit -- Fit an ellipse to the limb for a full disk scan +.ih +USAGE +quickfit image +.ih +PARAMETERS +.ls image +Name of image to be fit. +.le +.ls threshold = 4 +Squibby brightness threshold to use in determining limb points. +.le +.ls xguess = 1024 +X coordinate of center of first guess circle. +.le +.ls yguess = 1024 +Y coordinate of center of first guess circle. +.le +.ls halfwidth = 50 +Halfwidth of window centered on previous limb point to search through +for a limb point on the current line. +.le +.ls rowspace = 20 +Number of rows to skip between limbpoints near center in y. +.le +.ls rejectcoeff = .02 +Least squares rejection coefficient. If radius of a limbpoint is more than +this far from the limb, where limbradius = 1.0, it is not used in the fit. +.le +.ih +DESCRIPTION +Quickfit finds the least squares best fit ellipse to the limb in a full +disk scan. Quickfit returns the ellipse parameters (x,y coordinates of +the ellipse center and the x and y semidiameters), the number of limbpoints +found, the number of limbpoints rejected, and the fraction of limb +points rejected by the least squares routine. This 'fraction rejected' +allows the user to determine to some extent the goodness of the data and +allows him or her to rerun Quickfit with different parameters to take +this goodness into account. Quickfit also returns the sub-earth latitude +and longitude when in verbose mode. The ellipse and ephemeris parameters +are stored in the image header for future reference. +.ih +EXAMPLES +1. To find the best fit ellipse for the limb in an image called "image1" and to +see verbose output, one would use the following command: + +.nf + vt> quickfit image1 v+ +.fi + +This will also use the default values of rowspace, halfwidth, +and rejectcoeff. + +.ih +SEE ALSO +.endhelp diff --git a/noao/imred/vtel/doc/readvt.hlp b/noao/imred/vtel/doc/readvt.hlp new file mode 100644 index 00000000..b9d6abe7 --- /dev/null +++ b/noao/imred/vtel/doc/readvt.hlp @@ -0,0 +1,86 @@ +.help readvt May87 noao.imred.vtel +.ih +NAME +readvt -- Read vacuum telescope full disk grams +.ih +USAGE +readvt input_fd files output_image +.ih +PARAMETERS +.ls input_fd +File or device template, e.g. "mta1600[1]" or "mtb800" or "junk" or "s*" +.le +.ls files +List of tape file numbers or ranges delimited by commas, e.g. "1-3,5-8". +`Files' is requested only if no file number is given in `input'. +Files will be read in ascending order, regardless of the order of the list. +Reading will terminate if EOT is reached, thus a list such as "1-999" +may be used to read all the files on the tape. +.le +.ls output_image template +Name to give output image. If the input file template is not a magtape +specification then this can be an IRAF filename template to be +expanded into a list of files. If the number of files in the input +template and in the output template do not match and if the output +template expands to one filename then that filename is used as a +root name to which filenumbers are appended for each input file. +i.e. "junk" becomes "junk001", "junk002", etc. If the input template +is a magtape without a filenumber attached, i.e. "mta", the +output name is used as a root name and the file number is appended +for each file read. +.le +.ls verbose = no +Flag to signal program that it should produce verbose output. This includes +header information and progress reports. +.le +.ls headeronly = no +Flag to signal the program that it should only print out header information +and quit without reading the data. The 'verbose' flag must be set to yes +to use this flag since otherwise the header information will not be printed. +This flag is used to look at headers on the tape to check dates, times +and observation types. +.le +.ls robust = no +Flag to signal program that it should ignore a wrong observation type in the +image header. +.le +.ih +DESCRIPTION +Readvt reads any one of the grams on a vacuum telescope tape and puts the +data into an IRAF image. The IRAF image is 2048x2048 short integers. +.ih +EXAMPLES +1. To read the second image from mta at 1600 bpi, store the image into "image1" +and see verbose output the command would be: + +.nf + vt> readvt mta1600[2] image1 v+ +.fi + +2. To look at the header information of the 4th file on a tape which is on +mtb and which was written at 1600 bpi, the command would be: + +.nf + vt> readvt mtb1600[4] v+ h+ +.fi + +3. To read the disk files "s001", "s002", "s003", "s004" and put the output +images into the files "s001i", "s002i", "s003i", "s004i" without +verbose output (assuming no other file in the directory starts with "s") +the command would be: + +.nf + vt> readvt s* s*//i +.fi + +4. To read the first five files on mta and put the output images into files +images with root name HHH the command would be: + +.nf + vt> readvt mta 1-5 HHH +.fi + +.ih +SEE ALSO +writevt +.endhelp diff --git a/noao/imred/vtel/doc/rmap.hlp b/noao/imred/vtel/doc/rmap.hlp new file mode 100644 index 00000000..e4b4a645 --- /dev/null +++ b/noao/imred/vtel/doc/rmap.hlp @@ -0,0 +1,47 @@ +.help rmap Dec84 noao.imred.vtel +.ih +NAME +rmap -- Project a full disk gram into a 180x180 flat image +.ih +USAGE +rmap inputimage outputimage outweight outabs +.ih +PARAMETERS +.ls inputimage +Name of image to be projected. +.le +.ls outputimage +Name to give output data image. +.le +.ls outweight +Name to give output weight image. +.le +.ls outabs +Name to give output absolute value image. +.le +.ih +DESCRIPTION +Rmap accepts as input a full disk carrington gram in a 2048x2048 IRAF image +and projects it into a 180x180 IRAF image such that the lines of longitude +and latitude are straight lines. The output is the data image, the weight +image (which is the count of the number of pixels of the input image which +were summed to produce the single output pixel), and the absolute value image +which is the same as the data image except that the absolute value of each +input pixel is taken before being summed into the output pixel. +Rmap calculates the mean field, the mean of the absolute value of the field, +and the number of pixels in the original gram used to make the projection. +These three parameters are stored in the output "data" image header as +MEAN_FLD, MEANAFLD, and NUMPIX respectively. +.ih +EXAMPLES +1. To project an image called "im10830" and produce output images "im10830.d", +"im10830.w", and "im10830.a", one would use the following command: + +.nf + vt> rmap im10830 im10830.d im10830.w im10830.a +.fi + +.ih +SEE ALSO +readvt, quickfit, and merge. +.endhelp diff --git a/noao/imred/vtel/doc/syndico.hlp b/noao/imred/vtel/doc/syndico.hlp new file mode 100644 index 00000000..25b4b0ee --- /dev/null +++ b/noao/imred/vtel/doc/syndico.hlp @@ -0,0 +1,77 @@ +.help syndico May89 noao.imred.vtel +.ih +NAME +syndico -- Make dicomed plots of full disk images (18 centimeters in diameter) +.ih +USAGE +syndico image +.ih +PARAMETERS +.ls image +Image to plot on the dicomed. +.le +.ls logofile = iraf$noao/imred/vtel/nsolcrypt.dat +File containing the text encoded NSO logo image. +.le +.ls device = dicomed +Device on which to plot the image. +.le +.ls sbthresh = 2 +Squibby brightness threshold used to determine the limb for trimming. +.le +.ls plotlogo = yes +Flag indicating whether or not to plot the logo. +.le +.ls verbose = yes +Flag indicating to the program that it should give progress reports. +.le +.ls forcetype = no +Flag to override the wavelength designation from the image header. +.le +.ls magnetic = yes +If 'forcetype' = 'yes' then this flag designates that we should force +to magnetic (8688). If set to 'no' the type is forced to 10830. +The effect of forcing the type is to choose which lookup table to +use when scaling the image. +.le +.ls month +Month the observation was taken (January = 1,,,December = 12). +.le +.ls day +Day of the month the observation was taken. +.le +.ls year +Year the observation was taken (two digits only, ie. 89 for 1989). +.le +.ls hour +Hour of the day the observation was taken (universal time, 1-24). +.le +.ls minute +Minute the observation was taken (0-59). +.le +.ls second +Second the observation was taken (0-59). +.le +.ih +DESCRIPTION +Syndico produces full disk plots on the Dicomed. The ephemeris data +is used to estimate the radius of the image and the center of the +disk is gotten from the image header. Using this data, an image is +made that is as close to 18 centimeters in diameter as possible. +There are two greyscale lookup tables corresponding to the two types +of image normally used, the magnetogram and the spectroheliogram. +If the wavelength is something other than 8688 or 10830, a linear +greyscale is used. + +The National Solar Observatory (tentative) logo is read from an encoded +text file and put on the plot if requested (default). +.ih +EXAMPLES + +.nf + vt> syndico image1 +.fi + +.ih +SEE ALSO +.endhelp diff --git a/noao/imred/vtel/doc/tcopy.hlp b/noao/imred/vtel/doc/tcopy.hlp new file mode 100644 index 00000000..57a523cb --- /dev/null +++ b/noao/imred/vtel/doc/tcopy.hlp @@ -0,0 +1,56 @@ +.help tcopy Oct85 noao.imred.vtel +.ih +NAME +tcopy -- Tape to tape copy +.ih +USAGE +tcopy input_fd output_fd +.ih +PARAMETERS +.ls input_fd +Tape file or device name for input, e.g. "mta1600[1]" or "mtb800" +.le +.ls files +List of tape file numbers or ranges delimited by commas, e.g. "1-3,5-8". +`Files' is requested only if no file number is given in `input_fd'. +Files will be read in ascending order, reguardless of the order of the list. +Reading will terminate if EOT is reached, thus a list such as "1-999" +may be used to read all the files on the tape. +.le +.ls output_fd +File or device name, e.g. "mta1600[1]" or "mtb800" If a file number is not +given the user will be asked whether or not this is a new tape. If it is +a new tape the file number "1" will be used. If it is not a new tape, i.e. +it already has data on it, then file number "EOT" will be used. +.le +.ls new_tape = no +New tape flag. Usage is described above. +.le +.ls verbose = no +Flag to signal program that it should print information about progress while +running. +.le +.ih +DESCRIPTION +Tcopy copies files from one tape to another reporting read errors on the +input tape as it goes. Tcopy, when it encounters a read error, does its +best to get as much data as possible by validating the input buffer after +the error, guessing its length, and writing it out to the output tape. +.ih +EXAMPLES +1. To copy all the files on mta to a new tape on mtb: + +.nf + vt> tcopy mta 1-999 mtb yes +.fi + +2. To copy file 5 from mta and append it to the tape on mtb: + +.nf + vt> tcopy mta1600[5] mtb no +.fi + +.ih +SEE ALSO +t2d +.endhelp diff --git a/noao/imred/vtel/doc/trim.hlp b/noao/imred/vtel/doc/trim.hlp new file mode 100644 index 00000000..9962db80 --- /dev/null +++ b/noao/imred/vtel/doc/trim.hlp @@ -0,0 +1,33 @@ +.help trim Jan85 noao.imred.vtel +.ih +NAME +trim -- Trim the limb. Zero all pixels off the limb in a full disk image +.ih +USAGE +trim inputimage threshold +.ih +PARAMETERS +.ls inputimage +Name of data image to trim. +.le +.ls threshold +Squibby brightness value to use as a threshold in determining the limb. +.le +.ih +DESCRIPTION +Trim scans all the pixels in an image and sets those pixels to zero that +contain a squibby brightness smaller than the threshold value. This is +done in place, that is, the input image gets modified. +.ih +EXAMPLES +1. To trim a data image called 'data' with a squibby brightness threshold +of 4 (the standard value) the command would be: + +.nf + vt> trim data 4 +.fi + +.ih +SEE ALSO +getsqib, putsqib +.endhelp diff --git a/noao/imred/vtel/doc/unwrap.hlp b/noao/imred/vtel/doc/unwrap.hlp new file mode 100644 index 00000000..67fad069 --- /dev/null +++ b/noao/imred/vtel/doc/unwrap.hlp @@ -0,0 +1,95 @@ +.help unwrap May87 noao.imred.vtel +.ih +NAME +unwrap -- Filter an IRAF image; remove binary wrap-around. +.ih +USAGE +unwrap listin listout +.ih +PARAMETERS +.ls listin +List of images to unwrap, this is an IRAF template. +.le +.ls listout +List of output images, this is an IRAF template. If the output list +is the same as the input list, the unwrapping is done in-place. +.le +.ls threshold1 = 128 +Data jump threshold for first unwrap pass. +.le +.ls wrapval1 = 256 +Factor to multiply wrap value by for first unwrap pass. +.le +.ls threshold2 = 128 +Data jump threshold for second unwrap pass. +.le +.ls wrapval2 = 256 +Factor to multiply wrap value by for second unwrap pass. +.le +.ls cstart = 2 +Column of image to start unwrapping. Columns are numbered from left to right. +.le +.ls step = 5 +Number of steps (1-5) to perform on image (unwrap1, difference, unwrap2, +reconstruct, fixlines). +.le +.ls verbose = yes +If set, program produces progress reports, etc. +.le +.ih +DESCRIPTION +Unwrap checks for binary wraparound in IRAF images. +The algorithm consists of reading the image line by line, unwrapping +each line, and writing the line out to another image. The procedure +for unwraping is a five step process. +.ls Step one: unwrap1 +Unwrapping is accomplished by scanning the data line and looking for +large jumps in the data values. Large negative jumps are interpreted +as data wrapping and large positive jumps are interpreted as data unwrapping. +The program keeps track of the number of wraps, each data element in the +array has wrapval1 * wrapnumber added. This effectively unwraps an image +in which the point to point variation in the data values is small compared +to the variation caused by a binary wrap. +.le +.ls Step two: difference +A difference image is produced from the above step one image by calculating +the pixel to pixel difference between all of the pixels in the line. The +first column of the image is generally left intact so that the image can +be reconstructed in a later step. Step one often produces streaks in the +image due to data variation large enough to mimic wrapping. This step +two difference image eliminates most of these streaks except for their +point of origin, where the confusion occured. +.le +.ls Step three: unwrap2 +This is the second unwrapping step. The image is unwrapped as in step +one using the second set of unwrap values (threshold2, wrapval2). +.le +.ls Step four: reconstruct +The original image is reconstructed from the step three image by +adding pixel values successively to line pixels. +.le +.ls Step five: fixlines +If bad lines (streaks) still can be found in the image, they are +eliminated by replacing the line by the average of the lines above +and below bad line. +.le +.ih +EXAMPLES +1. To unwrap an image called "continuum" and store the resulting image in +"unwrapped", and use the default parameters, the command might be: + +.nf + vt> unwrap continuum unwrapped +.fi + +2. To unwrap all the images in the directory starting with s1492 and store +the unwrapped images in s1492*u, to start in column 31, to do four steps, +and to see verbose output, the command might be: + +.nf + vt> unwrap s1494* s1492*//u cstart=31 step=4 v+ +.fi + +.ih +SEE ALSO +.endhelp diff --git a/noao/imred/vtel/doc/vtblink.hlp b/noao/imred/vtel/doc/vtblink.hlp new file mode 100644 index 00000000..0bb26779 --- /dev/null +++ b/noao/imred/vtel/doc/vtblink.hlp @@ -0,0 +1,53 @@ +.help vtblink Dec84 noao.imred.vtel +.ih +NAME +vtblink -- Blink daily grams to check registration +.ih +USAGE +vtblink +.ih +PARAMETERS +.ls imname1 +First image to be mapped. +.le +.ls imname2 +Subsequent images to be mapped +.le +.ls z1 = -3000.0 +Minimum grayscale intensity to be mapped during 'display'. +.le +.ls z2 = 3000.0 +Maximum grayscale intensity to be mapped during 'display'. +.le +.ih +DESCRIPTION +Vtblink allows the user to blink successive frames of data on the IIS. The +program calculates the offset between grams based on the +longitudes for each image. Vtblink will ask for each successive image +and will display it on the next (mod 4) IIS frame. +After each image is displayed the user is put back out in the cl so that he/she +can use any of the images$tv tasks to analyze the data. The user returns to +the blink program by typing 'bye' to the cl prompt. To exit the program the +user enters the "end" for the filename. Images are displayed with the grayscale +limits set by default to -3000.0 and 3000.0. These values correspond to the +parameters z1 and z2 which may be given on the command line. If the user +forgets which IIS frame contains which image, he/she can enter "stat" to the +"next image" prompt and will get a list of which images are in which frames. +.ih +EXAMPLES +1. To run vtblink with the default gray scale parameters just type: + +.nf + vt> vtblink +.fi + +2. To run vtblink with gray scale parameters z1=-4000.0, z2=4000.0, the +command would be: + +.nf + vt> vtblink z1=-4000.0 z2=4000.0 +.fi +.ih +SEE ALSO +display, blink, lumatch +.endhelp diff --git a/noao/imred/vtel/doc/vtexamine.hlp b/noao/imred/vtel/doc/vtexamine.hlp new file mode 100644 index 00000000..20bf13eb --- /dev/null +++ b/noao/imred/vtel/doc/vtexamine.hlp @@ -0,0 +1,50 @@ +.help vtexamine Jan86 noao.imred.vtel +.ih +NAME +vtexamine -- examine the headers and record structure of vacuum telescope files +.ih +USAGE +mtexamine tape_file +.ih +PARAMETERS +.ls tape_file +Tape file, e.g. "mta1600[2]" or "mta1600". +.le +.ls files +List of tape file numbers or +ranges delimited by commas, e.g. "1-3,5-8". +File_list is requested only if no file number is given in tape_file. +Files will be read in ascending order, regardless of the order of the list. +Reading +will terminate if EOT is reached, thus a list such as "1-999" +may be used to read all the files on the tape. +.le +.ls headers=yes +Decode and print header information from each file examined. +.le +.ih +DESCRIPTION +By default, vtexamine decodes and prints header and record +structure information for each file examined. The header +information can be turned off by setting headers=no. +.ih +EXAMPLES +1. To see the header information and determine the record structure of all the +files on a vacuum telescope tape and send the result to the file vtdump: + +.nf + vt> vtexamine mtb1600 1-999 > vtdump +.fi + +2. To just get the record structure for the third file on a vacuum telescope +tape the command would be: + +.nf + vt> vtexamine mtb1600[3] headers=no +.fi +.ih +BUGS +The IRAF magtape i/o routines do not permit data beyond a double EOF +to be accessed. Therefore vtexamine cannot be used to examine tapes with +embedded double EOFs. +.endhelp diff --git a/noao/imred/vtel/doc/writetape.hlp b/noao/imred/vtel/doc/writetape.hlp new file mode 100644 index 00000000..6159c016 --- /dev/null +++ b/noao/imred/vtel/doc/writetape.hlp @@ -0,0 +1,35 @@ +.help writetape Jan86 noao.imred.vtel +.ih +NAME +writetape -- Write 5 grams to tape in full disk format. (Used as +intermediate step in 10830 processing. +.ih +USAGE +writetape input_root tape_name +.ih +PARAMETERS +.ls getname +Root name for input files. +.le +.ls getmtape +Tape file descriptor. +.le +.ih +DESCRIPTION +Writetape takes as input five(5) full disk grams in IRAF image format +and writes them to tape in a format identical to the original full disk +grams produced on the vacuum telescope. The input image names are expected +to be the "input_root" name concatenated with the numbers "1", "2", ... "5". +Writetape calls 'writevt' and is a cl script file. +.ih +EXAMPLES +1. To write five files with root name m1585 to tape mta, the command would be: + +.nf + vt> writetape m1585 mta +.fi + +.ih +SEE ALSO +readvt, writevt +.endhelp diff --git a/noao/imred/vtel/doc/writevt.hlp b/noao/imred/vtel/doc/writevt.hlp new file mode 100644 index 00000000..3475a5c4 --- /dev/null +++ b/noao/imred/vtel/doc/writevt.hlp @@ -0,0 +1,43 @@ +.help writevt Dec84 noao.imred.vtel +.ih +NAME +writevt -- Write vacuum telescope full disk grams to tape +.ih +USAGE +writevt input_image output_fd +.ih +PARAMETERS +.ls input_image +Name of input image. +.le +.ls output_fd +File or device name, e.g. "mta1600[1]" or "mtb800" If a file number is not +given the user will be asked whether or not this is a new tape. If it is +a new tape the file number "1" will be used. If it is not a new tape, i.e. +it already has data on it, then file number "EOT" will be used. +.le +.ls verbose = no +Flag to signal program that it should produce verbose output. This includes +header information and progress reports. +.le +.ls new_tape = no +New tape flag. Usage is described above. +.le +.ih +DESCRIPTION +Writevt writes a full disk vacuum telescope gram in IRAF image format to tape. +The IRAF image is 2048x2048 short integers. The tape format is the same as +that used to write original data tapes on the mountain. +.ih +EXAMPLES +1. To write the image "image1" to mta at 1600 bpi at file number 3 and +see verbose output the command would be: + +.nf + vt> writevt image1 mta1600[3] v+ +.fi + +.ih +SEE ALSO +readvt +.endhelp |