Subs::UvotNames (version $)

package Subs::UvotNames;
##############################################################################
#
# DESCRIPTION: Transform arrays and hashes for uvot filter names, etc
#
# HISTORY:
# HISTORY: $Log: UvotNames.pm,v $
# HISTORY: Revision 1.7  2014/08/14 09:39:41  apsop
# HISTORY: New array filterIDs, like filterMames but contains UGRISM and VGRISM for
# HISTORY: the grism filters, which are correct names for use in eg. EXTNAME keywords.
# HISTORY: Formatting.  VERSION comment.
# HISTORY:
# HISTORY: Revision 1.6  2006/01/11 21:07:55  apsop
# HISTORY: Add blocked filter to filterParams hash.
# HISTORY:
# HISTORY: Revision 1.5  2005/01/11 17:23:17  apsop
# HISTORY: Fix modeNames array to correspond to the proper values for the given mode code numbers.
# HISTORY:
# HISTORY: Revision 1.4  2004/05/06 20:02:34  dah
# HISTORY: Add version number back into the header comments.
# HISTORY:
# HISTORY: Revision 1.3  2004/04/16 20:21:18  dah
# HISTORY: Begin using embedded history records
# HISTORY:
#
# VERSION: $Revision: 1.7 $
#
#
##############################################################################

# The order of these arrays is based on UVOT.hh, which is part of the
# uvot2fits code.

# filterCodes, filterNames, filterIDs are all correlated

$Subs::UvotNames::filterCodes = ['bl', 'gu', 'w2', 'vv',
				 'm2', 'gv', 'w1', 'uu',
				 'mg', 'bb', 'wh', 'un'];

$Subs::UvotNames::filterNames = ['Blocked', 'Grism1 UV', 'UVW2', 'V',
				 'UVM2', 'Grism2 Visible', 'UVW1', 'U',
				 'Magnifier', 'B', 'White', 'Unknown'];

$Subs::UvotNames::filterIDs   = ['Blocked', 'UGRISM', 'UVW2', 'V',
				 'UVM2', 'VGRISM', 'UVW1', 'U',
				 'Magnifier', 'B', 'White', 'Unknown'];

$Subs::UvotNames::reasonNames = ['', 'Normal', 'Aborted', 'Error'];

$Subs::UvotNames::modeNames   = ['NULL', 'NULL', 'Event', 'Image',
				 'Image/Event', 'NULL', 'Raw Event List',
				 'Channel Boundary', 'NULL',
				 'Intensifier Characteristics',
				 'Centroid Confirmation'];

# filterParams is used by UVOTReport.pm to update the uvot_* parameters in
# job.par.  Note that this list does not include the 'unknown' filter.  gu
# should really be grism1uv, but /aps/lists/jobpars/sw.template has
# grism2uv, Frank doesn't want to fix that, it's been this way for 10
# years, and this has to match sw.template or those parameters won't be
# updated.

$Subs::UvotNames::filterParams = {'gu' => 'grism2uv',
				  'w2' => 'uvw2',
				  'vv' => 'v',
				  'm2' => 'uvm2',
				  'gv' => 'grism2visible',
				  'w1' => 'uvw1',
				  'uu' => 'u',
				  'mg' => 'magnifier',
				  'bb' => 'b',
				  'wh' => 'white',
				  'bl' => 'blocked'};