Difference: CookBook2dfdr (1 vs. 2)

Revision 22007-01-12 - RonHeald

Line: 1 to 1
 

CookBook for AAOmega data reduction with 2dfdr

Changed:
<
<
AAOmega data is processed using an updated version of the 2dfdr software package. 2dfdr is currently has modes which reduce data for a number of instruments, 2dF, AAOmega, the AAOmega SPIRAL IFU, 6dF and FMOS. In upgrading the software to work with AAOmega data a number of fundamental changes to how the software works have been required. At this time, the previous edition of the 2dfdr manual is somewhat out of date and does not cover all of these modifications and improvements. This CookBook is aimed at providing a basic introduction to the reduction environment. The updated manual will be available shortly. In the mean time, please contact your support astronomer with any questions about the software or problems with data reduction.
>
>
AAOmega data is processed using a revised version of the 2dfdr software package. 2dfdr currently has modes which reduce data for a number of instruments, 2dF, AAOmega with the 2df and Spiral IFU top ends, 6dF and FMOS. In upgrading the software to work with AAOmega data a number of fundamental changes to the software have been required. At this time, the full 2dfdr manual (Word, pdf) is somewhat out of date and does not cover the modifications and improvements. This CookBook is aimed at providing a basic introduction to the reduction process. An updated manual will be available shortly. In the mean time, please contact your support astronomer with any questions about the software or problems with data reduction.
 

Download the software

Changed:
<
<
2dfdr is rapidly evolving as more is learned about AAOmega data. The high quality of AAOmega spectra, in comparison to what was achievable with the older 2dF spectrograph (which were, it must be stressed, principally designed to record low resolution redshifts of bright galaxies) means that there are many improvements required in the reduction system to do full justice to the data recorded with AAOmega. The user should check the AAOmega software web page before starting a campaign of data reduction to ensure they have the every latest version of the software. This rate of update will deminish once a small number of outstanding issues are addressed.
>
>
2dfdr is rapidly evolving as more is learned about AAOmega data. The high quality of AAOmega spectra, in comparison to what was achievable with the older 2dF spectrograph (which was, it must be stressed, principally designed to record low resolution redshifts of bright galaxies) means that there are many improvements required in the reduction system to do justice to the data recorded with AAOmega. The user should check the AAOmega software web page before starting a campaign of data reduction to ensure they have the every latest version of the software. This rate of evolution will deminish once a small number of outstanding issues are addressed.
 
Changed:
<
<
The software is only available as a set of binary executables. The system is created with the Starlink software library and cannot be built without a Starlink installation. While this software is not proprietary, we cannot support external builds at this time. With the demise of the Starlink project in 2005, it may become necessary for 2dfdr to be rebuilt with the Starlink components removed in the future.
>
>
The software is only available as a set of binary executables. The system is created with the Starlink software library and cannot be built without a Starlink installation. While this software is not proprietary, we cannot support external builds at this time. With the demise of the Starlink project in 2005, it may become necessary to remove the Starlink components in the future.
 
Changed:
<
<
The executables are currently only available for the RedHat Enterprise 3 Linux. This system has been tested and works well under current implementations of RH4E and most installations of Fedora, Scientific Linux and other popular flavors. Limited support can be offered for other operating systems. A Solaris version can be made available on request, but due to speed problems is unlikely to receive much use. Version for Mac OSX are not available at this time due to complications with running elements of the Starlink libraries on the Mac.
>
>
The executables are currently only available for the RedHat Enterprise3 Linux. This system has been tested and works well under current implementations of RedHat Enterprise4 and most installations of Fedora, Scientific Linux and other popular flavors. Limited support can be offered for other operating systems. A Solaris version can be made available on request, but due to speed problems is unlikely to receive much use. A version for Mac OSX is not available at this time due to complications with running elements of the Starlink libraries on the Mac.
 
Changed:
<
<
Download the latest tar file from the FTP site : ftp://ftp.aao.gov.au/pub/2df/
>
>
Download the latest tar file from the FTP site
  The file will look something like: 2dfdr-RH3E_060610.tgz
Line: 23 to 26
 

