Package org.jlab.geom.base

Interface Sector<SuperlayerType extends Superlayer>

Type Parameters:
SuperlayerType - the specific type of Superlayer contained by the Sector
All Superinterfaces:
Showable
All Known Implementing Classes:
AbstractSector, AlertDCSector, AlertTOFSector, BSTSector, CNDSector, DCSector, ECSector, FMTSector, FTCALSector, FTOFSector, FTOFSectorMesh
public interface Sector<SuperlayerType extends Superlayer> extends Showable
One sector of a detector.

The primary purpose of a Sector object is to provide convenient methods for accessing to the Superlayer objects it contains. If grouping components by sector is inconvenient a Sector object may contain more than one sector.

Factory: Factory
Hierarchy: Detector → Sector → Superlayer → Layer → Component

To learn how to create a Sector and find much more information see Factory.

Author:
jnhankins

  • Method Summary

    Modifier and Type
    Method
    Description
    List<SuperlayerType>
    getAllSuperlayers()
    Returns an unmodifiable list of all superlayers contained in this sector.
    List<List<Line3D>>
    getCrossSections(Transformation3D transformation)
    Returns a list of lists of lines such that each of the inner lists contains the cross section lines for a single component.
    DetectorId
    getDetectorId()
    Returns the id of the detector that this sector is contained in.
    List<DetectorHit>
    getHits(Path3D path)
    Returns a list of DetecorHits which store information about intersections with components in this sector.
    List<DetectorHit>
    getLayerHits(Path3D path)
    Returns a list of DetecorHits which store information about intersections with layer surface boundaries in this sector.
    int
    getNumSuperlayers()
    Returns the number of superlayers contained in this sector.
    int
    getSectorId()
    Returns the id of this sector.
    SuperlayerType
    getSuperlayer(int superlayerId)
    Returns the superlayer associated with the given superlayer id.
    String
    getType()
    Returns a string that identifies the specific subtype of this sector.
    void
    show()
    Invokes System.out.println(this).

  • Method Details

    • getDetectorId

      DetectorId getDetectorId()
      Returns the id of the detector that this sector is contained in.
      Returns:
      the id of this sector's detector

    • getSectorId

      int getSectorId()
      Returns the id of this sector.
      Returns:
      the id of this sector

    • getNumSuperlayers

      int getNumSuperlayers()
      Returns the number of superlayers contained in this sector.
      Returns:
      the number of superlayers

    • getSuperlayer

      SuperlayerType getSuperlayer(int superlayerId)
      Returns the superlayer associated with the given superlayer id.
      Parameters:
      superlayerId - the superlayer id
      Returns:
      the superlayer with the specified id

    • getAllSuperlayers

      List<SuperlayerType> getAllSuperlayers()
      Returns an unmodifiable list of all superlayers contained in this sector.
      Returns:
      an unmodifiable list of superlayers

    • getCrossSections

      List<List<Line3D>> getCrossSections(Transformation3D transformation)
      Returns a list of lists of lines such that each of the inner lists contains the cross section lines for a single component.

      This method takes a Transformation3D object as an argument, then constructs a Plane3D object in the xy-plane and applies the transformation to the plane. The intersection of the sector's component's shapes with the transformed plane is then calculated and stored in a list of lists of lines of lines. The inverse of the transformation is then applied to each line ensuring that each returned line is in the xy-plane

      Parameters:
      transformation - the transformation
      Returns:
      a list of list of lines representing the cross section
      See Also:

    • getLayerHits

      List<DetectorHit> getLayerHits(Path3D path)
      Returns a list of DetecorHits which store information about intersections with layer surface boundaries in this sector. The component ids stored in the detector hits will all be set to -1 to indicate that detector hit does not specify a specific component.
      Parameters:
      path - the path
      Returns:
      a list of detector hits

    • getHits

      List<DetectorHit> getHits(Path3D path)
      Returns a list of DetecorHits which store information about intersections with components in this sector.
      Parameters:
      path - the path
      Returns:
      a list of detector hits

    • getType

      String getType()
      Returns a string that identifies the specific subtype of this sector.
      Returns:
      a string naming this sector's type

    • show

      void show()
      Invokes System.out.println(this).
      Specified by:
      show in interface Showable