Welcome to PRTP’s documentation!

The Python Raytrace Package (PRTP) is a package of Python functions that simulate X-Ray instruments. It was designed for the McEntaffer Group at the Pennsylvania State University. PRTP expands on the functionality of PyXFocus, but with a more intuitive, modular design.

Contents:

• Overview
  • Installation
• Creating Components
  • Initializing a Component
  • Use an Existing Mission Component
• Flat Components
  • Creating a Flat Component
  • Translate
  • Unit Rotate
  • Rotate
  • Pitch, Roll, and Yaw
  • Coordinates
    • Getting Coordinates
• Collimator Plates
  • Creating a Collimator Plate
  • Moving a Collimator Plate
  • Trace
  • Collision Functions
    • Using Existing Collision Functions:
    • Define Your Own Collision Functions
• Detectors
  • Creating a Detector
  • Moving a Detector
  • Trace
  • Add Gaussian Noise
  • Add Custom Noise
  • View
  • Reset
  • Examples
    • Basic Photon Trace
    • Photon Trace with Noise
    • Misaligned Photon Trace
    • Split Event
• Gratings
  • Creating a Grating
  • Moving a Grating
  • Trace
  • Period Functions
    • Period Function for Parallel Gratings
    • Period Function for Radial Gratings
• Grating Stacks
  • Creating a Grating Stack
  • Adding and Accessing Components
  • Moving Grating Stacks
  • Trace
    • Smart Trace
• Wolter Optics
  • Creating a Wolter Optic
  • Moving Wolter Optics
    • Translate
    • Unit Rotate
    • Rotate
  • Wolter Primary
    • Creating a Wolter Primary Mirror
    • Moving Wolter Primaries
    • Trace
  • Wolter Secondary
    • Creating a Wolter Secondary Mirror
    • Moving Wolter Secondaries
    • Trace
  • Wolter Type One
    • Creating a Wolter Type One Object
    • When to Use Wolter Type One Objects
    • Moving Wolter Type One Objects
    • Trace
  • Wolter Modules
    • Creating a Wolter Module Object
    • Moving Wolter Module Objects
    • Trace
• Sources
  • Creating a Source
  • Using Existing Rays
  • Misalignments
  • Generating Rays
  • Annulus
  • CircularBeam
  • ConvergingBeam
  • ConvergingBeam2
  • PointSource
  • RectArray
  • RectBeam
  • Subannulus
  • Xslit
• Combination
  • Initializing a Combination
  • Adding Components
  • Apply to All
  • Get Sub-Components
  • Setting Attributes
  • In-Place Motion
    • Unitrotateinplace
    • Rotateinplace
  • Bulk Motion
    • Translate
    • Defining a Rotation Point
    • Unit Rotate
    • Rotate
  • Trace
• Modification
  • Creating a Modification
  • Example
• Instruments
  • Creating an Instrument
  • Adding Components
    • Adding a Focus
  • Removing Components
  • Simulating The Components
  • Accessing Simulated Rays
  • Displaying Simulation Information
    • Efficiency Information
    • Spectral Resolution
  • Misalignment Tests
    • Single Translation Test
    • Single Unit Rotate Test
    • Single Rotate Test
• Rays
  • Parameters
  • Length
  • Truth Arrays
  • Generating Rays
    • Copy
    • Split
  • Removing Rays
    • Remove by Trutharray
    • Remove by Probability
  • Tag Functions
    • Add Tag
    • Get Tag
    • Print Tags
    • Combining Tags
  • Analysis Functions
    • Centroid
    • Half-Power Diameter
    • Spectral Resolution
    • Full-Width at Half-Maximum
  • Graphing Functions
    • Examples
• Astropy Units

Indices and tables

• Index
• Module Index
• Search Page