SPT-3G Software Logo

General Documentation

  • Quick Start
    • How to Install
      • Installing Dependencies on a Personal System
      • Handling Dependencies on the Open Science Grid
      • Handling Dependencies on NERSC
      • Compilation
      • Installation
      • Installation with Pip
    • Overview
      • Frames
      • Modules
      • Pipelines
      • IO
      • Frame Objects
      • Units
      • Debugging Code
  • Modules
    • Writing a module in Python
      • Python Modules as Functions
      • Return values from Python modules
      • (Im)mutability of frame objects
      • The first module
      • Callable Objects as Functions
      • Autodocumentation of modules
    • Writing a module in C++
    • Pipeline Segments
    • Advanced Techniques: Buffering Data
    • Caching Previous Data
    • Pipelines
      • Pipeline.Add
      • Pipeline.Run
      • G3PipelineInfo
  • Frames
    • Scan
    • PipelineInfo
    • Timepoint
    • Housekeeping
    • Map
    • Calibration
    • Observation
    • Wiring
    • GcpSlow
    • EndProcessing
  • Logging
    • Setting Log Levels
    • Using Logging from Python
    • Using Logging from C++
  • File IO
    • G3Reader
    • G3Writer
    • G3MultiFileWriter
    • G3File
    • File Format
      • Frame Structure on Disk
      • Blobs
      • Miscellany
  • Units
    • Defining a quantity with units
    • Converting to different units
    • Available units
      • Time
      • Frequency
      • Angles
      • Length
      • Power
      • Flux Density
      • Solid Angle
      • Voltage
      • Current
      • Resistance
      • Temperature
      • Pressure
      • Data Size
      • Mass
    • Common scientific constants
  • Data Acquisition
    • DfMux
      • Bolometer Data
        • SCTP
        • UDP
        • Legacy Boards
        • Data Structures
      • Housekeeping Data
    • Building Timestreams
      • The Wiring Map
      • DfMuxCollator
      • Collecting data to a NetCDF file
    • Core Tools
      • G3EventBuilder
      • G3TriggeredBuilder
    • ledgerman
  • Auto-documentation
    • Getting it documented
    • Viewing the docs
  • Build System
    • CMake Overview
    • Adding a Project
      • Adding Python code
      • Adding a C++ library
      • Adding a C++ executable
      • Adding tests
        • Python Tests
        • C++ Tests
    • Mixing C++ and Python
  • Style Guide
    • Version Control Hygiene
      • Git
      • SVN
    • Coding Style
      • Python Style Guide
      • C++ Style Guide
  • Network Streaming
    • G3NetworkSender
      • Connecting to a Remote Reader
      • Functioning as a Streaming Server
      • Throttling output data
    • Using G3Reader Over the Network
  • Common Problems
    • Setting Values of a FlatSkyMap
    • Error Message Decryption
      • Argument Errors
    • Misbehaving Compilers

