edu.nrao.sss.model.project
Class CalibratorSelector

java.lang.Object
  edu.nrao.sss.model.project.CalibratorSelector

public class CalibratorSelector
extends Object

A selector of sources that can be used for observation calibration.

This class has the astronomical knowledge that is needed for choosing calibrators for different goals of source observation. It is meant to act as a virtual astronomer for calibrator selection.

TODO: At this time this class is a placeholder for later developement.

Version Info:

$Revision: 1118 $

$Date: 2008-02-26 10:52:29 -0700 (Tue, 26 Feb 2008) $

$Author: dharland $

Since:

2006-06-29

Author:

David M. Harland

Constructor Summary

CalibratorSelector()
Creates a new selector.

Method Summary

void	addProvider(SourceProvider newProvider) Adds newProvider to this selector's collection.
Map<ScanMode,Set<Source>>	findCalibratorsFor(Object observationType, SkyPosition sourcePosition) Returns a collection of calibrators that are suitable for the given observational parameters.
Set<Source>	findCalibratorsFor(ScanMode observationMode, Object observationType, SkyPosition sourcePosition) Returns a collection of calibrators that are suitable for the given observational parameters.
void	removeAllProviders() Removes all source providers from this selector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalibratorSelector

public CalibratorSelector()

Creates a new selector.

Method Detail

addProvider

public void addProvider(SourceProvider newProvider)

Adds newProvider to this selector's collection. The find methods will search all providers held by this selector.

Parameters:

newProvider - a source provider that this selector uses when searching for calibrators.

removeAllProviders

public void removeAllProviders()

Removes all source providers from this selector.

findCalibratorsFor

public Map<ScanMode,Set<Source>> findCalibratorsFor(Object observationType,
                                                    SkyPosition sourcePosition)

Returns a collection of calibrators that are suitable for the given observational parameters.

The form of the returned collection is a map where the key is an observation mode and the value is a set of zero or more calibrator sources. The map contains keys for only those modes that are deemed necessary for the given observation parameters.

Parameters:

observationType -

sourcePosition -

Returns:

a map whose keys are of type ScanMode and whose values are sets of Sources.

findCalibratorsFor

public Set<Source> findCalibratorsFor(ScanMode observationMode,
                                      Object observationType,
                                      SkyPosition sourcePosition)

Returns a collection of calibrators that are suitable for the given observational parameters.

The form of the returned collection is a set of zero or more calibrator sources.

Parameters:

observationMode -

observationType -

sourcePosition -

Returns:

a collection of calibrators.