Running 2dfdr for AAOmega

Changed:
<
<
First we need to set some environment variable and run the setup script
>
>
First we need to set an environment variable and run the setup script
 
    tcsh
Line: 31 to 34
  source $DRCONTROL_DIR/2dfdr_setup
Changed:
<
<
2dfdr should be run in a separate working directory for each set of observations with a particular field plate. A meaningful directory structure for your observing run can save a lot of heartache later on. An example might be:
>
>
2dfdr should be run in a separate working directory for each set of observations with a particular field plate. A meaningful directory structure for your observing run can save a lot of heartache later on. An example directory structure might be:
 
    Observing_june05/
Line: 45 to 48
  field4/
Changed:
<
<
Note that due to the way the flat and arc frames are used, each independent observation (i.e. with a different configuration of the fibres on the field plate) will require a new directory, even if all you have done is tweak the positions of fibre on a previously observed configuration. Once the AAOmega Slit Wheel is moved, a new set of flats and arcs are required for the reduction. Data from multiple repeats of the same field, or for fields that contain some repeat observations can be automatically combined, but this is done after the full reduction of data for each field.
>
>
Note that due to the way the flat and arc frames are used, each independent observation (i.e. with a different configuration of the fibres on the field plate) will require a new directory, even if all you have done is tweak the positions of fibre on a previously observed configuration. Once the AAOmega slit wheel is moved, a new set of flats and arcs are required for the reduction. Data from multiple repeats of the same field, or for fields that contain some repeat observations can be automatically combined, but this is done after the full reduction of data for each field.
 
Changed:
<
<
Data from the blue and red arms of the CCD can be reduced in the same directory, but this is often not easy to work with and so most users create separate ccd_1 and ccd_2 sub directories.
>
>
Data from the blue and red arms can be reduced in the same directory, but this is often not easy to work with and so most users create separate ccd_1 and ccd_2 sub directories with blue and red data, respectively.
  Move to your working directory of choice and then the software can be started with the command
Deleted:
<
<
drcontrol

However, this will bring up a pop-up window asking for the instrument that produced the data. This will make default settings for the reduction with the selected instrument.

A more useful start command is:

  drcontrol aaomega.idx &
Line: 89 to 84
 
  • one or more science frames
Changed:
<
<
Additional frames of various types may be needed, depending on the nature of your data. To start the automatic reduction process, hit the Setup button in the upper right hand section of the GUI. The pop-up shown here will appear.
>
>
Additional frames of various types may be needed, depending on the nature of your data. To start the automatic reduction process, hit the Setup button in the upper right hand section of the GUI. The window shown here will appear.
  Setup GUI
Changed:
<
<
The automatic data reduction depends on the use of a file naming convention in which the name consists of a root name that is the same for all files. This is followed by a four-digit integer run number. Raw data from the AAT conforms to this convention with names of the form 13apr0001.fits, 13apr0002.fits etc . Data from the archive also conforms to the convention though the names are changed to run0001.fts, etc.
>
>
The automatic data reduction depends on the use of a file naming convention in which the name has a root that is the same for all files. The root name is followed by a four-digit integer run number. Raw data from the AAT conforms to this convention with names of the form 13apr0001.fits, 13apr0002.fits etc . Data from the archive also conforms to the convention though the names are changed to run0001.fts, etc.
  It is possible to reduce individual files that do not conform to the naming convention. They can be loaded into the system using the Reduce item in the Commands menu. However such files cannot form part of the automatic reduction of a sequence of files, unless they are renamed to conform to the other files in the sequence.
