
	   *** CRUSH User's Manual Extension for SOFIA/HAWC+ ***

			      Attila Kovacs
		      <attila[AT]submm.caltech.edu>

		       Last updated: 8 April 2015



Table of Contents
=================

1. Introduction
2. Installation
3. Quickstart guide
4. HAWC+ specific pixel divisions
5. Glossary of HAWC+ specific options
6. HAWC+ specific log quantities





#####################################################################
1. Introduction
#####################################################################


This document contains information specific to using CRUSH-2 to reduce data
from SOFIA/HAWC+. It can be used as a standalone quickstart guide, with
instructions for installation and basic use.
However, it is recommended that users also familiarize themselves with the
contents of the main CRUSH-2 README also (inside the distribution directory), 
especially its Section 1 (Getting Started). 




#####################################################################
2. Installation
#####################################################################

  Coming soon...



#####################################################################
3. Quickstart guide
#####################################################################

  Coming soon...



#####################################################################
4. HAWC+ specific pixel divisions
#####################################################################

For a general overview of channel divisions, please consult Section 3.
(Correlated Signals) in the main README document.

   polarrays

   subarrays

   mux		A grouping of pixels based on their SQUID multiplexing scheme
		Each 4x8 pixel quadrant of the array is read out through the
		same SQUID amplifier. Therefore, it is not suprizing that 
		correlated signals are present on these quadrants. The
		decorrelating on 'mux' groups is default in GISMO reductions

   pins		The GISMO multiplexing scheme is implemented in the time-domain
		Thus, the first channels of each SQUID are read out at the same
		time, followed by the second channel in each group etc. Thus,
		if there is any pickup of high-frequency signals in the
		multiplexing scheme, one could expect some correlated signals
		to be present on these virtual readout pin groups. There
		is little evidence for these, but the reduction of very faint
		compact sources may benefit from the additional decorrelation
		on these groups.
		You can group neighboring 'pins' together for decorrelation
		via the 'correlated.pins.group' option, or the equivalent
		'pins.group' shorthand.

   rows		Geometric rows of the array (it has 16 rows and 8 columns).
		You can also group n rows together for the decorrelation via
		the 'correlated.rows.group=n' option, or the equivalent
		'rows.group=n' shorthand.

   cols		Geometric columns of the array (it has 16 rows and 8 columns).
		You can also group n columns together for the decorrelation via
		the 'correlated.cols.group=n' option, or the equivalent
		'cols.group=n' shorthand.




#####################################################################
5. Glossary of HAWC+ specific options
#####################################################################


   calibrated		Set this option when the reduction includes the final				calibration (opacities and other calibration
			corrections) to produce Level 3 data. Otherwise, CRUSH
			will produce Level 2 output.

   cols                 @Alias: 'correlated.cols'
                        @Expert
                        Specifies the grouping of channels by their geometric
			location of the array divided into columns.
                        @See: 'correlated.<?>', 'rows'

   extended.auto	Set the 'extended' option (for reducing extended 
			sources) automatically based on the SOFIA header
			(specifically if it has 'SRCTYPE' equal to
			'EXTENDED_SOURCE').
			@See: 'extended'			 

   filter=<wavelength>	@Expert
			Sets the filter band to one of:

			  53um, 62um, 89um, 155um, or 216um

			Normally, the filter is set automatically to the 
			correct value based on the 'SPECTEL1' SOFIA header key.
			For this reason, it is not recommended, nor trivial
			for the user to override this automatic behaviour.
			Rather, the setting of this option is useful for
			setting conditional settings, which depend on the
			HAWC+ waveband.

   mux			@Alias: 'correlated.mux'
			@Expert
			Specifies the grouping of channels by the SQUID 
			multiplexing.
			@See: 'correlated.<?>'

   offset.R1=dx,dy
   offset.R2=dx,dy
   offset.T1=dx,dy
   offset.T2=dx,dy	@Expert
			Specify the subarray offset (as dx,dy arcseconds in
			the focal plane) from their nominal positions, for
			both the first and second subarrays of the R and T
			polarization arrays. For example, specifying zero
			offsets for all (default) describes the focal plane
			where R and T are perfectly aligned relative to
			one another, and the two subarrays of each form a 
			single seamless polarization array.


   pcenter=<row>,<col>	@Expert
			Specify the pointing center as a row,col combination 
			on the array. There are 16 rows and 8 columns on the 
			GISMO array, and the numbering starts from 1. Thus, 
			the geometric center of the array corresponds to 
			8.5,4.5. This option is not used (ignored) if pixel
			positions are defined by the 'rcp' option (which is 
			default). In those cases, the pointing center can be 
			adjusted via the 'rcp.center' option.
			@See: 'rcp', 'rcp.center', 'pixelsize', 'rotation'


   pins			@Alias: 'correlated.pins'
			@Expert
			Specifies the grouping of channels by their virtual 
			pin numbers in the multiplexing time domain.
			@See: 'correlated.<?>'

   pins.group=<n>	@Alias: 'correlated.pins.group'
			@Expert
			Because there are only four SQUID multiplexers in 
			GISMO, there is little redundancy among the pixels, 
			which are read out at exactly the same instant. This 
			option allows to group together <n> consecutive 
			samples, to combine pixels read in some time-interval.
			@See: 'pins'

   pixelsize=<a>[,<b>]	@Expert
			Specify the size of the pixels for calculating pixel 
			positions based on a regular grid. A better way of 
			setting the pixel positions is through the 'rcp' 
			option. 
			The argument can be either a lateral size (in arcsec) 
			for square pixels, or two comma separated sizes for 
			rectangular pixels.
			@See: 'rcp', 'rotation', 'pcenter'

   polarrays		@Alias: 'correlated.polarrays'
			@Expert


   rotation=<deg>	@Expert
			Specify the array rotation (in degrees), when pixel 
			positions are calculated from a regular grid. A better 
			way is to specify pixel positions via the 'rcp' option 
			their rotation via 'rcp.rotate'.
			@See: 'rcp', 'rcp.rotate', 'pixelsize'

   rotation.T=<deg>	@Expert
			Specify the rotation of the T polarization subarray
			relative to the R subarray.


   rows                 @Alias: 'correlated.rows'
                        @Expert
                        Specifies the grouping of channels by their geometric
                        location of the array divided into rows.
                        @See: 'correlated.<?>', 'cols'

   subarrays		@Alias: 'correlated.subarrays'
			@Expert



#####################################################################
6. HAWC+ specific log quantities
#####################################################################

  Coming soon...





------------------------------------------------------------------------------
Copyright (C)2015 -- Attila Kovacs <attila[AT]submm.caltech.edu>


