astro.fits
Interface IcatSource

All Known Implementing Classes:

IcatPrepare.Dir, IcatSearch

public interface IcatSource

This class describes the capability of an object to provide input file lists for the IcatPrepare class. The simplest case would be an object that reads a directory and splits the fits file found due to their file name. More sophisticated objects may read a database and perform a lookup based on the science frames encountered.

Method Summary

List<File>	biasSource() The source method for the bias files.
List<File>	darkSource() The source method for the dark files.
boolean	flatsAreMaster() If the list of flat files are already normalized master flats, this method should return true.
List<File>	flatSource() The source method for the flat files.
boolean	postpone() After registering the science images, the source may decide that reduction cannot commence, but should be postponed.
void	registerScience(File science) If this method is called with a science-frame, the source methods should only deliver calibration frames that are needed or best suited for this science frame.
void	registerScience(List<File> science) If this method is called with a science-frame, the source methods should only deliver calibration frames that are needed or best suited for this science frame.
List<File>	scienceSource() From the list of registered fits, these are the one that can be reduced with the available calibration files.

Method Detail

registerScience

void registerScience(File science)

If this method is called with a science-frame, the source methods should only deliver calibration frames that are needed or best suited for this science frame. If the source methods are called without an a priori call to this method or its sibling, then the behaviour of the source methods is undetermined in the sense that they may also provide simply all the files they have found.

This is a convenience method to registerScience(List) and is normally implemented as a call to the aforementioned method with a singleton list

registerScience

void registerScience(List<File> science)

If this method is called with a science-frame, the source methods should only deliver calibration frames that are needed or best suited for this science frame. If the source methods are called without an a priori call to this method or its sibling, then the behaviour of the source methods is undetermined in the sense that they may also provide simply all the files they have found.

This method should be used, if reduction of an entire night is done.

biasSource

List<File> biasSource()

The source method for the bias files. Calling this method should return a list of files in the reach for IcatPrepare.

darkSource

List<File> darkSource()

The source method for the dark files. Calling this method should return a list of files in the reach for IcatPrepare.

flatSource

List<File> flatSource()

The source method for the flat files. Calling this method should return a list of files in the reach for IcatPrepare.

scienceSource

List<File> scienceSource()

From the list of registered fits, these are the one that can be reduced with the available calibration files.

flatsAreMaster

boolean flatsAreMaster()

If the list of flat files are already normalized master flats, this method should return true. It also implies that only the science images should be bias subtracted and dark corrected, then the flats are immediately used on these images.

postpone

boolean postpone()

After registering the science images, the source may decide that reduction cannot commence, but should be postponed. Possible reasons for this are if not enough calibration frames have been gathered around the science time in question, thus we wait for calibrations of close-by nights to finish and then later redo this calibration.