Changed:
<
<
This setup GUI is asking for the root name which prefixes the data to be reduced. In this example the prefix is 28jun2 which indicates the software has found data taken on June 28th and for ccd2, the red arm ccd. If one wants to reduced data from blue and red ccds in the same directory then the root name can be altered to 28jun1 to pick up ccd1 data. Note that a Tcl bug requires that the user enter the new root name BUT DOES NOT HIT ENTER. You must click on okay. Hitting Enter on the keyboard will set the root name to the default that the GUI started with and NOT the value that you just entered. Steps are being taken to deal with this infuriating issue.
>
>
This Setup Automatic Reduction window is asking for the root name which prefixes the data to be reduced. In this example the prefix is 28jun2 which indicates the software has found data taken on June 28th and for ccd2, the red arm. If one wants to reduce data from the blue and red arms in the same directory then the root name can be altered to 28jun1 to pick up ccd1 data. Note that a Tcl bug requires that the user enter the new root name BUT DOES NOT HIT ENTER. You must click on Ok. Hitting Enter on the keyboard will set the root name to the default the window started with and NOT the value that you just entered. Steps are being taken to deal with this infuriating issue.
 
Changed:
<
<
Once Setup has run, the file information will be available in the left Data tab section of the main GUI.
>
>
Once Setup has run, the file information will be available in the left Data tab section of the main GUI as shown here.
  File info GUI.jpg
Changed:
<
<
Here we see the the first file, Run 1, is file 28jun20001.fits (which is run 1 for ccd2 from 28th June). The file is a Multi-Fibre Fibre Flat Field (MFFFF, please refer to the full manual for an explanation of this insane classification convention). The file is Not Reduced yet and so there is no Reduced File. We can use the up and down spinner buttons to right of of Run. or select a file from the File chooser to cycle through the current available data to view the other files with the same root name in the local directory. If we hit the Plot button below the file information, we can see the 2D image, to check that everything looks okay. Note that the full CCD is 2kx4k and so many of the displays you will see during reduction are heavily aliased and will often show strange artifacts which are simply not in the data.
>
>
Here we see the the first file, Run 1, is file 28jun20001.fits (which is run 1 for ccd2 from 28th June). The file is a Multi-Fibre Fibre Flat Field (MFFFF, please refer to the full manual for an explanation of this insane classification convention). The file is Not Reduced and so there is no Reduced File. We can use the up and down spinner buttons to right of Run. or select a file from the File chooser to cycle through the current available data to view the other files with the same root name in the local directory. If we hit the Plot button below the file information, we can see the 2D image to check that everything looks okay. Note that the full CCD is 2kx4k and so many of the displays you will see during reduction are heavily aliased and will often show strange artifacts which are simply not in the data.
  Reduced flat with tramline overlaid
Changed:
<
<

Fibre Fibres

>
>

Find Fibres

  For older 2dF data it was neccessary to run the Find Fibres command from the main GUI commands menu. This allowed the user to asign a fibre identifiaction to the flat field and prevented the extraction loosing fibres later on. For AAOmega data this step is not required (and infact will not work and will crash the reduction if you try it). AAOmega has eight well spaced gaps in the data, at the positions of guide fibres bundles on the field plates. These gaps allow the accurate first order fit to the fibre positions and so the fibres are found automaticaly.

Revision 12007-01-11 - RonHeald

Line: 1 to 1
Added:
>
>

CookBook for AAOmega data reduction with 2dfdr

AAOmega data is processed using an updated version of the 2dfdr software package. 2dfdr is currently has modes which reduce data for a number of instruments, 2dF, AAOmega, the AAOmega SPIRAL IFU, 6dF and FMOS. In upgrading the software to work with AAOmega data a number of fundamental changes to how the software works have been required. At this time, the previous edition of the 2dfdr manual is somewhat out of date and does not cover all of these modifications and improvements. This CookBook is aimed at providing a basic introduction to the reduction environment. The updated manual will be available shortly. In the mean time, please contact your support astronomer with any questions about the software or problems with data reduction.

Download the software

2dfdr is rapidly evolving as more is learned about AAOmega data. The high quality of AAOmega spectra, in comparison to what was achievable with the older 2dF spectrograph (which were, it must be stressed, principally designed to record low resolution redshifts of bright galaxies) means that there are many improvements required in the reduction system to do full justice to the data recorded with AAOmega. The user should check the AAOmega software web page before starting a campaign of data reduction to ensure they have the every latest version of the software. This rate of update will deminish once a small number of outstanding issues are addressed.