Module Documentation

  • calibration
    • API Documentation
      • Frame Objects
        • BolometerProperties
        • BolometerPropertiesMap
        • PointingProperties
        • PointingPropertiesMap
      • Class-like Pipeline Modules
        • SplitByBand
        • SplitByPixelType
        • SplitByProperty
        • SplitByWafer
        • SplitTimestreamsByBand
        • BuildBoloPropertiesMap
        • BuildPointingProperties
        • MergeCalibrationFrames
      • Function-like Pipeline Modules
        • ExplodeBolometerProperties()
      • Useful Classes
        • BolometerCouplingType
      • Useful Functions
        • band_to_string()
        • band_to_value()
        • extract_band_string()
        • extract_band_value()
        • get_band_units()
        • set_band_format()
  • core
    • API Documentation
      • Frame Objects
        • G3Bool
        • G3Double
        • G3FrameObject
        • G3Int
        • G3MapDouble
        • G3MapFrameObject
        • G3MapInt
        • G3MapMapDouble
        • G3MapQuat
        • G3MapString
        • G3MapTime
        • G3MapVectorBool
        • G3MapVectorComplexDouble
        • G3MapVectorDouble
        • G3MapVectorInt
        • G3MapVectorQuat
        • G3MapVectorString
        • G3MapVectorTime
        • G3MapVectorVectorString
        • G3ModuleConfig
        • G3PipelineInfo
        • G3Quat
        • G3String
        • G3Time
        • G3TimesampleMap
        • G3Timestream
        • G3TimestreamMap
        • G3TimestreamQuat
        • G3VectorBool
        • G3VectorComplexDouble
        • G3VectorDouble
        • G3VectorFrameObject
        • G3VectorInt
        • G3VectorQuat
        • G3VectorString
        • G3VectorTime
        • G3VectorUnsignedChar
        • G3VectorVectorString
      • Class-like Pipeline Modules
        • G3EventBuilder
        • G3InfiniteSource
        • G3Module
        • G3MultiFileWriter
        • G3NetworkSender
        • G3Reader
        • G3Writer
        • AbortAfterNFrames
        • DeduplicateMetadata
        • DropOrphanMetadata
        • G3ThrottledNetworkSender
        • InjectFrame
      • Function-like Pipeline Modules
        • Delete()
        • Dump()
        • InjectDebug()
        • Rename()
      • Pipeline Segments
        • G3NetworkReceiver()
      • Useful Classes
        • BoolVector
        • ComplexDoubleVector
        • ComplexFloatVector
        • DoubleVector
        • FloatVector
        • FrameObjectVector
        • FrameTypeVector
        • FrameVector
        • G3Frame
        • G3FrameType
        • G3LogLevel
        • G3Logger
        • G3LoggerVector
        • G3MultiLogger
        • G3NullLogger
        • G3Pipeline
        • G3PrintfLogger
        • G3SyslogLogger
        • G3TimeVector
        • G3TimestreamUnits
        • G3VectorStringVector
        • Int64Vector
        • IntVector
        • ItemsView
        • KeysView
        • ModuleConfigVector
        • Quat
        • QuatVector
        • StringVector
        • UInt64Vector
        • UIntVector
        • UnsignedCharVector
        • ValuesView
        • G3Documenter
        • G3File
      • Useful Functions
        • module_apidoc()
        • log_debug()
        • log_error()
        • log_fatal()
        • log_info()
        • log_notice()
        • log_trace()
        • log_warn()
        • set_log_level()
        • concatenate_timestreams()
      • Decorators
        • cache_frame_data()
        • scan_func_cache_data()
        • indexmod()
        • pipesegment()
        • pipesegment_nodoc()
        • usefulfunc()
  • dfmux
    • API Documentation
      • Frame Objects
        • DfMuxBoardSamples
        • DfMuxChannelMapping
        • DfMuxHousekeepingMap
        • DfMuxMetaSample
        • DfMuxSample
        • DfMuxWiringMap
        • HkBoardInfo
        • HkChannelInfo
        • HkMezzanineInfo
        • HkModuleInfo
      • Class-like Pipeline Modules
        • FillMissingTimepointFrames
        • DfMuxBuilder
        • DfMuxCollator
        • DfmlHardwareMapInjector
        • GenerateFakeHardwareMap
        • PyDfMuxWiringMapInjector
        • HousekeepingConsumer
        • PeriodicHousekeepingCollector
        • LegacyHousekeepingConsumer
        • NetCDFDump
        • FixedLengthScans
        • ConvertTimestreamUnits
      • Function-like Pipeline Modules
        • PyDfMuxBolometerPropertiesInjector()
      • Useful Classes
        • DfMuxCollector
        • HkChannelInfoMap
        • HkMezzanineInfoMap
        • HkModuleInfoMap
        • LegacyDfMuxCollector
      • Useful Functions
        • PathStringForBolo()
        • HousekeepingForBolo()
        • get_timestream_unit_conversion()
  • gcp
    • API Documentation
      • Frame Objects
        • ACUStatus
        • ACUStatusVector
        • TrackerPointing
        • TrackerStatus
      • Class-like Pipeline Modules
        • CalibrateFrame
        • ARCFileReader
        • UnpackSPTpolHKData
        • DAQWatchdog
        • GCPBoloDataTee
        • GCPHousekeepingTee
        • GCPSignalledHousekeeping
        • PagerWatchdog
        • GCPMuxDataDecoder
      • Function-like Pipeline Modules
        • AddBenchData()
        • DecryptFeatureBit()
        • UnpackACUData()
        • UnpackCryoData()
        • UnpackMuxData()
        • UnpackPTData()
        • UnpackTrackerData()
        • UnpackTrackerMinimal()
        • UnpackTrackerPointingData()
        • UnpackWeatherData()
        • UpdateLinearSensorDeltas()
        • WriteDB()
      • Pipeline Segments
        • ARCExtract()
        • ARCExtractMinimal()
        • UpdateDB()
      • Useful Classes
        • ACUState
        • ARCFile
        • CalFileReader
        • Experiment
        • GCPLogger
        • TrackerState
        • TrackerStateVector
      • Useful Functions
        • create_g3_cal_file()
  • maps
    • Map Attributes
    • File Format Conversions
    • Indexing
    • Sparsity
    • Masking
      • Mask Memory Usage
    • Statistics
    • Map Interpolation
    • Map Weights
    • Map Frames and Pipelines
    • Flat Sky Map Projections
    • Flat Sky Map Manipulation
    • Map Pointing
      • Pointing Quaternions
      • Rotation Quaternions
      • Detector Pointing
    • API Documentation
      • Frame Objects
        • FlatSkyMap
        • G3SkyMapMask
        • G3SkyMapWeights
        • HealpixSkyMap
      • Class-like Pipeline Modules
        • HitsBinner
        • MapBinner
        • MapMockObserver
        • MapTODMasker
        • MapTODPointing
        • SingleDetectorBoresightBinner
        • SingleDetectorMapBinner
        • CoaddMaps
        • ExtractMaps
        • InjectMapStub
        • InjectMaps
        • ReprojectMaps
      • Function-like Pipeline Modules
        • EquatorialToGalacticPointing()
        • LocalToAstronomicalPointing()
        • AddLocalTransRotations()
        • EquatorialToGalacticTransRotations()
        • FillCoordTransRotations()
        • SaveMapFrame()
        • ApplyWeights()
        • CompactMaps()
        • FlattenPol()
        • MakeMapsPolarized()
        • MakeMapsUnpolarized()
        • RebinMaps()
        • RemoveWeights()
        • ReplicateMaps()
        • SetPolConv()
        • ValidateMaps()
        • AddTimingToPointingQuats()
      • Useful Classes
        • G3SkyMap
        • MapCoordReference
        • MapPolConv
        • MapPolType
        • MapProjection
      • Useful Functions
        • apply_weights()
        • apply_weights_t()
        • convert_azel_to_radec()
        • convert_gal_to_radec()
        • convert_radec_to_azel()
        • convert_radec_to_gal()
        • convolve_map()
        • load_skymap_fits()
        • load_skymapmask_fits()
        • save_skymap_fits()
        • save_skymapmask_fits()
        • flatten_pol()
        • get_boresight_rotator_timestream()
        • get_detector_pointing()
        • get_detector_pointing_quats()
        • get_fk5_j2000_to_gal_quat()
        • get_galactic_plane_mask()
        • get_map_hist()
        • get_map_moments()
        • get_origin_rotator()
        • get_origin_rotator_timestream()
        • get_ra_dec_map()
        • get_ra_dec_mask()
        • get_rot_ang()
        • get_transform_quat()
        • make_point_source_mask()
        • coadd_map_files()
        • flatsky_to_healpix()
        • healpix_to_flatsky()
        • offsets_to_quat()
        • ang_to_quat()
        • quat_to_ang()
        • remove_weights()
        • remove_weights_t()
        • reproj_map()
  • mpi
    • Frame IO Parallelization
    • Frame Accumulation
    • Interface to TOAST
    • API Documentation
      • Class-like Pipeline Modules
        • MPIAccumulator
        • MPIFileReader
        • MPIFrameParallelizer
      • Pipeline Segments
        • MPIIODistributor()
SPT-3G Software
  • Search

© Copyright 2017-, SPT-3G Collaboration.

Built with Sphinx using a theme provided by Read the Docs.