TFC_skirt.h File Reference

Interface to TKR skirt projection routines. More...

Typedefs
typedef enum _TFC_skirtRegion	TFC_skirtRegion
	Typedef for enum _TFC_skirtRegion.
typedef enum _TFC_skirtRegion_m	TFC_skirtRegion_m
	Typedef for enum _TFC_skirtRegion_m.
typedef enum _TFC_skirtRegions	TFC_skirtRegions
	Typedef for enum TFC_skirtRegions.
Enumerations
enum	_TFC_skirtRegion {   TFC_SKIRT_K_REGION_YM_XM = 0,   TFC_SKIRT_K_REGION_YM_XC = 1,   TFC_SKIRT_K_REGION_YM_XP = 2,   TFC_SKIRT_K_REGION_YC_XM = 3,   TFC_SKIRT_K_REGION_YC_XP = 4,   TFC_SKIRT_K_REGION_YP_XM = 5,   TFC_SKIRT_K_REGION_YP_XC = 6,   TFC_SKIRT_K_REGION_YP_XP = 7 }
	The enumeration of the 9 skirt regions, see diagram below. More...
enum	_TFC_skirtRegion_m {   TFC_SKIRT_M_REGION_YM_XM = (1 << TFC_SKIRT_K_REGION_YM_XM),   TFC_SKIRT_M_REGION_YM_XC = (1 << TFC_SKIRT_K_REGION_YM_XC),   TFC_SKIRT_M_REGION_YM_XP = (1 << TFC_SKIRT_K_REGION_YM_XP),   TFC_SKIRT_M_REGION_YC_XM = (1 << TFC_SKIRT_K_REGION_YC_XM),   TFC_SKIRT_M_REGION_YC_XP = (1 << TFC_SKIRT_K_REGION_YC_XP),   TFC_SKIRT_M_REGION_YP_XM = (1 << TFC_SKIRT_K_REGION_YP_XM),   TFC_SKIRT_M_REGION_YP_XC = (1 << TFC_SKIRT_K_REGION_YP_XC),   TFC_SKIRT_M_REGION_YP_XP = (1 << TFC_SKIRT_K_REGION_YP_XP) }
	Enumeration of the skirt regions as a bit mask. More...
enum	_TFC_skirtRegions {   TFC_SKIRT_REGIONS_XM,   TFC_SKIRT_REGIONS_XC,   TFC_SKIRT_REGIONS_XP,   TFC_SKIRT_REGIONS_YM,   TFC_SKIRT_REGIONS_YC,   TFC_SKIRT_REGIONS_YP }
	Enumeration of the bit masks representing commonly used collections of the primitive skirt regions. More...
Functions
int	TFC_skirtProject (TFC_prj *prj, int xCnt, int yCnt, const TFC_geometry *geo, unsigned char skirtxy[2][16])
	Checks the specified list of projections, looking for regions of skirt that these projections pass through.

---

Detailed Description

Interface to TKR skirt projection routines.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: TFC_skirt.h,v 1.3 2007/06/17 22:36:20 russell Exp $

---

Enumeration Type Documentation

enum _TFC_skirtRegion

The enumeration of the 9 skirt regions, see diagram below.

The skirt region is the defined as the area between the towers and the ACD at plane of the TKR/CAL boundary. The region is numbered as follows

      +------------------------+
      |   |                |   |
      | 5 |        6       | 7 |
      |   |                |   |
      |---+----------------+---|
      |   |                |   |
      |   |                |   |
      |   |                |   |
      |   |                |   |
      | 3 |                | 4 |
      |   |                |   |
      |   |                |   |
      |   |                |   |
      |   |                |   |
      |   |                |   |
      |---+----------------+---|
      |   |                |   |
      | 0 |       1        | 2 |
      |   |                |   |
      +------------------------+

  

Enumerator:

TFC_SKIRT_K_REGION_YM_XM	Lower left region
TFC_SKIRT_K_REGION_YM_XC	Lower center region
TFC_SKIRT_K_REGION_YM_XP	Lower right region
TFC_SKIRT_K_REGION_YC_XM	Center left region
TFC_SKIRT_K_REGION_YC_XP	Center right region
TFC_SKIRT_K_REGION_YP_XM	Upper left region
TFC_SKIRT_K_REGION_YP_XC	Upper center region
TFC_SKIRT_K_REGION_YP_XP	Upper right region

enum _TFC_skirtRegion_m

Enumeration of the skirt regions as a bit mask.

Enumerator:

TFC_SKIRT_M_REGION_YM_XM	Lower left region
TFC_SKIRT_M_REGION_YM_XC	Lower middle region
TFC_SKIRT_M_REGION_YM_XP	Lower right region
TFC_SKIRT_M_REGION_YC_XM	Middle left region
TFC_SKIRT_M_REGION_YC_XP	Middle right region
TFC_SKIRT_M_REGION_YP_XM	Upper left region
TFC_SKIRT_M_REGION_YP_XC	Upper middle region
TFC_SKIRT_M_REGION_YP_XP	Upper right region

enum _TFC_skirtRegions

Enumeration of the bit masks representing commonly used collections of the primitive skirt regions.

Enumerator:

TFC_SKIRT_REGIONS_XM	Skirt template for XM region
TFC_SKIRT_REGIONS_XC	Skirt template for X middle region
TFC_SKIRT_REGIONS_XP	Skirt template for XP region
TFC_SKIRT_REGIONS_YM	Skirt template for YM region
TFC_SKIRT_REGIONS_YC	Skirt template for Y middle region
TFC_SKIRT_REGIONS_YP	Skirt template for YP region

---

Function Documentation

int TFC_skirtProject	(	TFC_prj *	prj,
		int	xCnt,
		int	yCnt,
		const TFC_geometry *	geo,
		unsigned char	skirtxy[2][16]
	)

Checks the specified list of projections, looking for regions of skirt that these projections pass through.

Returns:

The XY regions that the projections pass through

Parameters:

	prj	The list of projections, assumed X projections first followed by the Y projections
	xCnt	The number of X projections
	yCnt	The number of Y projections
	geo	The LAT geometry specification
	skirtxy	The accumulated coincidence masks

References _TFC_prj::bot, EDM_CODE, EDM_DEBUGPRINTF, _TFC_prjPrms::layer, _TFC_geometry::skirt, _TFC_prj::skirtMask, TFC_SKIRT_REGIONS_XC, TFC_SKIRT_REGIONS_XM, TFC_SKIRT_REGIONS_XP, TFC_SKIRT_REGIONS_YC, TFC_SKIRT_REGIONS_YM, TFC_SKIRT_REGIONS_YP, _TFC_prjPrms::tower, _TFC_geometrySkirt::xProjections, _TFC_geometrySkirt::xy, and _TFC_geometrySkirt::yProjections.

Referenced by tkrFilter().