The software is only available as a set of binary executables. The system is created with the Starlink software library and cannot be built without a Starlink installation. While this software is not proprietary, we cannot support external builds at this time. With the demise of the Starlink project in 2005, it may become necessary for 2dfdr to be rebuilt with the Starlink components removed in the future.

The executables are currently only available for the RedHat Enterprise 3 Linux. This system has been tested and works well under current implementations of RH4E and most installations of Fedora, Scientific Linux and other popular flavors. Limited support can be offered for other operating systems. A Solaris version can be made available on request, but due to speed problems is unlikely to receive much use. Version for Mac OSX are not available at this time due to complications with running elements of the Starlink libraries on the Mac.

Download the latest tar file from the FTP site : ftp://ftp.aao.gov.au/pub/2df/

The file will look something like: 2dfdr-RH3E_060610.tgz

Unpack the tar file and to extract the software to your chosen working directory

tar -zxvf 2dfdr-RH3E_060610.tgz

Running 2dfdr for AAOmega

First we need to set some environment variable and run the setup script

    tcsh
    setenv DRCONTROL_DIR /path/to/software/2dfdr-linux_x86
    source $DRCONTROL_DIR/2dfdr_setup

2dfdr should be run in a separate working directory for each set of observations with a particular field plate. A meaningful directory structure for your observing run can save a lot of heartache later on. An example might be:

    Observing_june05/
        night1/
            field1/
            field1b/
            field2/
            field3/
        night2/
            field1/
            field4/

Note that due to the way the flat and arc frames are used, each independent observation (i.e. with a different configuration of the fibres on the field plate) will require a new directory, even if all you have done is tweak the positions of fibre on a previously observed configuration. Once the AAOmega Slit Wheel is moved, a new set of flats and arcs are required for the reduction. Data from multiple repeats of the same field, or for fields that contain some repeat observations can be automatically combined, but this is done after the full reduction of data for each field.

Data from the blue and red arms of the CCD can be reduced in the same directory, but this is often not easy to work with and so most users create separate ccd_1 and ccd_2 sub directories.

Move to your working directory of choice and then the software can be started with the command

    drcontrol

However, this will bring up a pop-up window asking for the instrument that produced the data. This will make default settings for the reduction with the selected instrument.

A more useful start command is:

    drcontrol aaomega.idx &

which selects defaults for AAOmega, or

    drcontrol aaomega###.idx &

where ### is the grating name (e.g. 385R, 580V or 1700D etc.) with which the data was taken. The .idx files are all stored at

