Warning, /Geometry/CSCGeometry/doc/CSCGeometry.doc is written in an unsupported language. File is not indexed.
0001
0002 /*!
0003
0004 \page Geometry_CSCGeometry Package Geometry/CSCGeometry
0005
0006 <center>
0007 <small>
0008
0009 <!-- @CVS_TAG@ will be substituted at build time, no need to touch -->
0010 <a href=http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Geometry/CSCGeometry/?cvsroot=CMSSW&only_with_tag=@CVS_TAG@>Source code (CVS tag: @CVS_TAG@)</a> -
0011 <a href=http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Geometry/CSCGeometry/.admin/developers?rev=HEAD&cvsroot=CMSSW&content-type=text/vnd.viewcvs-markup>Administrative privileges</a>
0012 </small>
0013 </center>
0014
0015 \section desc Description
0016 <!-- Short description of what this package is supposed to provide -->
0017 Provides the geometrical model of the endcap muon CSC system as a container of CSCs (CSChamber objects). <br>
0018 A CSCChamber is a concrete implementation of the GeomDet interface for a CSC. <br>
0019 A CSCChamber is composed of 6 CSCLayer objects, each of which is a concrete implementation of a GeomDetUnit. <br>
0020 Each CSCLayer contains concrete implementations of Topology objects to describe the wire and strip planes
0021 in a layer of a CSC.
0022
0023 \subsection interface Primary public interface
0024
0025 - CSCGeometry
0026 The entire model of the CSC endcap muon system. <br>
0027 This isa TrackingGeometry. Basically a vector<CSCChamber*>.
0028 - CSCChamber
0029 Represents one CSC in the system. <br>
0030 A CSC is composed of 6 layers so a CSCChamber is composed of 6 CSCLayer objects.
0031 Basically a vector<CSCLayer*>. <br>
0032 A CSCChamber can transform between local and global coordinates.
0033 - CSCLayer
0034 Represents one layer (gas+strip plane+wire plane) of a CSC. <br>
0035 A CSCLayer can transform between local and global coordinates.
0036
0037 \subsection secint Secondary public interface
0038 Mainly used by the above classes, but sometimes by other packages.
0039
0040 - CSCChamberSpecs
0041 General properties of a CSC, e.g. dimensions. <br>
0042 There are 10 types of chamber in the CSC system, corresponding to the combinations MEi/j
0043 where i labels station 1-4, and j labels ring 1-3 (We have ME1/1, ME1/2, ME1/3, ME2/1, ME2/2, ME3/1, ME3/2, ME4/1, ME4/2).<br>
0044 Within the software we also form a virtual ring j=4 to describe the inner region of ME1/1, which is known in the hardware
0045 as ME1/1a. We then presume i=1, j=1 labels the outer region, which is known in hardware as ME1/1b.) <br>
0046 BEWARE that sometimes there is optimization of the i, j labels in the
0047 software so one should always access them through the appropriate interfaces rather than attempting to decode
0048 values stored internally in the objects. (Such relabelling is done, e.g., to optimize DetLayer geometry access during
0049 muon track reconstruction.)<br>
0050 The -z and +z endcaps are symmetric so only 10 CSCChamberSpecs objects in total are used, one per chamber type.
0051
0052 - CSCLayerGeometry
0053 General properties of a CSC layer. <br>
0054 Encapsulates the geometry of the strips in a CSCStripTopology and the geometry of the wires
0055 in a CSCWireTopology. <br>
0056 All values are in local coordinates. <br>
0057 There are separate objects for odd and even layers in the 6 layers
0058 of a CSC, and separate objects for the -z and +z endcaps, so there are 10 x 2 x 2 = 40 CSCLayerGeometry objects.
0059
0060 - CSCStripTopology
0061 General properties of a strip plane. <br>
0062 An OffsetRadialStripTopology matched to a CSC plane of strips.
0063
0064 - OffsetRadialStripTopology
0065 A standard RadialStripTopology in which there is an angular offset between the plane of strips and the local coordinate
0066 system of the underlying DetUnit.
0067
0068 - CSCWireTopology
0069 A WireTopology matched to a CSC plane of wires. <br>
0070 Basically a WireTopology containing a CSCWireGeometry* and a CSCWireGrouping*.
0071
0072 - WireTopology
0073 An abstract base class for detector planes of wires rather than strips. A Topology.
0074
0075 - CSCWireGeometry
0076 Abstract class dealing with the spacing and angles of wires in a wire plane.
0077
0078 - nint
0079 A nearest int function for floats and doubles. This was originally a CMS-wide function.
0080
0081 - CSCGattiFunction
0082 Represents the expected functional form of the charge distribution on strips in a MWPC. <br>
0083 This is required for
0084 distributing simulated charge over strips during simulation. Although it is not strictly geometrical,
0085 it was not clear where else to package it.
0086
0087 \subsection other Classes not in public interface
0088
0089 - CSCNonslantedWireGeometry
0090 - CSCSlantedWireGeometry
0091
0092 - CSCUngangedStripTopology
0093
0094 - CSCWireGrouping
0095 Abstract class describing the wire group structure of a CSC wire plane - how the wires are grouped into readout channels.
0096 - CSCGangedWireGrouping
0097 - CSCUngangedWireGrouping
0098 - CSCWireGroupPackage
0099
0100 \subsection modules Modules
0101 <!-- Describe modules implemented in this package and their parameter set -->
0102
0103 I don't even know what a 'module' is, so I don't think there are any.
0104
0105 \subsection tests Unit tests and examples
0106 <!-- Describe cppunit tests and example configuration files -->
0107
0108 No cppunit tests left since they were never properly supported or particularly useful.
0109 But there are 7 types of stand-alone test program in the test directory which are extremely useful
0110 for examining what's in the CSCGeometry hierarchy.
0111
0112 \section status Status and planned development
0113 <!-- e.g. completed, stable, missing features -->
0114
0115 Completed. Stable. (But tests will continue to be developed as appropriate.)
0116
0117 <hr>
0118 Last updated:
0119 @DATE@ Author: computer-generated.
0120 */
0121