/path/to/software/2dfdr-linux_x86/*.idx

Users, if required, can make a copy of these instrument (.idx) files in the local directory and modify them to set their own reduction preferences. Not all grating configurations currently have .idx files created.

These commands should bring up the main 2dfdr control window shown here.

2dfdr Main GUI

Starting a reduction

The basic files needed to reduce AAOmega data are:

  • a multi-fibre flat field exposure (class MFFFF) These exposures are made with a quartz lamp that provides a uniform spectrum. They are used to calibrate the detector, and to find the centre and profile of the spectra.

  • an arc exposure (class MFARC) These exposures are made with lamps having various known strong lines. They are used to calibrate the central wavelength and dispersion.

  • one or more science frames

Additional frames of various types may be needed, depending on the nature of your data. To start the automatic reduction process, hit the Setup button in the upper right hand section of the GUI. The pop-up shown here will appear.

Setup GUI

The automatic data reduction depends on the use of a file naming convention in which the name consists of a root name that is the same for all files. This is followed by a four-digit integer run number. Raw data from the AAT conforms to this convention with names of the form 13apr0001.fits, 13apr0002.fits etc . Data from the archive also conforms to the convention though the names are changed to run0001.fts, etc.

It is possible to reduce individual files that do not conform to the naming convention. They can be loaded into the system using the Reduce item in the Commands menu. However such files cannot form part of the automatic reduction of a sequence of files, unless they are renamed to conform to the other files in the sequence.

This setup GUI is asking for the root name which prefixes the data to be reduced. In this example the prefix is 28jun2 which indicates the software has found data taken on June 28th and for ccd2, the red arm ccd. If one wants to reduced data from blue and red ccds in the same directory then the root name can be altered to 28jun1 to pick up ccd1 data. Note that a Tcl bug requires that the user enter the new root name BUT DOES NOT HIT ENTER. You must click on okay. Hitting Enter on the keyboard will set the root name to the default that the GUI started with and NOT the value that you just entered. Steps are being taken to deal with this infuriating issue.

Once Setup has run, the file information will be available in the left Data tab section of the main GUI.

File info GUI.jpg

Here we see the the first file, Run 1, is file 28jun20001.fits (which is run 1 for ccd2 from 28th June). The file is a Multi-Fibre Fibre Flat Field (MFFFF, please refer to the full manual for an explanation of this insane classification convention). The file is Not Reduced yet and so there is no Reduced File. We can use the up and down spinner buttons to right of of Run. or select a file from the File chooser to cycle through the current available data to view the other files with the same root name in the local directory. If we hit the Plot button below the file information, we can see the 2D image, to check that everything looks okay. Note that the full CCD is 2kx4k and so many of the displays you will see during reduction are heavily aliased and will often show strange artifacts which are simply not in the data.

Reduced flat with tramline overlaid

Fibre Fibres

For older 2dF data it was neccessary to run the Find Fibres command from the main GUI commands menu. This allowed the user to asign a fibre identifiaction to the flat field and prevented the extraction loosing fibres later on. For AAOmega data this step is not required (and infact will not work and will crash the reduction if you try it). AAOmega has eight well spaced gaps in the data, at the positions of guide fibres bundles on the field plates. These gaps allow the accurate first order fit to the fibre positions and so the fibres are found automaticaly.

Reduce the data

The user should now be able to simply hit the Start button, on the upper right of the main GUI, to reduce the data in the current working directory.

The process runs as follows:

  • Reduce any and all multi-fibre flat field frame
  • Reduce any and all arc frame
  • Re-reduce the flat field frames using the accurate wavelength solution to compute a better average illumination correction
  • Reduce any and all science frames
  • Combine the science frames

The final step, the combination of the science frames, will, of course, fail if there is only one science frame. A Tcl bug means that the pop-up window which informs you of this currently crashes the reduction software. This will be fix as soon as possible. Your working directory should now contain a set of *red.fits files which are the reduced data. The combined data will be in the combined_frames.fits file if it was created.

Note on extraction methods

There are currently three extraction options for AAOmega data, the option can be set under the Extract tab on the main GUI window:

  1. Tram - a simple summation of the data either side of the tram line fit. This is quick, but a little noisy
  2. Gauss - a weighted summation of the data based on the predicted Gaussian PSF either side of the tram line fit
  3. Fit - a full PSF fitting of the data, which takes into account fibre-to-fibre cross talk fully.

Ultimately Fit extraction will give the best results, although the fitting process is rather slow. At this time however, the FIT routine has not been correctly implemented and we suggest you use Tram extraction for a quick look reduction and Gauss extraction for science.

-- RonHeald - 11 Jan 2007

META FILEATTACHMENT attr="" autoattached="1" comment="setup GUI" date="1168487738" name="setup_gui.jpg" path="setup_gui.jpg" size="14515" user="Main.RonHeald" version="1"
META FILEATTACHMENT attr="" autoattached="1" comment="2dfdr Main GUI" date="1168487622" name="2dfdr_gui.jpg" path="2dfdr_gui.jpg" size="85650" user="Main.RonHeald" version="1"
META FILEATTACHMENT attr="" autoattached="1" comment="flat" date="1168487851" name="a_flat.jpg" path="a_flat.jpg" size="65684" user="Main.RonHeald" version="1"
META FILEATTACHMENT attr="" autoattached="1" comment="data tab file info" date="1168487799" name="file_info.jpg" path="file_info.jpg" size="25530" user="Main.RonHeald" version="1"
META FILEATTACHMENT attr="" autoattached="1" comment="2dfdr Main GUI" date="1168489872" name="2dfdr_main_gui.jpg" path="2dfdr_main_gui.jpg" size="68611" user="Main.RonHeald" version="1"
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback